turbine-orm 0.81.0 → 0.90.0

package/dist/cjs/cli/index.d.ts

@@ -25,6 +25,8 @@
  *   npx turbine init --url postgres://...
  *   npx turbine migrate create add_users_table
  */
+import { type SchemaMetadata } from '../schema.js';
+import { type AppliedColumnTags } from './code-first-tags.js';
 import type { CliOverrides, ConfigLoadError, ResolvedConfig, TurbineCliConfig } from './config.js';
 import { type PrismaSchemaAst, type ResolvedPrismaDatasourceUrl } from './prisma-schema.js';
 export interface CliArgs {
@@ -59,6 +61,15 @@ export interface CliArgs {
     allowDrift?: boolean;
     allowEmpty?: boolean;
     allowDestructive?: boolean;
+    /** `migrate create --auto|--from-diff --allow-pending`: diff even while migrations are pending. */
+    allowPending?: boolean;
+    /**
+     * `push --dry-run --exit-code` / `migrate status --exit-code`: exit 2 when the
+     * database differs from the schema file / the migration history is not clean.
+     */
+    exitCode?: boolean;
+    /** `migrate deploy --wait[=seconds]`: seconds to wait for a concurrent deploy's lock. */
+    wait?: number;
     /** `migrate create --recipe <name>` scaffold selector. */
     recipe?: string;
     fix?: boolean;
@@ -76,7 +87,7 @@ export interface CliArgs {
     metricsUrl?: string;
     /** `doctor --no-plan-divergence`: skip the cached-plan divergence section (and its pg_stats read). */
     noPlanDivergence?: boolean;
-    /** `doctor --allow-pooler`: run even when the connection string looks like a transaction pooler. */
+    /** `doctor` / `migrate up|deploy|down --allow-pooler`: run even when the connection string looks like a transaction pooler. */
     allowPooler?: boolean;
     /** `init --yes`/`-y`: accept every step's default non-interactively. */
     yes?: boolean;
@@ -98,8 +109,8 @@ export interface CliArgs {
     includeViews?: boolean;
     /** Omit the `Generated at:` header line for reproducible (diff-stable) output. */
     noTimestamp?: boolean;
-    /** `generate --import-ext <js|none|auto>`: sibling-import extension mode (F3). */
-    importExtension?: 'js' | 'none' | 'auto';
+    /** `generate --import-ext <js|ts|none|auto>`: sibling-import extension mode (F3). */
+    importExtension?: 'js' | 'ts' | 'none' | 'auto';
     /** `generate --keep-column-names`: keep raw DB column names as field names (F4). */
     keepColumnNames?: boolean;
     /** `generate --legacy-to-many-uniques`: opt out of the unique-FK → hasOne flip (F2). */
@@ -133,6 +144,8 @@ export interface CliArgs {
     /** `skill --dir <path>`: the skills root to install into (default `.claude/skills`). */
     dir?: string;
 }
+/** How long a bare `migrate deploy --wait` waits for a concurrent deploy to finish. */
+export declare const DEFAULT_LOCK_WAIT_SECONDS = 300;
 /**
  * The canonical name of `command`, or undefined when nothing dispatches it.
  *
@@ -490,6 +503,43 @@ export declare function initEnvNotice(input: {
 export declare function refuseSchemaFilePath(config: Pick<ResolvedConfig, 'schema' | 'schemaFile'>, options?: {
     escapeHatch?: string;
 }): void;
+/**
+ * Overlay the column tags the defineSchema() file declares (`pii`, `updatedAt`,
+ * `maxLength`) onto an introspected schema, before it is generated.
+ *
+ * Introspection reads the database, and the database has no column for these
+ * flags, so a client generated from introspection alone returns PII by default,
+ * never stamps `updatedAt`, and leaves Studio and the MCP server with nothing to
+ * redact. The schema file is the only place the tags exist.
+ *
+ * Loaded when the file was named (`--schema-file` / config `schemaFile`) or sits
+ * at the default path. A named file that is missing, or any file that cannot be
+ * loaded, fails the command: carrying on would generate the unredacted client
+ * this exists to prevent. Only a missing DEFAULT file is skipped, which is a
+ * database-first project with no schema file at all.
+ *
+ * Returns what was applied, or `null` when there was no schema file to read.
+ *
+ * @internal exported for tests.
+ */
+export declare function overlayCodeFirstTags(schema: SchemaMetadata, config: Pick<ResolvedConfig, 'schemaFile' | 'schemaFileConfigured' | 'include' | 'exclude'>): Promise<AppliedColumnTags | null>;
+/**
+ * The generator's `columnTypes`: the schema file's `tsType` declarations, then
+ * the config file's `columnTypes`, which wins on the same key. A config key
+ * whose table the run's include / exclude filters leave out is dropped, since
+ * that table has no generated type to override; every other key goes to the
+ * generator, which rejects one naming no table or column.
+ *
+ * An `include` list leaves out every table it does not name, so a misspelt
+ * table looks exactly like a real table that was left out. `databaseTables`
+ * (every table the schema holds, before filtering) tells them apart: only a
+ * table the database has is dropped, and a name it does not have goes on to the
+ * generator, which names the closest match. Without it every key outside the
+ * filters is dropped.
+ *
+ * @internal exported for tests.
+ */
+export declare function generatorColumnTypes(applied: Pick<AppliedColumnTags, 'columnTypes'> | null, config: Pick<ResolvedConfig, 'columnTypes' | 'include' | 'exclude'>, schema: Pick<SchemaMetadata, 'tables'>, databaseTables?: ReadonlySet<string>): Record<string, string> | undefined;
 /**
  * `turbine migrate-from-prisma --schema prisma/schema.prisma` parses a Prisma
  * schema, resolve its models/fields/relations/compound-uniques against the live
@@ -557,6 +607,11 @@ export type SeedExecutionPlan = {
     file: string;
 };
 export declare function getSeedExecutionPlan(seedFile: string): SeedExecutionPlan;
+/**
+ * Why `migrate up`, `deploy` and `down` refuse a pooled endpoint. The reason is
+ * the migration lock, not the doctor's session-state argument.
+ */
+export declare const MIGRATE_POOLER_EXPLANATION: readonly string[];
 /**
  * Refuse a `doctor` run whose connection string points at a transaction pooler.
  *
@@ -578,7 +633,10 @@ export declare function getSeedExecutionPlan(seedFile: string): SeedExecutionPla
  * Exported for the unit test only (like {@link isLoopbackHost}): a gate whose
  * failure path is `process.exit` is untestable through the command itself.
  */
-export declare function refusePoolerConnection(url: string, args: CliArgs): void;
+export declare function refusePoolerConnection(url: string, args: CliArgs, refusal?: {
+    command: string;
+    explanation?: readonly string[];
+}): void;
 /**
  * True when `host` is a loopback address Studio/Observe may bind without
  * `--allow-remote`. Accepts IPv4, IPv6, and the common bracket form.