@prisma/config 6.13.0-dev.3 → 6.13.0-dev.30

package/dist/index.d.ts

@@ -51,18 +51,29 @@ declare const ColumnTypeEnum: {
     readonly UnknownNumber: 128;
 };
 
+export declare type ConfigDiagnostic = {
+    _tag: 'log';
+    value: (formatters: InjectFormatters) => () => void;
+} | {
+    _tag: 'warn';
+    value: (formatters: InjectFormatters) => () => void;
+};
+
 export declare type ConfigFromFile = {
     resolvedPath: string;
     config: PrismaConfigInternal;
     error?: never;
+    diagnostics: ConfigDiagnostic[];
 } | {
     resolvedPath: string;
     config?: never;
     error: LoadConfigFromFileError;
+    diagnostics: ConfigDiagnostic[];
 } | {
     resolvedPath: null;
     config: PrismaConfigInternal;
     error?: never;
+    diagnostics: ConfigDiagnostic[];
 };
 
 declare type ConnectionInfo = {
@@ -92,6 +103,15 @@ declare interface DriverAdapterFactory<Query, Result> extends AdapterInfo {
     connect(): Promise<Queryable<Query, Result>>;
 }
 
+declare type EnumsConfigShape = {
+    /**
+     * List of enums that are externally managed.
+     * Prisma will not modify the structure of these enums and not generate migrations for those enums.
+     * These enums will still be represented in schema.prisma file and be available in the client API.
+     */
+    external?: string[];
+};
+
 declare type Error_2 = {
     kind: 'GenericJs';
     id: number;
@@ -131,6 +151,10 @@ declare type Error_2 = {
     } | {
         foreignKey: {};
     };
+} | {
+    kind: 'DatabaseNotReachable';
+    host?: string;
+    port?: number;
 } | {
     kind: 'DatabaseDoesNotExist';
     db?: string;
@@ -140,6 +164,11 @@ declare type Error_2 = {
 } | {
     kind: 'DatabaseAccessDenied';
     db?: string;
+} | {
+    kind: 'ConnectionClosed';
+} | {
+    kind: 'TlsConnectionError';
+    reason: string;
 } | {
     kind: 'AuthenticationFailed';
     user?: string;
@@ -211,6 +240,28 @@ declare interface ErrorRegistry {
     consumeError(id: number): ErrorRecord | undefined;
 }
 
+declare type ExperimentalConfig = {
+    /**
+     * Enable experimental adapter support.
+     */
+    adapter?: boolean;
+    /**
+     * Enable experimental Prisma Studio features.
+     */
+    studio?: boolean;
+    /**
+     * Enable experimental external tables support.
+     */
+    externalTables?: boolean;
+};
+
+export declare type InjectFormatters = {
+    dim: (data: string) => string;
+    log: (data: string) => void;
+    warn: (data: string) => void;
+    link: (data: string) => string;
+};
+
 declare type IsolationLevel = 'READ UNCOMMITTED' | 'READ COMMITTED' | 'REPEATABLE READ' | 'SNAPSHOT' | 'SERIALIZABLE';
 
 /**
@@ -221,12 +272,15 @@ declare type IsolationLevel = 'READ UNCOMMITTED' | 'READ COMMITTED' | 'REPEATABL
 export declare function loadConfigFromFile({ configFile, configRoot, }: LoadConfigFromFileInput): Promise<ConfigFromFile>;
 
 export declare type LoadConfigFromFileError = {
+    /**
+     * The config file was not found at the specified path.
+     */
     _tag: 'ConfigFileNotFound';
 } | {
-    _tag: 'TypeScriptImportFailed';
+    _tag: 'ConfigLoadError';
     error: Error;
 } | {
-    _tag: 'ConfigFileParseError';
+    _tag: 'ConfigFileSyntaxError';
     error: Error;
 } | {
     _tag: 'UnknownError';
@@ -244,11 +298,34 @@ declare type LoadConfigFromFileInput = {
     configRoot?: string;
 };
 
+/**
+ * User's Prisma configuration should live in `prisma.config.ts` instead of `package.json#prisma`.
+ * See: https://pris.ly/prisma-config.
+ *
+ * This function returns `null` if no `package.json` is found, or if the `prisma` property is not defined therein.
+ *
+ * TODO: remove in Prisma 7.
+ * @deprecated
+ */
+export declare function loadConfigFromPackageJson(cwd?: string): Promise<{
+    config: PrismaConfigPackageJson;
+    loadedFromFile: string;
+} | null>;
+
 declare type MigrationsConfigShape = {
     /**
      * The path to the directory where Prisma should store migration files, and look for them.
      */
     path?: string;
+    /**
+     * Provide a SQL script that will be used to setup external tables and enums during migration diffing.
+     * Also see `tables.external` and `enums.external`.
+     */
+    initShadowDb?: string;
+    /**
+     * The command to run to seed the database after schema migrations are applied.
+     */
+    seed?: string;
 };
 
 declare const officialPrismaAdapters: readonly ["@prisma/adapter-planetscale", "@prisma/adapter-neon", "@prisma/adapter-libsql", "@prisma/adapter-better-sqlite3", "@prisma/adapter-d1", "@prisma/adapter-pg", "@prisma/adapter-mssql", "@prisma/adapter-mariadb"];
@@ -261,9 +338,9 @@ declare const PRISMA_CONFIG_INTERNAL_BRAND: unique symbol;
  */
 export declare type PrismaConfig = {
     /**
-     * Whether features with an unstable API are enabled.
+     * Experimental feature gates. Each experimental feature must be explicitly enabled.
      */
-    earlyAccess: true;
+    experimental?: Simplify<ExperimentalConfig>;
     /**
      * The path to the schema file, or path to a folder that shall be recursively searched for *.prisma files.
      */
@@ -280,6 +357,14 @@ export declare type PrismaConfig = {
      * Configuration for Prisma migrations.
      */
     migrations?: Simplify<MigrationsConfigShape>;
+    /**
+     * Configuration for the database table entities.
+     */
+    tables?: Simplify<TablesConfigShape>;
+    /**
+     * Configuration for the database enum entities.
+     */
+    enums?: Simplify<EnumsConfigShape>;
     /**
      * Configuration for the database view entities.
      */
@@ -309,6 +394,39 @@ declare type _PrismaConfigInternal = Omit<PrismaConfig, 'adapter'> & {
      * It's set to `null` if no config file was found and only default config is applied.
      */
     loadedFromFile: string | null;
+    /**
+     * The deprecated Prisma configuration from `package.json#prisma`.
+     * This is set to `null` if no `package.json#prisma` config was found.
+     * The configuration read from the Prisma config file (e.g., `prisma.config.ts`) takes precedence over
+     * this `package.json#prisma` config.
+     * @deprecated
+     */
+    deprecatedPackageJson: {
+        /**
+         * The Prisma configuration from `package.json#prisma`.
+         * @deprecated
+         */
+        config: PrismaConfigPackageJson;
+        /**
+         * The path from where the `package.json` config was loaded.
+         * @deprecated
+         */
+        loadedFromFile: string;
+    } | null;
+};
+
+/**
+ * Example:
+ * ```json
+ * {
+ *   "schema": "./prisma/schema.prisma",
+ *   "seed": "tsx ./prisma/seed.ts"
+ * }
+ * ```
+ */
+declare type PrismaConfigPackageJson = {
+    schema?: string;
+    seed?: string;
 };
 
 declare type PrismaStudioConfigShape = {
@@ -414,6 +532,15 @@ declare interface SqlResultSet {
     lastInsertId?: string;
 }
 
+declare type TablesConfigShape = {
+    /**
+     * List of tables that are externally managed.
+     * Prisma will not modify the structure of these tables and not generate migrations for those tables.
+     * These tables will still be represented in schema.prisma file and be available in the client API.
+     */
+    external?: string[];
+};
+
 declare interface Transaction extends AdapterInfo, SqlQueryable {
     /**
      * Transaction options.