@prisma-next/errors 0.4.0-dev.4 → 0.4.0-dev.6
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/dist/{control-Dl5V1Wc7.mjs → control-BHDp3kOD.mjs} +7 -3
- package/dist/control-BHDp3kOD.mjs.map +1 -0
- package/dist/{control-DJG12d3Q.d.mts → control-C16uWwh2.d.mts} +3 -3
- package/dist/{control-DJG12d3Q.d.mts.map → control-C16uWwh2.d.mts.map} +1 -1
- package/dist/control.d.mts +1 -1
- package/dist/control.mjs +1 -1
- package/dist/execution.d.mts +1 -1
- package/dist/execution.mjs +1 -1
- package/dist/migration.d.mts +26 -0
- package/dist/migration.d.mts.map +1 -0
- package/dist/migration.mjs +53 -0
- package/dist/migration.mjs.map +1 -0
- package/package.json +6 -5
- package/src/control.ts +5 -4
- package/src/exports/migration.ts +5 -0
- package/src/migration.ts +71 -0
- package/dist/control-Dl5V1Wc7.mjs.map +0 -1
|
@@ -33,7 +33,11 @@ var CliStructuredError = class extends Error {
|
|
|
33
33
|
toEnvelope() {
|
|
34
34
|
return {
|
|
35
35
|
ok: false,
|
|
36
|
-
code: `${
|
|
36
|
+
code: `${{
|
|
37
|
+
CLI: "PN-CLI-",
|
|
38
|
+
RUN: "PN-RUN-",
|
|
39
|
+
MIG: "PN-MIG-"
|
|
40
|
+
}[this.domain]}${this.code}`,
|
|
37
41
|
domain: this.domain,
|
|
38
42
|
severity: this.severity,
|
|
39
43
|
summary: this.message,
|
|
@@ -51,7 +55,7 @@ var CliStructuredError = class extends Error {
|
|
|
51
55
|
static is(error) {
|
|
52
56
|
if (!(error instanceof Error)) return false;
|
|
53
57
|
const candidate = error;
|
|
54
|
-
return candidate.name === "CliStructuredError" && typeof candidate.code === "string" && (candidate.domain === "CLI" || candidate.domain === "RUN") && typeof candidate.toEnvelope === "function";
|
|
58
|
+
return candidate.name === "CliStructuredError" && typeof candidate.code === "string" && (candidate.domain === "CLI" || candidate.domain === "RUN" || candidate.domain === "MIG") && typeof candidate.toEnvelope === "function";
|
|
55
59
|
}
|
|
56
60
|
};
|
|
57
61
|
/**
|
|
@@ -226,4 +230,4 @@ function errorUnexpected(message, options) {
|
|
|
226
230
|
|
|
227
231
|
//#endregion
|
|
228
232
|
export { errorContractMissingExtensionPacks as a, errorDriverRequired as c, errorJsonFormatNotSupported as d, errorMigrationPlanningFailed as f, errorUnexpected as h, errorContractConfigMissing as i, errorFamilyReadMarkerSqlRequired as l, errorTargetMigrationNotSupported as m, errorConfigFileNotFound as n, errorContractValidationFailed as o, errorQueryRunnerFactoryRequired as p, errorConfigValidation as r, errorDatabaseConnectionRequired as s, CliStructuredError as t, errorFileNotFound as u };
|
|
229
|
-
//# sourceMappingURL=control-
|
|
233
|
+
//# sourceMappingURL=control-BHDp3kOD.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"control-BHDp3kOD.mjs","names":[],"sources":["../src/control.ts"],"sourcesContent":["/**\n * CLI error envelope for output formatting.\n * This is the serialized form of a CliStructuredError.\n */\nexport interface CliErrorEnvelope {\n readonly ok: false;\n readonly code: string;\n readonly domain: string;\n readonly severity: 'error' | 'warn' | 'info';\n readonly summary: string;\n readonly why: string | undefined;\n readonly fix: string | undefined;\n readonly where:\n | {\n readonly path: string | undefined;\n readonly line: number | undefined;\n }\n | undefined;\n readonly meta: Record<string, unknown> | undefined;\n readonly docsUrl: string | undefined;\n}\n\n/**\n * Minimal conflict data structure expected by CLI output.\n */\nexport interface CliErrorConflict {\n readonly kind: string;\n readonly summary: string;\n readonly why?: string;\n}\n\n/**\n * Structured CLI error that contains all information needed for error envelopes.\n * Call sites throw these errors with full context.\n */\nexport class CliStructuredError extends Error {\n readonly code: string;\n readonly domain: 'CLI' | 'RUN' | 'MIG';\n readonly severity: 'error' | 'warn' | 'info';\n readonly why: string | undefined;\n readonly fix: string | undefined;\n readonly where:\n | {\n readonly path: string | undefined;\n readonly line: number | undefined;\n }\n | undefined;\n readonly meta: Record<string, unknown> | undefined;\n readonly docsUrl: string | undefined;\n\n constructor(\n code: string,\n summary: string,\n options?: {\n readonly domain?: 'CLI' | 'RUN' | 'MIG';\n readonly severity?: 'error' | 'warn' | 'info';\n readonly why?: string;\n readonly fix?: string;\n readonly where?: { readonly path?: string; readonly line?: number };\n readonly meta?: Record<string, unknown>;\n readonly docsUrl?: string;\n },\n ) {\n super(summary);\n this.name = 'CliStructuredError';\n this.code = code;\n this.domain = options?.domain ?? 'CLI';\n this.severity = options?.severity ?? 'error';\n this.why = options?.why;\n this.fix = options?.fix === options?.why ? undefined : options?.fix;\n this.where = options?.where\n ? {\n path: options.where.path,\n line: options.where.line,\n }\n : undefined;\n this.meta = options?.meta;\n this.docsUrl = options?.docsUrl;\n }\n\n /**\n * Converts this error to a CLI error envelope for output formatting.\n */\n toEnvelope(): CliErrorEnvelope {\n const domainPrefixes = { CLI: 'PN-CLI-', RUN: 'PN-RUN-', MIG: 'PN-MIG-' } as const;\n const codePrefix = domainPrefixes[this.domain];\n return {\n ok: false as const,\n code: `${codePrefix}${this.code}`,\n domain: this.domain,\n severity: this.severity,\n summary: this.message,\n why: this.why,\n fix: this.fix,\n where: this.where,\n meta: this.meta,\n docsUrl: this.docsUrl,\n };\n }\n\n /**\n * Type guard to check if an error is a CliStructuredError.\n * Uses duck-typing to work across module boundaries where instanceof may fail.\n */\n static is(error: unknown): error is CliStructuredError {\n if (!(error instanceof Error)) {\n return false;\n }\n const candidate = error as CliStructuredError;\n return (\n candidate.name === 'CliStructuredError' &&\n typeof candidate.code === 'string' &&\n (candidate.domain === 'CLI' || candidate.domain === 'RUN' || candidate.domain === 'MIG') &&\n typeof candidate.toEnvelope === 'function'\n );\n }\n}\n\n// ============================================================================\n// Config Errors (PN-CLI-4001-4007)\n// ============================================================================\n\n/**\n * Config file not found or missing.\n */\nexport function errorConfigFileNotFound(\n configPath?: string,\n options?: {\n readonly why?: string;\n },\n): CliStructuredError {\n return new CliStructuredError('4001', 'Config file not found', {\n domain: 'CLI',\n ...(options?.why ? { why: options.why } : { why: 'Config file not found' }),\n fix: \"Run 'prisma-next init' to create a config file\",\n docsUrl: 'https://prisma-next.dev/docs/cli/config',\n ...(configPath ? { where: { path: configPath } } : {}),\n });\n}\n\n/**\n * Contract configuration missing from config.\n */\nexport function errorContractConfigMissing(options?: {\n readonly why?: string;\n}): CliStructuredError {\n return new CliStructuredError('4002', 'Contract configuration missing', {\n domain: 'CLI',\n why: options?.why ?? 'The contract configuration is required for emit',\n fix: 'Add contract configuration to your prisma-next.config.ts',\n docsUrl: 'https://prisma-next.dev/docs/cli/contract-emit',\n });\n}\n\n/**\n * Contract validation failed.\n */\nexport function errorContractValidationFailed(\n reason: string,\n options?: {\n readonly where?: { readonly path?: string; readonly line?: number };\n },\n): CliStructuredError {\n return new CliStructuredError('4003', 'Contract validation failed', {\n domain: 'CLI',\n why: reason,\n fix: 'Re-run `prisma-next contract emit`, or fix the contract file and try again',\n docsUrl: 'https://prisma-next.dev/docs/contracts',\n ...(options?.where ? { where: options.where } : {}),\n });\n}\n\n/**\n * File not found.\n */\nexport function errorFileNotFound(\n filePath: string,\n options?: {\n readonly why?: string;\n readonly fix?: string;\n readonly docsUrl?: string;\n },\n): CliStructuredError {\n return new CliStructuredError('4004', 'File not found', {\n domain: 'CLI',\n why: options?.why ?? `File not found: ${filePath}`,\n fix: options?.fix ?? 'Check that the file path is correct',\n where: { path: filePath },\n ...(options?.docsUrl ? { docsUrl: options.docsUrl } : {}),\n });\n}\n\n/**\n * Database connection is required but not provided.\n */\nexport function errorDatabaseConnectionRequired(options?: {\n readonly why?: string;\n readonly commandName?: string;\n readonly retryCommand?: string;\n}): CliStructuredError {\n const runHint = options?.retryCommand\n ? `Run \\`${options.retryCommand}\\``\n : options?.commandName\n ? `Run \\`prisma-next ${options.commandName} --db <url>\\``\n : 'Provide `--db <url>`';\n return new CliStructuredError('4005', 'Database connection is required', {\n domain: 'CLI',\n why: options?.why ?? 'Database connection is required for this command',\n fix: `${runHint}, or set \\`db: { connection: \"postgres://…\" }\\` in prisma-next.config.ts`,\n });\n}\n\n/**\n * Query runner factory is required but not provided in config.\n */\nexport function errorQueryRunnerFactoryRequired(options?: {\n readonly why?: string;\n}): CliStructuredError {\n return new CliStructuredError('4006', 'Query runner factory is required', {\n domain: 'CLI',\n why: options?.why ?? 'Config.db.queryRunnerFactory is required for db verify',\n fix: 'Add db.queryRunnerFactory to prisma-next.config.ts',\n docsUrl: 'https://prisma-next.dev/docs/cli/db-verify',\n });\n}\n\n/**\n * Family verify.readMarker is required but not provided.\n */\nexport function errorFamilyReadMarkerSqlRequired(options?: {\n readonly why?: string;\n}): CliStructuredError {\n return new CliStructuredError('4007', 'Family readMarker() is required', {\n domain: 'CLI',\n why: options?.why ?? 'Family verify.readMarker is required for db verify',\n fix: 'Ensure family.verify.readMarker() is exported by your family package',\n docsUrl: 'https://prisma-next.dev/docs/cli/db-verify',\n });\n}\n\n/**\n * JSON output format not supported.\n */\nexport function errorJsonFormatNotSupported(options: {\n readonly command: string;\n readonly format: string;\n readonly supportedFormats: readonly string[];\n}): CliStructuredError {\n return new CliStructuredError('4008', 'Unsupported JSON format', {\n domain: 'CLI',\n why: `The ${options.command} command does not support --json ${options.format}`,\n fix: `Use --json ${options.supportedFormats.join(' or ')}, or omit --json for human output`,\n meta: {\n command: options.command,\n format: options.format,\n supportedFormats: options.supportedFormats,\n },\n });\n}\n\n/**\n * Driver is required for DB-connected commands but not provided.\n */\nexport function errorDriverRequired(options?: { readonly why?: string }): CliStructuredError {\n return new CliStructuredError('4010', 'Driver is required for DB-connected commands', {\n domain: 'CLI',\n why: options?.why ?? 'Config.driver is required for DB-connected commands',\n fix: 'Add a control-plane driver to prisma-next.config.ts (e.g. import a driver descriptor and set `driver: postgresDriver`)',\n docsUrl: 'https://prisma-next.dev/docs/cli/config',\n });\n}\n\n/**\n * Contract requires extension packs that are not provided by config descriptors.\n */\nexport function errorContractMissingExtensionPacks(options: {\n readonly missingExtensionPacks: readonly string[];\n readonly providedComponentIds: readonly string[];\n}): CliStructuredError {\n const missing = [...options.missingExtensionPacks].sort();\n return new CliStructuredError('4011', 'Missing extension packs in config', {\n domain: 'CLI',\n why:\n missing.length === 1\n ? `Contract requires extension pack '${missing[0]}', but CLI config does not provide a matching descriptor.`\n : `Contract requires extension packs ${missing.map((p) => `'${p}'`).join(', ')}, but CLI config does not provide matching descriptors.`,\n fix: 'Add the missing extension descriptors to `extensions` in prisma-next.config.ts',\n docsUrl: 'https://prisma-next.dev/docs/cli/config',\n meta: {\n missingExtensionPacks: missing,\n providedComponentIds: [...options.providedComponentIds].sort(),\n },\n });\n}\n\n/**\n * Migration planning failed due to conflicts.\n */\nexport function errorMigrationPlanningFailed(options: {\n readonly conflicts: readonly CliErrorConflict[];\n readonly why?: string;\n}): CliStructuredError {\n const conflictSummaries = options.conflicts.map((c) => c.summary);\n const computedWhy = options.why ?? conflictSummaries.join('\\n');\n\n const conflictFixes = options.conflicts\n .map((c) => c.why)\n .filter((why): why is string => typeof why === 'string');\n const computedFix =\n conflictFixes.length > 0\n ? conflictFixes.join('\\n')\n : 'Use `db verify --schema-only` to inspect conflicts, or ensure the database is empty';\n\n return new CliStructuredError('4020', 'Migration planning failed', {\n domain: 'CLI',\n why: computedWhy,\n fix: computedFix,\n meta: { conflicts: options.conflicts },\n docsUrl: 'https://prisma-next.dev/docs/cli/db-init',\n });\n}\n\n/**\n * Target does not support migrations (missing createPlanner/createRunner).\n */\nexport function errorTargetMigrationNotSupported(options?: {\n readonly why?: string;\n}): CliStructuredError {\n return new CliStructuredError('4021', 'Target does not support migrations', {\n domain: 'CLI',\n why: options?.why ?? 'The configured target does not provide migration planner/runner',\n fix: 'Select a target that provides migrations (it must export `target.migrations` for db init)',\n docsUrl: 'https://prisma-next.dev/docs/cli/db-init',\n });\n}\n\n/**\n * Config validation error (missing required fields).\n */\nexport function errorConfigValidation(\n field: string,\n options?: {\n readonly why?: string;\n },\n): CliStructuredError {\n return new CliStructuredError('4009', 'Config validation error', {\n domain: 'CLI',\n why: options?.why ?? `Config must have a \"${field}\" field`,\n fix: 'Check your prisma-next.config.ts and ensure all required fields are provided',\n docsUrl: 'https://prisma-next.dev/docs/cli/config',\n });\n}\n\n// ============================================================================\n// Generic Error\n// ============================================================================\n\n/**\n * Generic unexpected error.\n */\nexport function errorUnexpected(\n message: string,\n options?: {\n readonly why?: string;\n readonly fix?: string;\n },\n): CliStructuredError {\n return new CliStructuredError('4999', 'Unexpected error', {\n domain: 'CLI',\n why: options?.why ?? message,\n fix: options?.fix ?? 'Check the error message and try again',\n });\n}\n"],"mappings":";;;;;AAmCA,IAAa,qBAAb,cAAwC,MAAM;CAC5C,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CAMT,AAAS;CACT,AAAS;CAET,YACE,MACA,SACA,SASA;AACA,QAAM,QAAQ;AACd,OAAK,OAAO;AACZ,OAAK,OAAO;AACZ,OAAK,SAAS,SAAS,UAAU;AACjC,OAAK,WAAW,SAAS,YAAY;AACrC,OAAK,MAAM,SAAS;AACpB,OAAK,MAAM,SAAS,QAAQ,SAAS,MAAM,SAAY,SAAS;AAChE,OAAK,QAAQ,SAAS,QAClB;GACE,MAAM,QAAQ,MAAM;GACpB,MAAM,QAAQ,MAAM;GACrB,GACD;AACJ,OAAK,OAAO,SAAS;AACrB,OAAK,UAAU,SAAS;;;;;CAM1B,aAA+B;AAG7B,SAAO;GACL,IAAI;GACJ,MAAM,GAJe;IAAE,KAAK;IAAW,KAAK;IAAW,KAAK;IAAW,CACvC,KAAK,UAGf,KAAK;GAC3B,QAAQ,KAAK;GACb,UAAU,KAAK;GACf,SAAS,KAAK;GACd,KAAK,KAAK;GACV,KAAK,KAAK;GACV,OAAO,KAAK;GACZ,MAAM,KAAK;GACX,SAAS,KAAK;GACf;;;;;;CAOH,OAAO,GAAG,OAA6C;AACrD,MAAI,EAAE,iBAAiB,OACrB,QAAO;EAET,MAAM,YAAY;AAClB,SACE,UAAU,SAAS,wBACnB,OAAO,UAAU,SAAS,aACzB,UAAU,WAAW,SAAS,UAAU,WAAW,SAAS,UAAU,WAAW,UAClF,OAAO,UAAU,eAAe;;;;;;AAYtC,SAAgB,wBACd,YACA,SAGoB;AACpB,QAAO,IAAI,mBAAmB,QAAQ,yBAAyB;EAC7D,QAAQ;EACR,GAAI,SAAS,MAAM,EAAE,KAAK,QAAQ,KAAK,GAAG,EAAE,KAAK,yBAAyB;EAC1E,KAAK;EACL,SAAS;EACT,GAAI,aAAa,EAAE,OAAO,EAAE,MAAM,YAAY,EAAE,GAAG,EAAE;EACtD,CAAC;;;;;AAMJ,SAAgB,2BAA2B,SAEpB;AACrB,QAAO,IAAI,mBAAmB,QAAQ,kCAAkC;EACtE,QAAQ;EACR,KAAK,SAAS,OAAO;EACrB,KAAK;EACL,SAAS;EACV,CAAC;;;;;AAMJ,SAAgB,8BACd,QACA,SAGoB;AACpB,QAAO,IAAI,mBAAmB,QAAQ,8BAA8B;EAClE,QAAQ;EACR,KAAK;EACL,KAAK;EACL,SAAS;EACT,GAAI,SAAS,QAAQ,EAAE,OAAO,QAAQ,OAAO,GAAG,EAAE;EACnD,CAAC;;;;;AAMJ,SAAgB,kBACd,UACA,SAKoB;AACpB,QAAO,IAAI,mBAAmB,QAAQ,kBAAkB;EACtD,QAAQ;EACR,KAAK,SAAS,OAAO,mBAAmB;EACxC,KAAK,SAAS,OAAO;EACrB,OAAO,EAAE,MAAM,UAAU;EACzB,GAAI,SAAS,UAAU,EAAE,SAAS,QAAQ,SAAS,GAAG,EAAE;EACzD,CAAC;;;;;AAMJ,SAAgB,gCAAgC,SAIzB;CACrB,MAAM,UAAU,SAAS,eACrB,SAAS,QAAQ,aAAa,MAC9B,SAAS,cACP,qBAAqB,QAAQ,YAAY,iBACzC;AACN,QAAO,IAAI,mBAAmB,QAAQ,mCAAmC;EACvE,QAAQ;EACR,KAAK,SAAS,OAAO;EACrB,KAAK,GAAG,QAAQ;EACjB,CAAC;;;;;AAMJ,SAAgB,gCAAgC,SAEzB;AACrB,QAAO,IAAI,mBAAmB,QAAQ,oCAAoC;EACxE,QAAQ;EACR,KAAK,SAAS,OAAO;EACrB,KAAK;EACL,SAAS;EACV,CAAC;;;;;AAMJ,SAAgB,iCAAiC,SAE1B;AACrB,QAAO,IAAI,mBAAmB,QAAQ,mCAAmC;EACvE,QAAQ;EACR,KAAK,SAAS,OAAO;EACrB,KAAK;EACL,SAAS;EACV,CAAC;;;;;AAMJ,SAAgB,4BAA4B,SAIrB;AACrB,QAAO,IAAI,mBAAmB,QAAQ,2BAA2B;EAC/D,QAAQ;EACR,KAAK,OAAO,QAAQ,QAAQ,mCAAmC,QAAQ;EACvE,KAAK,cAAc,QAAQ,iBAAiB,KAAK,OAAO,CAAC;EACzD,MAAM;GACJ,SAAS,QAAQ;GACjB,QAAQ,QAAQ;GAChB,kBAAkB,QAAQ;GAC3B;EACF,CAAC;;;;;AAMJ,SAAgB,oBAAoB,SAAyD;AAC3F,QAAO,IAAI,mBAAmB,QAAQ,gDAAgD;EACpF,QAAQ;EACR,KAAK,SAAS,OAAO;EACrB,KAAK;EACL,SAAS;EACV,CAAC;;;;;AAMJ,SAAgB,mCAAmC,SAG5B;CACrB,MAAM,UAAU,CAAC,GAAG,QAAQ,sBAAsB,CAAC,MAAM;AACzD,QAAO,IAAI,mBAAmB,QAAQ,qCAAqC;EACzE,QAAQ;EACR,KACE,QAAQ,WAAW,IACf,qCAAqC,QAAQ,GAAG,6DAChD,qCAAqC,QAAQ,KAAK,MAAM,IAAI,EAAE,GAAG,CAAC,KAAK,KAAK,CAAC;EACnF,KAAK;EACL,SAAS;EACT,MAAM;GACJ,uBAAuB;GACvB,sBAAsB,CAAC,GAAG,QAAQ,qBAAqB,CAAC,MAAM;GAC/D;EACF,CAAC;;;;;AAMJ,SAAgB,6BAA6B,SAGtB;CACrB,MAAM,oBAAoB,QAAQ,UAAU,KAAK,MAAM,EAAE,QAAQ;CACjE,MAAM,cAAc,QAAQ,OAAO,kBAAkB,KAAK,KAAK;CAE/D,MAAM,gBAAgB,QAAQ,UAC3B,KAAK,MAAM,EAAE,IAAI,CACjB,QAAQ,QAAuB,OAAO,QAAQ,SAAS;AAM1D,QAAO,IAAI,mBAAmB,QAAQ,6BAA6B;EACjE,QAAQ;EACR,KAAK;EACL,KAPA,cAAc,SAAS,IACnB,cAAc,KAAK,KAAK,GACxB;EAMJ,MAAM,EAAE,WAAW,QAAQ,WAAW;EACtC,SAAS;EACV,CAAC;;;;;AAMJ,SAAgB,iCAAiC,SAE1B;AACrB,QAAO,IAAI,mBAAmB,QAAQ,sCAAsC;EAC1E,QAAQ;EACR,KAAK,SAAS,OAAO;EACrB,KAAK;EACL,SAAS;EACV,CAAC;;;;;AAMJ,SAAgB,sBACd,OACA,SAGoB;AACpB,QAAO,IAAI,mBAAmB,QAAQ,2BAA2B;EAC/D,QAAQ;EACR,KAAK,SAAS,OAAO,uBAAuB,MAAM;EAClD,KAAK;EACL,SAAS;EACV,CAAC;;;;;AAUJ,SAAgB,gBACd,SACA,SAIoB;AACpB,QAAO,IAAI,mBAAmB,QAAQ,oBAAoB;EACxD,QAAQ;EACR,KAAK,SAAS,OAAO;EACrB,KAAK,SAAS,OAAO;EACtB,CAAC"}
|
|
@@ -32,7 +32,7 @@ interface CliErrorConflict {
|
|
|
32
32
|
*/
|
|
33
33
|
declare class CliStructuredError extends Error {
|
|
34
34
|
readonly code: string;
|
|
35
|
-
readonly domain: 'CLI' | 'RUN';
|
|
35
|
+
readonly domain: 'CLI' | 'RUN' | 'MIG';
|
|
36
36
|
readonly severity: 'error' | 'warn' | 'info';
|
|
37
37
|
readonly why: string | undefined;
|
|
38
38
|
readonly fix: string | undefined;
|
|
@@ -43,7 +43,7 @@ declare class CliStructuredError extends Error {
|
|
|
43
43
|
readonly meta: Record<string, unknown> | undefined;
|
|
44
44
|
readonly docsUrl: string | undefined;
|
|
45
45
|
constructor(code: string, summary: string, options?: {
|
|
46
|
-
readonly domain?: 'CLI' | 'RUN';
|
|
46
|
+
readonly domain?: 'CLI' | 'RUN' | 'MIG';
|
|
47
47
|
readonly severity?: 'error' | 'warn' | 'info';
|
|
48
48
|
readonly why?: string;
|
|
49
49
|
readonly fix?: string;
|
|
@@ -162,4 +162,4 @@ declare function errorUnexpected(message: string, options?: {
|
|
|
162
162
|
}): CliStructuredError;
|
|
163
163
|
//#endregion
|
|
164
164
|
export { errorUnexpected as _, errorConfigValidation as a, errorContractValidationFailed as c, errorFamilyReadMarkerSqlRequired as d, errorFileNotFound as f, errorTargetMigrationNotSupported as g, errorQueryRunnerFactoryRequired as h, errorConfigFileNotFound as i, errorDatabaseConnectionRequired as l, errorMigrationPlanningFailed as m, CliErrorEnvelope as n, errorContractConfigMissing as o, errorJsonFormatNotSupported as p, CliStructuredError as r, errorContractMissingExtensionPacks as s, CliErrorConflict as t, errorDriverRequired as u };
|
|
165
|
-
//# sourceMappingURL=control-
|
|
165
|
+
//# sourceMappingURL=control-C16uWwh2.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"control-
|
|
1
|
+
{"version":3,"file":"control-C16uWwh2.d.mts","names":[],"sources":["../src/control.ts"],"sourcesContent":[],"mappings":";;AAIA;AAqBA;AAUA;AAYiB,UA3CA,gBAAA,CA2CA;EAYK,SAAA,EAAA,EAAA,KAAA;EAwBN,SAAA,IAAA,EAAA,MAAA;EAqBsB,SAAA,MAAA,EAAA,MAAA;EArEE,SAAA,QAAA,EAAA,OAAA,GAAA,MAAA,GAAA,MAAA;EAAK,SAAA,OAAA,EAAA,MAAA;EA0F7B,SAAA,GAAA,EAAA,MAAA,GAAA,SAAuB;EAkBvB,SAAA,GAAA,EAAA,MAAA,GAAA,SAA0B;EAc1B,SAAA,KAAA,EAAA;IAkBA,SAAA,IAAA,EAAA,MAAiB,GAAA,SAO9B;IAaa,SAAA,IAAA,EAAA,MAAA,GAAA,SAA+B;EAoB/B,CAAA,GAAA,SAAA;EAcA,SAAA,IAAA,EAnNC,MAmND,CAAA,MAAA,EAAA,OAAgC,CAAA,GAAA,SAE5C;EAYY,SAAA,OAAA,EAAA,MAAA,GAAA,SAA2B;AAoB3C;AAYA;AAuBA;AA2BA;AAcgB,UA1TC,gBAAA,CA0ToB;EAqBrB,SAAA,IAAA,EAAA,MAAe;;;;;;;;cArUlB,kBAAA,SAA2B,KAAA;;;;;;;;;;iBAYvB;;;;;;;;;;;oBAYK;;;;;;gBAwBN;;;;;sCAqBsB;;;;;iBAqBtB,uBAAA;;IAKb;;;;iBAaa,0BAAA;;IAEZ;;;;iBAYY,6BAAA;;;;;IAKb;;;;iBAaa,iBAAA;;;;IAOb;;;;iBAaa,+BAAA;;;;IAIZ;;;;iBAgBY,+BAAA;;IAEZ;;;;iBAYY,gCAAA;;IAEZ;;;;iBAYY,2BAAA;;;;IAIZ;;;;iBAgBY,mBAAA;;IAA0D;;;;iBAY1D,kCAAA;;;IAGZ;;;;iBAoBY,4BAAA;+BACe;;IAE3B;;;;iBAwBY,gCAAA;;IAEZ;;;;iBAYY,qBAAA;;IAKb;;;;iBAgBa,eAAA;;;IAMb"}
|
package/dist/control.d.mts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { _ as errorUnexpected, a as errorConfigValidation, c as errorContractValidationFailed, d as errorFamilyReadMarkerSqlRequired, f as errorFileNotFound, g as errorTargetMigrationNotSupported, h as errorQueryRunnerFactoryRequired, i as errorConfigFileNotFound, l as errorDatabaseConnectionRequired, m as errorMigrationPlanningFailed, n as CliErrorEnvelope, o as errorContractConfigMissing, p as errorJsonFormatNotSupported, r as CliStructuredError, s as errorContractMissingExtensionPacks, t as CliErrorConflict, u as errorDriverRequired } from "./control-
|
|
1
|
+
import { _ as errorUnexpected, a as errorConfigValidation, c as errorContractValidationFailed, d as errorFamilyReadMarkerSqlRequired, f as errorFileNotFound, g as errorTargetMigrationNotSupported, h as errorQueryRunnerFactoryRequired, i as errorConfigFileNotFound, l as errorDatabaseConnectionRequired, m as errorMigrationPlanningFailed, n as CliErrorEnvelope, o as errorContractConfigMissing, p as errorJsonFormatNotSupported, r as CliStructuredError, s as errorContractMissingExtensionPacks, t as CliErrorConflict, u as errorDriverRequired } from "./control-C16uWwh2.mjs";
|
|
2
2
|
export { type CliErrorConflict, type CliErrorEnvelope, CliStructuredError, errorConfigFileNotFound, errorConfigValidation, errorContractConfigMissing, errorContractMissingExtensionPacks, errorContractValidationFailed, errorDatabaseConnectionRequired, errorDriverRequired, errorFamilyReadMarkerSqlRequired, errorFileNotFound, errorJsonFormatNotSupported, errorMigrationPlanningFailed, errorQueryRunnerFactoryRequired, errorTargetMigrationNotSupported, errorUnexpected };
|
package/dist/control.mjs
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
import { a as errorContractMissingExtensionPacks, c as errorDriverRequired, d as errorJsonFormatNotSupported, f as errorMigrationPlanningFailed, h as errorUnexpected, i as errorContractConfigMissing, l as errorFamilyReadMarkerSqlRequired, m as errorTargetMigrationNotSupported, n as errorConfigFileNotFound, o as errorContractValidationFailed, p as errorQueryRunnerFactoryRequired, r as errorConfigValidation, s as errorDatabaseConnectionRequired, t as CliStructuredError, u as errorFileNotFound } from "./control-
|
|
1
|
+
import { a as errorContractMissingExtensionPacks, c as errorDriverRequired, d as errorJsonFormatNotSupported, f as errorMigrationPlanningFailed, h as errorUnexpected, i as errorContractConfigMissing, l as errorFamilyReadMarkerSqlRequired, m as errorTargetMigrationNotSupported, n as errorConfigFileNotFound, o as errorContractValidationFailed, p as errorQueryRunnerFactoryRequired, r as errorConfigValidation, s as errorDatabaseConnectionRequired, t as CliStructuredError, u as errorFileNotFound } from "./control-BHDp3kOD.mjs";
|
|
2
2
|
|
|
3
3
|
export { CliStructuredError, errorConfigFileNotFound, errorConfigValidation, errorContractConfigMissing, errorContractMissingExtensionPacks, errorContractValidationFailed, errorDatabaseConnectionRequired, errorDriverRequired, errorFamilyReadMarkerSqlRequired, errorFileNotFound, errorJsonFormatNotSupported, errorMigrationPlanningFailed, errorQueryRunnerFactoryRequired, errorTargetMigrationNotSupported, errorUnexpected };
|
package/dist/execution.d.mts
CHANGED
package/dist/execution.mjs
CHANGED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { r as CliStructuredError } from "./control-C16uWwh2.mjs";
|
|
2
|
+
|
|
3
|
+
//#region src/migration.d.ts
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* `migration.ts` was expected at the given package directory but could not be
|
|
7
|
+
* located. Thrown by `emitMigration` (and, as a belt-and-suspenders, by
|
|
8
|
+
* class-flow `emit` capabilities) when the file is missing.
|
|
9
|
+
*/
|
|
10
|
+
declare function errorMigrationFileMissing(dir: string): CliStructuredError;
|
|
11
|
+
/**
|
|
12
|
+
* The `migration.ts` at the given package directory does not default-export a
|
|
13
|
+
* valid migration shape. Two shapes are accepted: a `Migration` subclass, or a
|
|
14
|
+
* factory function returning an object with a `plan()` method. Thrown when the
|
|
15
|
+
* default export is missing, is not a constructor/function, does not extend
|
|
16
|
+
* `Migration`, or (for factory functions) returns a value without `plan()`.
|
|
17
|
+
*/
|
|
18
|
+
declare function errorMigrationInvalidDefaultExport(dir: string, actualExportDescription?: string): CliStructuredError;
|
|
19
|
+
/**
|
|
20
|
+
* A class-flow `Migration.plan()` returned a value that is not an array. Used
|
|
21
|
+
* by class-flow emit capabilities after instantiating the authored migration.
|
|
22
|
+
*/
|
|
23
|
+
declare function errorMigrationPlanNotArray(dir: string, actualValueDescription?: string): CliStructuredError;
|
|
24
|
+
//#endregion
|
|
25
|
+
export { errorMigrationFileMissing, errorMigrationInvalidDefaultExport, errorMigrationPlanNotArray };
|
|
26
|
+
//# sourceMappingURL=migration.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"migration.d.mts","names":[],"sources":["../src/migration.ts"],"sourcesContent":[],"mappings":";;;;;;AAgBA;AAgBA;AAsBA;iBAtCgB,yBAAA,eAAwC;;;;;;;;iBAgBxC,kCAAA,iDAGb;;;;;iBAmBa,0BAAA,gDAGb"}
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
import { t as CliStructuredError } from "./control-BHDp3kOD.mjs";
|
|
2
|
+
|
|
3
|
+
//#region src/migration.ts
|
|
4
|
+
/**
|
|
5
|
+
* `migration.ts` was expected at the given package directory but could not be
|
|
6
|
+
* located. Thrown by `emitMigration` (and, as a belt-and-suspenders, by
|
|
7
|
+
* class-flow `emit` capabilities) when the file is missing.
|
|
8
|
+
*/
|
|
9
|
+
function errorMigrationFileMissing(dir) {
|
|
10
|
+
return new CliStructuredError("2002", "migration.ts not found", {
|
|
11
|
+
domain: "MIG",
|
|
12
|
+
why: `No migration.ts file was found at "${dir}"`,
|
|
13
|
+
fix: "Scaffold one with `prisma-next migration new` or `prisma-next migration plan`.",
|
|
14
|
+
meta: { dir }
|
|
15
|
+
});
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* The `migration.ts` at the given package directory does not default-export a
|
|
19
|
+
* valid migration shape. Two shapes are accepted: a `Migration` subclass, or a
|
|
20
|
+
* factory function returning an object with a `plan()` method. Thrown when the
|
|
21
|
+
* default export is missing, is not a constructor/function, does not extend
|
|
22
|
+
* `Migration`, or (for factory functions) returns a value without `plan()`.
|
|
23
|
+
*/
|
|
24
|
+
function errorMigrationInvalidDefaultExport(dir, actualExportDescription) {
|
|
25
|
+
return new CliStructuredError("2003", "migration.ts default export is not a valid migration", {
|
|
26
|
+
domain: "MIG",
|
|
27
|
+
why: actualExportDescription !== void 0 ? `migration.ts at "${dir}" must default-export a Migration subclass or a factory function returning { plan() }; got ${actualExportDescription}` : `migration.ts at "${dir}" must default-export a Migration subclass or a factory function returning { plan() }.`,
|
|
28
|
+
fix: "Use `export default class extends Migration { ... }` or `export default () => ({ plan() { return [...] } })`.",
|
|
29
|
+
meta: {
|
|
30
|
+
dir,
|
|
31
|
+
...actualExportDescription !== void 0 ? { actualExport: actualExportDescription } : {}
|
|
32
|
+
}
|
|
33
|
+
});
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* A class-flow `Migration.plan()` returned a value that is not an array. Used
|
|
37
|
+
* by class-flow emit capabilities after instantiating the authored migration.
|
|
38
|
+
*/
|
|
39
|
+
function errorMigrationPlanNotArray(dir, actualValueDescription) {
|
|
40
|
+
return new CliStructuredError("2004", "Migration.plan() must return an array of operations", {
|
|
41
|
+
domain: "MIG",
|
|
42
|
+
why: actualValueDescription !== void 0 ? `Migration.plan() for migration.ts at "${dir}" returned ${actualValueDescription}; an array of operations is required.` : `Migration.plan() for migration.ts at "${dir}" did not return an array of operations.`,
|
|
43
|
+
fix: "Ensure your `plan()` method returns an array of operations; see the data-migrations authoring guide.",
|
|
44
|
+
meta: {
|
|
45
|
+
dir,
|
|
46
|
+
...actualValueDescription !== void 0 ? { actualValue: actualValueDescription } : {}
|
|
47
|
+
}
|
|
48
|
+
});
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
//#endregion
|
|
52
|
+
export { errorMigrationFileMissing, errorMigrationInvalidDefaultExport, errorMigrationPlanNotArray };
|
|
53
|
+
//# sourceMappingURL=migration.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"migration.mjs","names":[],"sources":["../src/migration.ts"],"sourcesContent":["import { CliStructuredError } from './control';\n\n// ============================================================================\n// Migration Errors (PN-MIG-2000-2999)\n//\n// Errors raised by the migration subsystem (authoring, planning, emit).\n// Domain `MIG` distinguishes these from generic application runtime errors\n// (`RUN`) and from CLI argument/config errors (`CLI`). See\n// `docs/CLI Style Guide.md` for the canonical domain taxonomy.\n// ============================================================================\n\n/**\n * `migration.ts` was expected at the given package directory but could not be\n * located. Thrown by `emitMigration` (and, as a belt-and-suspenders, by\n * class-flow `emit` capabilities) when the file is missing.\n */\nexport function errorMigrationFileMissing(dir: string): CliStructuredError {\n return new CliStructuredError('2002', 'migration.ts not found', {\n domain: 'MIG',\n why: `No migration.ts file was found at \"${dir}\"`,\n fix: 'Scaffold one with `prisma-next migration new` or `prisma-next migration plan`.',\n meta: { dir },\n });\n}\n\n/**\n * The `migration.ts` at the given package directory does not default-export a\n * valid migration shape. Two shapes are accepted: a `Migration` subclass, or a\n * factory function returning an object with a `plan()` method. Thrown when the\n * default export is missing, is not a constructor/function, does not extend\n * `Migration`, or (for factory functions) returns a value without `plan()`.\n */\nexport function errorMigrationInvalidDefaultExport(\n dir: string,\n actualExportDescription?: string,\n): CliStructuredError {\n return new CliStructuredError('2003', 'migration.ts default export is not a valid migration', {\n domain: 'MIG',\n why:\n actualExportDescription !== undefined\n ? `migration.ts at \"${dir}\" must default-export a Migration subclass or a factory function returning { plan() }; got ${actualExportDescription}`\n : `migration.ts at \"${dir}\" must default-export a Migration subclass or a factory function returning { plan() }.`,\n fix: 'Use `export default class extends Migration { ... }` or `export default () => ({ plan() { return [...] } })`.',\n meta: {\n dir,\n ...(actualExportDescription !== undefined ? { actualExport: actualExportDescription } : {}),\n },\n });\n}\n\n/**\n * A class-flow `Migration.plan()` returned a value that is not an array. Used\n * by class-flow emit capabilities after instantiating the authored migration.\n */\nexport function errorMigrationPlanNotArray(\n dir: string,\n actualValueDescription?: string,\n): CliStructuredError {\n return new CliStructuredError('2004', 'Migration.plan() must return an array of operations', {\n domain: 'MIG',\n why:\n actualValueDescription !== undefined\n ? `Migration.plan() for migration.ts at \"${dir}\" returned ${actualValueDescription}; an array of operations is required.`\n : `Migration.plan() for migration.ts at \"${dir}\" did not return an array of operations.`,\n fix: 'Ensure your `plan()` method returns an array of operations; see the data-migrations authoring guide.',\n meta: {\n dir,\n ...(actualValueDescription !== undefined ? { actualValue: actualValueDescription } : {}),\n },\n });\n}\n"],"mappings":";;;;;;;;AAgBA,SAAgB,0BAA0B,KAAiC;AACzE,QAAO,IAAI,mBAAmB,QAAQ,0BAA0B;EAC9D,QAAQ;EACR,KAAK,sCAAsC,IAAI;EAC/C,KAAK;EACL,MAAM,EAAE,KAAK;EACd,CAAC;;;;;;;;;AAUJ,SAAgB,mCACd,KACA,yBACoB;AACpB,QAAO,IAAI,mBAAmB,QAAQ,wDAAwD;EAC5F,QAAQ;EACR,KACE,4BAA4B,SACxB,oBAAoB,IAAI,6FAA6F,4BACrH,oBAAoB,IAAI;EAC9B,KAAK;EACL,MAAM;GACJ;GACA,GAAI,4BAA4B,SAAY,EAAE,cAAc,yBAAyB,GAAG,EAAE;GAC3F;EACF,CAAC;;;;;;AAOJ,SAAgB,2BACd,KACA,wBACoB;AACpB,QAAO,IAAI,mBAAmB,QAAQ,uDAAuD;EAC3F,QAAQ;EACR,KACE,2BAA2B,SACvB,yCAAyC,IAAI,aAAa,uBAAuB,yCACjF,yCAAyC,IAAI;EACnD,KAAK;EACL,MAAM;GACJ;GACA,GAAI,2BAA2B,SAAY,EAAE,aAAa,wBAAwB,GAAG,EAAE;GACxF;EACF,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,19 +1,19 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@prisma-next/errors",
|
|
3
|
-
"version": "0.4.0-dev.
|
|
3
|
+
"version": "0.4.0-dev.6",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"sideEffects": false,
|
|
6
6
|
"description": "Structured error types for Prisma Next control and execution planes",
|
|
7
7
|
"dependencies": {
|
|
8
|
-
"@prisma-next/
|
|
9
|
-
"@prisma-next/
|
|
8
|
+
"@prisma-next/utils": "0.4.0-dev.6",
|
|
9
|
+
"@prisma-next/framework-components": "0.4.0-dev.6"
|
|
10
10
|
},
|
|
11
11
|
"devDependencies": {
|
|
12
12
|
"tsdown": "0.18.4",
|
|
13
13
|
"typescript": "5.9.3",
|
|
14
14
|
"vitest": "4.0.17",
|
|
15
|
-
"@prisma-next/
|
|
16
|
-
"@prisma-next/
|
|
15
|
+
"@prisma-next/tsconfig": "0.0.0",
|
|
16
|
+
"@prisma-next/tsdown": "0.0.0"
|
|
17
17
|
},
|
|
18
18
|
"files": [
|
|
19
19
|
"dist",
|
|
@@ -25,6 +25,7 @@
|
|
|
25
25
|
"exports": {
|
|
26
26
|
"./control": "./dist/control.mjs",
|
|
27
27
|
"./execution": "./dist/execution.mjs",
|
|
28
|
+
"./migration": "./dist/migration.mjs",
|
|
28
29
|
"./package.json": "./package.json"
|
|
29
30
|
},
|
|
30
31
|
"repository": {
|
package/src/control.ts
CHANGED
|
@@ -35,7 +35,7 @@ export interface CliErrorConflict {
|
|
|
35
35
|
*/
|
|
36
36
|
export class CliStructuredError extends Error {
|
|
37
37
|
readonly code: string;
|
|
38
|
-
readonly domain: 'CLI' | 'RUN';
|
|
38
|
+
readonly domain: 'CLI' | 'RUN' | 'MIG';
|
|
39
39
|
readonly severity: 'error' | 'warn' | 'info';
|
|
40
40
|
readonly why: string | undefined;
|
|
41
41
|
readonly fix: string | undefined;
|
|
@@ -52,7 +52,7 @@ export class CliStructuredError extends Error {
|
|
|
52
52
|
code: string,
|
|
53
53
|
summary: string,
|
|
54
54
|
options?: {
|
|
55
|
-
readonly domain?: 'CLI' | 'RUN';
|
|
55
|
+
readonly domain?: 'CLI' | 'RUN' | 'MIG';
|
|
56
56
|
readonly severity?: 'error' | 'warn' | 'info';
|
|
57
57
|
readonly why?: string;
|
|
58
58
|
readonly fix?: string;
|
|
@@ -82,7 +82,8 @@ export class CliStructuredError extends Error {
|
|
|
82
82
|
* Converts this error to a CLI error envelope for output formatting.
|
|
83
83
|
*/
|
|
84
84
|
toEnvelope(): CliErrorEnvelope {
|
|
85
|
-
const
|
|
85
|
+
const domainPrefixes = { CLI: 'PN-CLI-', RUN: 'PN-RUN-', MIG: 'PN-MIG-' } as const;
|
|
86
|
+
const codePrefix = domainPrefixes[this.domain];
|
|
86
87
|
return {
|
|
87
88
|
ok: false as const,
|
|
88
89
|
code: `${codePrefix}${this.code}`,
|
|
@@ -109,7 +110,7 @@ export class CliStructuredError extends Error {
|
|
|
109
110
|
return (
|
|
110
111
|
candidate.name === 'CliStructuredError' &&
|
|
111
112
|
typeof candidate.code === 'string' &&
|
|
112
|
-
(candidate.domain === 'CLI' || candidate.domain === 'RUN') &&
|
|
113
|
+
(candidate.domain === 'CLI' || candidate.domain === 'RUN' || candidate.domain === 'MIG') &&
|
|
113
114
|
typeof candidate.toEnvelope === 'function'
|
|
114
115
|
);
|
|
115
116
|
}
|
package/src/migration.ts
ADDED
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
import { CliStructuredError } from './control';
|
|
2
|
+
|
|
3
|
+
// ============================================================================
|
|
4
|
+
// Migration Errors (PN-MIG-2000-2999)
|
|
5
|
+
//
|
|
6
|
+
// Errors raised by the migration subsystem (authoring, planning, emit).
|
|
7
|
+
// Domain `MIG` distinguishes these from generic application runtime errors
|
|
8
|
+
// (`RUN`) and from CLI argument/config errors (`CLI`). See
|
|
9
|
+
// `docs/CLI Style Guide.md` for the canonical domain taxonomy.
|
|
10
|
+
// ============================================================================
|
|
11
|
+
|
|
12
|
+
/**
|
|
13
|
+
* `migration.ts` was expected at the given package directory but could not be
|
|
14
|
+
* located. Thrown by `emitMigration` (and, as a belt-and-suspenders, by
|
|
15
|
+
* class-flow `emit` capabilities) when the file is missing.
|
|
16
|
+
*/
|
|
17
|
+
export function errorMigrationFileMissing(dir: string): CliStructuredError {
|
|
18
|
+
return new CliStructuredError('2002', 'migration.ts not found', {
|
|
19
|
+
domain: 'MIG',
|
|
20
|
+
why: `No migration.ts file was found at "${dir}"`,
|
|
21
|
+
fix: 'Scaffold one with `prisma-next migration new` or `prisma-next migration plan`.',
|
|
22
|
+
meta: { dir },
|
|
23
|
+
});
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
* The `migration.ts` at the given package directory does not default-export a
|
|
28
|
+
* valid migration shape. Two shapes are accepted: a `Migration` subclass, or a
|
|
29
|
+
* factory function returning an object with a `plan()` method. Thrown when the
|
|
30
|
+
* default export is missing, is not a constructor/function, does not extend
|
|
31
|
+
* `Migration`, or (for factory functions) returns a value without `plan()`.
|
|
32
|
+
*/
|
|
33
|
+
export function errorMigrationInvalidDefaultExport(
|
|
34
|
+
dir: string,
|
|
35
|
+
actualExportDescription?: string,
|
|
36
|
+
): CliStructuredError {
|
|
37
|
+
return new CliStructuredError('2003', 'migration.ts default export is not a valid migration', {
|
|
38
|
+
domain: 'MIG',
|
|
39
|
+
why:
|
|
40
|
+
actualExportDescription !== undefined
|
|
41
|
+
? `migration.ts at "${dir}" must default-export a Migration subclass or a factory function returning { plan() }; got ${actualExportDescription}`
|
|
42
|
+
: `migration.ts at "${dir}" must default-export a Migration subclass or a factory function returning { plan() }.`,
|
|
43
|
+
fix: 'Use `export default class extends Migration { ... }` or `export default () => ({ plan() { return [...] } })`.',
|
|
44
|
+
meta: {
|
|
45
|
+
dir,
|
|
46
|
+
...(actualExportDescription !== undefined ? { actualExport: actualExportDescription } : {}),
|
|
47
|
+
},
|
|
48
|
+
});
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
/**
|
|
52
|
+
* A class-flow `Migration.plan()` returned a value that is not an array. Used
|
|
53
|
+
* by class-flow emit capabilities after instantiating the authored migration.
|
|
54
|
+
*/
|
|
55
|
+
export function errorMigrationPlanNotArray(
|
|
56
|
+
dir: string,
|
|
57
|
+
actualValueDescription?: string,
|
|
58
|
+
): CliStructuredError {
|
|
59
|
+
return new CliStructuredError('2004', 'Migration.plan() must return an array of operations', {
|
|
60
|
+
domain: 'MIG',
|
|
61
|
+
why:
|
|
62
|
+
actualValueDescription !== undefined
|
|
63
|
+
? `Migration.plan() for migration.ts at "${dir}" returned ${actualValueDescription}; an array of operations is required.`
|
|
64
|
+
: `Migration.plan() for migration.ts at "${dir}" did not return an array of operations.`,
|
|
65
|
+
fix: 'Ensure your `plan()` method returns an array of operations; see the data-migrations authoring guide.',
|
|
66
|
+
meta: {
|
|
67
|
+
dir,
|
|
68
|
+
...(actualValueDescription !== undefined ? { actualValue: actualValueDescription } : {}),
|
|
69
|
+
},
|
|
70
|
+
});
|
|
71
|
+
}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"control-Dl5V1Wc7.mjs","names":[],"sources":["../src/control.ts"],"sourcesContent":["/**\n * CLI error envelope for output formatting.\n * This is the serialized form of a CliStructuredError.\n */\nexport interface CliErrorEnvelope {\n readonly ok: false;\n readonly code: string;\n readonly domain: string;\n readonly severity: 'error' | 'warn' | 'info';\n readonly summary: string;\n readonly why: string | undefined;\n readonly fix: string | undefined;\n readonly where:\n | {\n readonly path: string | undefined;\n readonly line: number | undefined;\n }\n | undefined;\n readonly meta: Record<string, unknown> | undefined;\n readonly docsUrl: string | undefined;\n}\n\n/**\n * Minimal conflict data structure expected by CLI output.\n */\nexport interface CliErrorConflict {\n readonly kind: string;\n readonly summary: string;\n readonly why?: string;\n}\n\n/**\n * Structured CLI error that contains all information needed for error envelopes.\n * Call sites throw these errors with full context.\n */\nexport class CliStructuredError extends Error {\n readonly code: string;\n readonly domain: 'CLI' | 'RUN';\n readonly severity: 'error' | 'warn' | 'info';\n readonly why: string | undefined;\n readonly fix: string | undefined;\n readonly where:\n | {\n readonly path: string | undefined;\n readonly line: number | undefined;\n }\n | undefined;\n readonly meta: Record<string, unknown> | undefined;\n readonly docsUrl: string | undefined;\n\n constructor(\n code: string,\n summary: string,\n options?: {\n readonly domain?: 'CLI' | 'RUN';\n readonly severity?: 'error' | 'warn' | 'info';\n readonly why?: string;\n readonly fix?: string;\n readonly where?: { readonly path?: string; readonly line?: number };\n readonly meta?: Record<string, unknown>;\n readonly docsUrl?: string;\n },\n ) {\n super(summary);\n this.name = 'CliStructuredError';\n this.code = code;\n this.domain = options?.domain ?? 'CLI';\n this.severity = options?.severity ?? 'error';\n this.why = options?.why;\n this.fix = options?.fix === options?.why ? undefined : options?.fix;\n this.where = options?.where\n ? {\n path: options.where.path,\n line: options.where.line,\n }\n : undefined;\n this.meta = options?.meta;\n this.docsUrl = options?.docsUrl;\n }\n\n /**\n * Converts this error to a CLI error envelope for output formatting.\n */\n toEnvelope(): CliErrorEnvelope {\n const codePrefix = this.domain === 'CLI' ? 'PN-CLI-' : 'PN-RUN-';\n return {\n ok: false as const,\n code: `${codePrefix}${this.code}`,\n domain: this.domain,\n severity: this.severity,\n summary: this.message,\n why: this.why,\n fix: this.fix,\n where: this.where,\n meta: this.meta,\n docsUrl: this.docsUrl,\n };\n }\n\n /**\n * Type guard to check if an error is a CliStructuredError.\n * Uses duck-typing to work across module boundaries where instanceof may fail.\n */\n static is(error: unknown): error is CliStructuredError {\n if (!(error instanceof Error)) {\n return false;\n }\n const candidate = error as CliStructuredError;\n return (\n candidate.name === 'CliStructuredError' &&\n typeof candidate.code === 'string' &&\n (candidate.domain === 'CLI' || candidate.domain === 'RUN') &&\n typeof candidate.toEnvelope === 'function'\n );\n }\n}\n\n// ============================================================================\n// Config Errors (PN-CLI-4001-4007)\n// ============================================================================\n\n/**\n * Config file not found or missing.\n */\nexport function errorConfigFileNotFound(\n configPath?: string,\n options?: {\n readonly why?: string;\n },\n): CliStructuredError {\n return new CliStructuredError('4001', 'Config file not found', {\n domain: 'CLI',\n ...(options?.why ? { why: options.why } : { why: 'Config file not found' }),\n fix: \"Run 'prisma-next init' to create a config file\",\n docsUrl: 'https://prisma-next.dev/docs/cli/config',\n ...(configPath ? { where: { path: configPath } } : {}),\n });\n}\n\n/**\n * Contract configuration missing from config.\n */\nexport function errorContractConfigMissing(options?: {\n readonly why?: string;\n}): CliStructuredError {\n return new CliStructuredError('4002', 'Contract configuration missing', {\n domain: 'CLI',\n why: options?.why ?? 'The contract configuration is required for emit',\n fix: 'Add contract configuration to your prisma-next.config.ts',\n docsUrl: 'https://prisma-next.dev/docs/cli/contract-emit',\n });\n}\n\n/**\n * Contract validation failed.\n */\nexport function errorContractValidationFailed(\n reason: string,\n options?: {\n readonly where?: { readonly path?: string; readonly line?: number };\n },\n): CliStructuredError {\n return new CliStructuredError('4003', 'Contract validation failed', {\n domain: 'CLI',\n why: reason,\n fix: 'Re-run `prisma-next contract emit`, or fix the contract file and try again',\n docsUrl: 'https://prisma-next.dev/docs/contracts',\n ...(options?.where ? { where: options.where } : {}),\n });\n}\n\n/**\n * File not found.\n */\nexport function errorFileNotFound(\n filePath: string,\n options?: {\n readonly why?: string;\n readonly fix?: string;\n readonly docsUrl?: string;\n },\n): CliStructuredError {\n return new CliStructuredError('4004', 'File not found', {\n domain: 'CLI',\n why: options?.why ?? `File not found: ${filePath}`,\n fix: options?.fix ?? 'Check that the file path is correct',\n where: { path: filePath },\n ...(options?.docsUrl ? { docsUrl: options.docsUrl } : {}),\n });\n}\n\n/**\n * Database connection is required but not provided.\n */\nexport function errorDatabaseConnectionRequired(options?: {\n readonly why?: string;\n readonly commandName?: string;\n readonly retryCommand?: string;\n}): CliStructuredError {\n const runHint = options?.retryCommand\n ? `Run \\`${options.retryCommand}\\``\n : options?.commandName\n ? `Run \\`prisma-next ${options.commandName} --db <url>\\``\n : 'Provide `--db <url>`';\n return new CliStructuredError('4005', 'Database connection is required', {\n domain: 'CLI',\n why: options?.why ?? 'Database connection is required for this command',\n fix: `${runHint}, or set \\`db: { connection: \"postgres://…\" }\\` in prisma-next.config.ts`,\n });\n}\n\n/**\n * Query runner factory is required but not provided in config.\n */\nexport function errorQueryRunnerFactoryRequired(options?: {\n readonly why?: string;\n}): CliStructuredError {\n return new CliStructuredError('4006', 'Query runner factory is required', {\n domain: 'CLI',\n why: options?.why ?? 'Config.db.queryRunnerFactory is required for db verify',\n fix: 'Add db.queryRunnerFactory to prisma-next.config.ts',\n docsUrl: 'https://prisma-next.dev/docs/cli/db-verify',\n });\n}\n\n/**\n * Family verify.readMarker is required but not provided.\n */\nexport function errorFamilyReadMarkerSqlRequired(options?: {\n readonly why?: string;\n}): CliStructuredError {\n return new CliStructuredError('4007', 'Family readMarker() is required', {\n domain: 'CLI',\n why: options?.why ?? 'Family verify.readMarker is required for db verify',\n fix: 'Ensure family.verify.readMarker() is exported by your family package',\n docsUrl: 'https://prisma-next.dev/docs/cli/db-verify',\n });\n}\n\n/**\n * JSON output format not supported.\n */\nexport function errorJsonFormatNotSupported(options: {\n readonly command: string;\n readonly format: string;\n readonly supportedFormats: readonly string[];\n}): CliStructuredError {\n return new CliStructuredError('4008', 'Unsupported JSON format', {\n domain: 'CLI',\n why: `The ${options.command} command does not support --json ${options.format}`,\n fix: `Use --json ${options.supportedFormats.join(' or ')}, or omit --json for human output`,\n meta: {\n command: options.command,\n format: options.format,\n supportedFormats: options.supportedFormats,\n },\n });\n}\n\n/**\n * Driver is required for DB-connected commands but not provided.\n */\nexport function errorDriverRequired(options?: { readonly why?: string }): CliStructuredError {\n return new CliStructuredError('4010', 'Driver is required for DB-connected commands', {\n domain: 'CLI',\n why: options?.why ?? 'Config.driver is required for DB-connected commands',\n fix: 'Add a control-plane driver to prisma-next.config.ts (e.g. import a driver descriptor and set `driver: postgresDriver`)',\n docsUrl: 'https://prisma-next.dev/docs/cli/config',\n });\n}\n\n/**\n * Contract requires extension packs that are not provided by config descriptors.\n */\nexport function errorContractMissingExtensionPacks(options: {\n readonly missingExtensionPacks: readonly string[];\n readonly providedComponentIds: readonly string[];\n}): CliStructuredError {\n const missing = [...options.missingExtensionPacks].sort();\n return new CliStructuredError('4011', 'Missing extension packs in config', {\n domain: 'CLI',\n why:\n missing.length === 1\n ? `Contract requires extension pack '${missing[0]}', but CLI config does not provide a matching descriptor.`\n : `Contract requires extension packs ${missing.map((p) => `'${p}'`).join(', ')}, but CLI config does not provide matching descriptors.`,\n fix: 'Add the missing extension descriptors to `extensions` in prisma-next.config.ts',\n docsUrl: 'https://prisma-next.dev/docs/cli/config',\n meta: {\n missingExtensionPacks: missing,\n providedComponentIds: [...options.providedComponentIds].sort(),\n },\n });\n}\n\n/**\n * Migration planning failed due to conflicts.\n */\nexport function errorMigrationPlanningFailed(options: {\n readonly conflicts: readonly CliErrorConflict[];\n readonly why?: string;\n}): CliStructuredError {\n const conflictSummaries = options.conflicts.map((c) => c.summary);\n const computedWhy = options.why ?? conflictSummaries.join('\\n');\n\n const conflictFixes = options.conflicts\n .map((c) => c.why)\n .filter((why): why is string => typeof why === 'string');\n const computedFix =\n conflictFixes.length > 0\n ? conflictFixes.join('\\n')\n : 'Use `db verify --schema-only` to inspect conflicts, or ensure the database is empty';\n\n return new CliStructuredError('4020', 'Migration planning failed', {\n domain: 'CLI',\n why: computedWhy,\n fix: computedFix,\n meta: { conflicts: options.conflicts },\n docsUrl: 'https://prisma-next.dev/docs/cli/db-init',\n });\n}\n\n/**\n * Target does not support migrations (missing createPlanner/createRunner).\n */\nexport function errorTargetMigrationNotSupported(options?: {\n readonly why?: string;\n}): CliStructuredError {\n return new CliStructuredError('4021', 'Target does not support migrations', {\n domain: 'CLI',\n why: options?.why ?? 'The configured target does not provide migration planner/runner',\n fix: 'Select a target that provides migrations (it must export `target.migrations` for db init)',\n docsUrl: 'https://prisma-next.dev/docs/cli/db-init',\n });\n}\n\n/**\n * Config validation error (missing required fields).\n */\nexport function errorConfigValidation(\n field: string,\n options?: {\n readonly why?: string;\n },\n): CliStructuredError {\n return new CliStructuredError('4009', 'Config validation error', {\n domain: 'CLI',\n why: options?.why ?? `Config must have a \"${field}\" field`,\n fix: 'Check your prisma-next.config.ts and ensure all required fields are provided',\n docsUrl: 'https://prisma-next.dev/docs/cli/config',\n });\n}\n\n// ============================================================================\n// Generic Error\n// ============================================================================\n\n/**\n * Generic unexpected error.\n */\nexport function errorUnexpected(\n message: string,\n options?: {\n readonly why?: string;\n readonly fix?: string;\n },\n): CliStructuredError {\n return new CliStructuredError('4999', 'Unexpected error', {\n domain: 'CLI',\n why: options?.why ?? message,\n fix: options?.fix ?? 'Check the error message and try again',\n });\n}\n"],"mappings":";;;;;AAmCA,IAAa,qBAAb,cAAwC,MAAM;CAC5C,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CAMT,AAAS;CACT,AAAS;CAET,YACE,MACA,SACA,SASA;AACA,QAAM,QAAQ;AACd,OAAK,OAAO;AACZ,OAAK,OAAO;AACZ,OAAK,SAAS,SAAS,UAAU;AACjC,OAAK,WAAW,SAAS,YAAY;AACrC,OAAK,MAAM,SAAS;AACpB,OAAK,MAAM,SAAS,QAAQ,SAAS,MAAM,SAAY,SAAS;AAChE,OAAK,QAAQ,SAAS,QAClB;GACE,MAAM,QAAQ,MAAM;GACpB,MAAM,QAAQ,MAAM;GACrB,GACD;AACJ,OAAK,OAAO,SAAS;AACrB,OAAK,UAAU,SAAS;;;;;CAM1B,aAA+B;AAE7B,SAAO;GACL,IAAI;GACJ,MAAM,GAHW,KAAK,WAAW,QAAQ,YAAY,YAG/B,KAAK;GAC3B,QAAQ,KAAK;GACb,UAAU,KAAK;GACf,SAAS,KAAK;GACd,KAAK,KAAK;GACV,KAAK,KAAK;GACV,OAAO,KAAK;GACZ,MAAM,KAAK;GACX,SAAS,KAAK;GACf;;;;;;CAOH,OAAO,GAAG,OAA6C;AACrD,MAAI,EAAE,iBAAiB,OACrB,QAAO;EAET,MAAM,YAAY;AAClB,SACE,UAAU,SAAS,wBACnB,OAAO,UAAU,SAAS,aACzB,UAAU,WAAW,SAAS,UAAU,WAAW,UACpD,OAAO,UAAU,eAAe;;;;;;AAYtC,SAAgB,wBACd,YACA,SAGoB;AACpB,QAAO,IAAI,mBAAmB,QAAQ,yBAAyB;EAC7D,QAAQ;EACR,GAAI,SAAS,MAAM,EAAE,KAAK,QAAQ,KAAK,GAAG,EAAE,KAAK,yBAAyB;EAC1E,KAAK;EACL,SAAS;EACT,GAAI,aAAa,EAAE,OAAO,EAAE,MAAM,YAAY,EAAE,GAAG,EAAE;EACtD,CAAC;;;;;AAMJ,SAAgB,2BAA2B,SAEpB;AACrB,QAAO,IAAI,mBAAmB,QAAQ,kCAAkC;EACtE,QAAQ;EACR,KAAK,SAAS,OAAO;EACrB,KAAK;EACL,SAAS;EACV,CAAC;;;;;AAMJ,SAAgB,8BACd,QACA,SAGoB;AACpB,QAAO,IAAI,mBAAmB,QAAQ,8BAA8B;EAClE,QAAQ;EACR,KAAK;EACL,KAAK;EACL,SAAS;EACT,GAAI,SAAS,QAAQ,EAAE,OAAO,QAAQ,OAAO,GAAG,EAAE;EACnD,CAAC;;;;;AAMJ,SAAgB,kBACd,UACA,SAKoB;AACpB,QAAO,IAAI,mBAAmB,QAAQ,kBAAkB;EACtD,QAAQ;EACR,KAAK,SAAS,OAAO,mBAAmB;EACxC,KAAK,SAAS,OAAO;EACrB,OAAO,EAAE,MAAM,UAAU;EACzB,GAAI,SAAS,UAAU,EAAE,SAAS,QAAQ,SAAS,GAAG,EAAE;EACzD,CAAC;;;;;AAMJ,SAAgB,gCAAgC,SAIzB;CACrB,MAAM,UAAU,SAAS,eACrB,SAAS,QAAQ,aAAa,MAC9B,SAAS,cACP,qBAAqB,QAAQ,YAAY,iBACzC;AACN,QAAO,IAAI,mBAAmB,QAAQ,mCAAmC;EACvE,QAAQ;EACR,KAAK,SAAS,OAAO;EACrB,KAAK,GAAG,QAAQ;EACjB,CAAC;;;;;AAMJ,SAAgB,gCAAgC,SAEzB;AACrB,QAAO,IAAI,mBAAmB,QAAQ,oCAAoC;EACxE,QAAQ;EACR,KAAK,SAAS,OAAO;EACrB,KAAK;EACL,SAAS;EACV,CAAC;;;;;AAMJ,SAAgB,iCAAiC,SAE1B;AACrB,QAAO,IAAI,mBAAmB,QAAQ,mCAAmC;EACvE,QAAQ;EACR,KAAK,SAAS,OAAO;EACrB,KAAK;EACL,SAAS;EACV,CAAC;;;;;AAMJ,SAAgB,4BAA4B,SAIrB;AACrB,QAAO,IAAI,mBAAmB,QAAQ,2BAA2B;EAC/D,QAAQ;EACR,KAAK,OAAO,QAAQ,QAAQ,mCAAmC,QAAQ;EACvE,KAAK,cAAc,QAAQ,iBAAiB,KAAK,OAAO,CAAC;EACzD,MAAM;GACJ,SAAS,QAAQ;GACjB,QAAQ,QAAQ;GAChB,kBAAkB,QAAQ;GAC3B;EACF,CAAC;;;;;AAMJ,SAAgB,oBAAoB,SAAyD;AAC3F,QAAO,IAAI,mBAAmB,QAAQ,gDAAgD;EACpF,QAAQ;EACR,KAAK,SAAS,OAAO;EACrB,KAAK;EACL,SAAS;EACV,CAAC;;;;;AAMJ,SAAgB,mCAAmC,SAG5B;CACrB,MAAM,UAAU,CAAC,GAAG,QAAQ,sBAAsB,CAAC,MAAM;AACzD,QAAO,IAAI,mBAAmB,QAAQ,qCAAqC;EACzE,QAAQ;EACR,KACE,QAAQ,WAAW,IACf,qCAAqC,QAAQ,GAAG,6DAChD,qCAAqC,QAAQ,KAAK,MAAM,IAAI,EAAE,GAAG,CAAC,KAAK,KAAK,CAAC;EACnF,KAAK;EACL,SAAS;EACT,MAAM;GACJ,uBAAuB;GACvB,sBAAsB,CAAC,GAAG,QAAQ,qBAAqB,CAAC,MAAM;GAC/D;EACF,CAAC;;;;;AAMJ,SAAgB,6BAA6B,SAGtB;CACrB,MAAM,oBAAoB,QAAQ,UAAU,KAAK,MAAM,EAAE,QAAQ;CACjE,MAAM,cAAc,QAAQ,OAAO,kBAAkB,KAAK,KAAK;CAE/D,MAAM,gBAAgB,QAAQ,UAC3B,KAAK,MAAM,EAAE,IAAI,CACjB,QAAQ,QAAuB,OAAO,QAAQ,SAAS;AAM1D,QAAO,IAAI,mBAAmB,QAAQ,6BAA6B;EACjE,QAAQ;EACR,KAAK;EACL,KAPA,cAAc,SAAS,IACnB,cAAc,KAAK,KAAK,GACxB;EAMJ,MAAM,EAAE,WAAW,QAAQ,WAAW;EACtC,SAAS;EACV,CAAC;;;;;AAMJ,SAAgB,iCAAiC,SAE1B;AACrB,QAAO,IAAI,mBAAmB,QAAQ,sCAAsC;EAC1E,QAAQ;EACR,KAAK,SAAS,OAAO;EACrB,KAAK;EACL,SAAS;EACV,CAAC;;;;;AAMJ,SAAgB,sBACd,OACA,SAGoB;AACpB,QAAO,IAAI,mBAAmB,QAAQ,2BAA2B;EAC/D,QAAQ;EACR,KAAK,SAAS,OAAO,uBAAuB,MAAM;EAClD,KAAK;EACL,SAAS;EACV,CAAC;;;;;AAUJ,SAAgB,gBACd,SACA,SAIoB;AACpB,QAAO,IAAI,mBAAmB,QAAQ,oBAAoB;EACxD,QAAQ;EACR,KAAK,SAAS,OAAO;EACrB,KAAK,SAAS,OAAO;EACtB,CAAC"}
|