@prisma/driver-adapter-utils 6.5.0-dev.8 → 6.5.0-dev.80

package/dist/index.d.mts

@@ -1,5 +1,14 @@
 import { Debug } from '@prisma/debug';
 
+/**
+ * An interface that exposes some basic information about the
+ * adapter like its name and provider type.
+ */
+declare interface AdapterInfo {
+    readonly provider: Provider;
+    readonly adapterName: (typeof officialPrismaAdapters)[number] | (string & {});
+}
+
 /**
  * Original `quaint::ValueType` enum tag from Prisma's `quaint`.
  * Query arguments marked with this type are sanitized before being sent to the database.
@@ -7,7 +16,7 @@ import { Debug } from '@prisma/debug';
  */
 export declare type ArgType = 'Int32' | 'Int64' | 'Float' | 'Double' | 'Text' | 'Enum' | 'EnumArray' | 'Bytes' | 'Boolean' | 'Char' | 'Array' | 'Numeric' | 'Json' | 'Xml' | 'Uuid' | 'DateTime' | 'Date' | 'Time';
 
-export declare const bindAdapter: (adapter: DriverAdapter) => ErrorCapturingDriverAdapter;
+export declare const bindAdapter: (adapter: SqlConnection) => ErrorCapturingSqlConnection;
 
 export declare type ColumnType = (typeof ColumnTypeEnum)[keyof typeof ColumnTypeEnum];
 
@@ -53,15 +62,21 @@ export declare type ConnectionInfo = {
 
 export { Debug }
 
-export declare interface DriverAdapter extends Queryable {
-    /**
-     * Starts new transaction.
-     */
-    transactionContext(): Promise<Result<TransactionContext>>;
+/**
+ * A generic driver adapter that allows the user to connect to a
+ * database. The query and result types are specific to the adapter.
+ */
+declare interface DriverAdapter_2<Query, Result> extends AdapterInfo {
     /**
-     * Optional method that returns extra connection info
+     * Connect to the database.
      */
-    getConnectionInfo?(): Result<ConnectionInfo>;
+    connect(): Promise<Queryable<Query, Result>>;
+}
+
+export declare class DriverAdapterError extends Error {
+    name: string;
+    cause: Error_2;
+    constructor(payload: Error_2);
 }
 
 export declare function err<T>(error: Error_2): Result<T>;
@@ -95,9 +110,23 @@ declare type Error_2 = {
 };
 export { Error_2 as Error }
 
-export declare interface ErrorCapturingDriverAdapter extends DriverAdapter {
+declare type ErrorCapturingFunction<T> = T extends (...args: infer A) => Promise<infer R> ? (...args: A) => Promise<Result<ErrorCapturingInterface<R>>> : T extends (...args: infer A) => infer R ? (...args: A) => Result<ErrorCapturingInterface<R>> : T;
+
+declare type ErrorCapturingInterface<T> = {
+    [K in keyof T]: ErrorCapturingFunction<T[K]>;
+};
+
+declare interface ErrorCapturingSqlConnection extends ErrorCapturingInterface<SqlConnection> {
     readonly errorRegistry: ErrorRegistry;
 }
+export { ErrorCapturingSqlConnection as ErrorCapturingDriverAdapter }
+export { ErrorCapturingSqlConnection }
+
+export declare type ErrorCapturingSqlQueryable = ErrorCapturingInterface<SqlQueryable>;
+
+export declare type ErrorCapturingTransaction = ErrorCapturingInterface<Transaction>;
+
+export declare type ErrorCapturingTransactionContext = ErrorCapturingInterface<TransactionContext>;
 
 export declare type ErrorRecord = {
     error: unknown;
@@ -113,30 +142,15 @@ export declare function ok<T>(value: T): Result<T>;
 
 export declare type Provider = 'mysql' | 'postgres' | 'sqlite';
 
-export declare type Query = {
-    sql: string;
-    args: Array<unknown>;
-    argTypes: Array<ArgType>;
-};
-
-export declare interface Queryable {
-    readonly provider: Provider;
-    readonly adapterName: (typeof officialPrismaAdapters)[number] | (string & {});
+declare interface Queryable<Query, Result> extends AdapterInfo {
     /**
-     * Execute a query given as SQL, interpolating the given parameters,
-     * and returning the type-aware result set of the query.
-     *
-     * This is the preferred way of executing `SELECT` queries.
+     * Execute a query and return its result.
      */
-    queryRaw(params: Query): Promise<Result<ResultSet>>;
+    queryRaw(params: Query): Promise<Result>;
     /**
-     * Execute a query given as SQL, interpolating the given parameters,
-     * and returning the number of affected rows.
-     *
-     * This is the preferred way of executing `INSERT`, `UPDATE`, `DELETE` queries,
-     * as well as transactional queries.
+     * Execute a query and return the number of affected rows.
      */
-    executeRaw(params: Query): Promise<Result<number>>;
+    executeRaw(params: Query): Promise<number>;
 }
 
 export declare type Result<T> = {
@@ -150,7 +164,49 @@ export declare type Result<T> = {
     readonly error: Error_2;
 });
 
-export declare interface ResultSet {
+declare interface SqlConnection extends SqlQueryable {
+    /**
+     * Execute multiple SQL statements separated by semicolon.
+     */
+    executeScript(script: string): Promise<void>;
+    /**
+     * Start new transaction.
+     */
+    transactionContext(): Promise<TransactionContext>;
+    /**
+     * Optional method that returns extra connection info
+     */
+    getConnectionInfo?(): ConnectionInfo;
+    /**
+     * Dispose of the connection and release any resources.
+     */
+    dispose(): Promise<void>;
+}
+export { SqlConnection as DriverAdapter }
+export { SqlConnection }
+
+declare interface SqlDriverAdapter extends DriverAdapter_2<SqlQuery, SqlResultSet> {
+    connect(): Promise<SqlConnection>;
+}
+
+/**
+ * An SQL migration adapter that is aware of the notion of a shadow database
+ * and can create a connection to it.
+ */
+export declare interface SqlMigrationAwareDriverAdapter extends SqlDriverAdapter {
+    connectToShadowDb(): Promise<SqlConnection>;
+}
+
+export declare type SqlQuery = {
+    sql: string;
+    args: Array<unknown>;
+    argTypes: Array<ArgType>;
+};
+
+export declare interface SqlQueryable extends Queryable<SqlQuery, SqlResultSet> {
+}
+
+export declare interface SqlResultSet {
     /**
      * List of column types appearing in a database query, in the same order as `columnNames`.
      * They are used within the Query Engine to convert values from JS to Quaint values.
@@ -172,7 +228,7 @@ export declare interface ResultSet {
     lastInsertId?: string;
 }
 
-export declare interface Transaction extends Queryable {
+export declare interface Transaction extends AdapterInfo, SqlQueryable {
     /**
      * Transaction options.
      */
@@ -180,18 +236,18 @@ export declare interface Transaction extends Queryable {
     /**
      * Commit the transaction.
      */
-    commit(): Promise<Result<void>>;
+    commit(): Promise<void>;
     /**
-     * Rolls back the transaction.
+     * Roll back the transaction.
      */
-    rollback(): Promise<Result<void>>;
+    rollback(): Promise<void>;
 }
 
-export declare interface TransactionContext extends Queryable {
+export declare interface TransactionContext extends AdapterInfo, SqlQueryable {
     /**
-     * Starts new transaction.
+     * Start new transaction.
      */
-    startTransaction(): Promise<Result<Transaction>>;
+    startTransaction(): Promise<Transaction>;
 }
 
 export declare type TransactionOptions = {

package/dist/index.d.ts

@@ -1,5 +1,14 @@
 import { Debug } from '@prisma/debug';
 
+/**
+ * An interface that exposes some basic information about the
+ * adapter like its name and provider type.
+ */
+declare interface AdapterInfo {
+    readonly provider: Provider;
+    readonly adapterName: (typeof officialPrismaAdapters)[number] | (string & {});
+}
+
 /**
  * Original `quaint::ValueType` enum tag from Prisma's `quaint`.
  * Query arguments marked with this type are sanitized before being sent to the database.
@@ -7,7 +16,7 @@ import { Debug } from '@prisma/debug';
  */
 export declare type ArgType = 'Int32' | 'Int64' | 'Float' | 'Double' | 'Text' | 'Enum' | 'EnumArray' | 'Bytes' | 'Boolean' | 'Char' | 'Array' | 'Numeric' | 'Json' | 'Xml' | 'Uuid' | 'DateTime' | 'Date' | 'Time';
 
-export declare const bindAdapter: (adapter: DriverAdapter) => ErrorCapturingDriverAdapter;
+export declare const bindAdapter: (adapter: SqlConnection) => ErrorCapturingSqlConnection;
 
 export declare type ColumnType = (typeof ColumnTypeEnum)[keyof typeof ColumnTypeEnum];
 
@@ -53,15 +62,21 @@ export declare type ConnectionInfo = {
 
 export { Debug }
 
-export declare interface DriverAdapter extends Queryable {
-    /**
-     * Starts new transaction.
-     */
-    transactionContext(): Promise<Result<TransactionContext>>;
+/**
+ * A generic driver adapter that allows the user to connect to a
+ * database. The query and result types are specific to the adapter.
+ */
+declare interface DriverAdapter_2<Query, Result> extends AdapterInfo {
     /**
-     * Optional method that returns extra connection info
+     * Connect to the database.
      */
-    getConnectionInfo?(): Result<ConnectionInfo>;
+    connect(): Promise<Queryable<Query, Result>>;
+}
+
+export declare class DriverAdapterError extends Error {
+    name: string;
+    cause: Error_2;
+    constructor(payload: Error_2);
 }
 
 export declare function err<T>(error: Error_2): Result<T>;
@@ -95,9 +110,23 @@ declare type Error_2 = {
 };
 export { Error_2 as Error }
 
-export declare interface ErrorCapturingDriverAdapter extends DriverAdapter {
+declare type ErrorCapturingFunction<T> = T extends (...args: infer A) => Promise<infer R> ? (...args: A) => Promise<Result<ErrorCapturingInterface<R>>> : T extends (...args: infer A) => infer R ? (...args: A) => Result<ErrorCapturingInterface<R>> : T;
+
+declare type ErrorCapturingInterface<T> = {
+    [K in keyof T]: ErrorCapturingFunction<T[K]>;
+};
+
+declare interface ErrorCapturingSqlConnection extends ErrorCapturingInterface<SqlConnection> {
     readonly errorRegistry: ErrorRegistry;
 }
+export { ErrorCapturingSqlConnection as ErrorCapturingDriverAdapter }
+export { ErrorCapturingSqlConnection }
+
+export declare type ErrorCapturingSqlQueryable = ErrorCapturingInterface<SqlQueryable>;
+
+export declare type ErrorCapturingTransaction = ErrorCapturingInterface<Transaction>;
+
+export declare type ErrorCapturingTransactionContext = ErrorCapturingInterface<TransactionContext>;
 
 export declare type ErrorRecord = {
     error: unknown;
@@ -113,30 +142,15 @@ export declare function ok<T>(value: T): Result<T>;
 
 export declare type Provider = 'mysql' | 'postgres' | 'sqlite';
 
-export declare type Query = {
-    sql: string;
-    args: Array<unknown>;
-    argTypes: Array<ArgType>;
-};
-
-export declare interface Queryable {
-    readonly provider: Provider;
-    readonly adapterName: (typeof officialPrismaAdapters)[number] | (string & {});
+declare interface Queryable<Query, Result> extends AdapterInfo {
     /**
-     * Execute a query given as SQL, interpolating the given parameters,
-     * and returning the type-aware result set of the query.
-     *
-     * This is the preferred way of executing `SELECT` queries.
+     * Execute a query and return its result.
      */
-    queryRaw(params: Query): Promise<Result<ResultSet>>;
+    queryRaw(params: Query): Promise<Result>;
     /**
-     * Execute a query given as SQL, interpolating the given parameters,
-     * and returning the number of affected rows.
-     *
-     * This is the preferred way of executing `INSERT`, `UPDATE`, `DELETE` queries,
-     * as well as transactional queries.
+     * Execute a query and return the number of affected rows.
      */
-    executeRaw(params: Query): Promise<Result<number>>;
+    executeRaw(params: Query): Promise<number>;
 }
 
 export declare type Result<T> = {
@@ -150,7 +164,49 @@ export declare type Result<T> = {
     readonly error: Error_2;
 });
 
-export declare interface ResultSet {
+declare interface SqlConnection extends SqlQueryable {
+    /**
+     * Execute multiple SQL statements separated by semicolon.
+     */
+    executeScript(script: string): Promise<void>;
+    /**
+     * Start new transaction.
+     */
+    transactionContext(): Promise<TransactionContext>;
+    /**
+     * Optional method that returns extra connection info
+     */
+    getConnectionInfo?(): ConnectionInfo;
+    /**
+     * Dispose of the connection and release any resources.
+     */
+    dispose(): Promise<void>;
+}
+export { SqlConnection as DriverAdapter }
+export { SqlConnection }
+
+declare interface SqlDriverAdapter extends DriverAdapter_2<SqlQuery, SqlResultSet> {
+    connect(): Promise<SqlConnection>;
+}
+
+/**
+ * An SQL migration adapter that is aware of the notion of a shadow database
+ * and can create a connection to it.
+ */
+export declare interface SqlMigrationAwareDriverAdapter extends SqlDriverAdapter {
+    connectToShadowDb(): Promise<SqlConnection>;
+}
+
+export declare type SqlQuery = {
+    sql: string;
+    args: Array<unknown>;
+    argTypes: Array<ArgType>;
+};
+
+export declare interface SqlQueryable extends Queryable<SqlQuery, SqlResultSet> {
+}
+
+export declare interface SqlResultSet {
     /**
      * List of column types appearing in a database query, in the same order as `columnNames`.
      * They are used within the Query Engine to convert values from JS to Quaint values.
@@ -172,7 +228,7 @@ export declare interface ResultSet {
     lastInsertId?: string;
 }
 
-export declare interface Transaction extends Queryable {
+export declare interface Transaction extends AdapterInfo, SqlQueryable {
     /**
      * Transaction options.
      */
@@ -180,18 +236,18 @@ export declare interface Transaction extends Queryable {
     /**
      * Commit the transaction.
      */
-    commit(): Promise<Result<void>>;
+    commit(): Promise<void>;
     /**
-     * Rolls back the transaction.
+     * Roll back the transaction.
      */
-    rollback(): Promise<Result<void>>;
+    rollback(): Promise<void>;
 }
 
-export declare interface TransactionContext extends Queryable {
+export declare interface TransactionContext extends AdapterInfo, SqlQueryable {
     /**
-     * Starts new transaction.
+     * Start new transaction.
      */
-    startTransaction(): Promise<Result<Transaction>>;
+    startTransaction(): Promise<Transaction>;
 }
 
 export declare type TransactionOptions = {

package/dist/index.js

@@ -3,6 +3,7 @@ var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __export = (target, all) => {
   for (var name in all)
     __defProp(target, name, { get: all[name], enumerable: true });
@@ -16,18 +17,33 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
 
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
   ColumnTypeEnum: () => ColumnTypeEnum,
   Debug: () => import_debug.Debug,
+  DriverAdapterError: () => DriverAdapterError,
   bindAdapter: () => bindAdapter,
   err: () => err,
   ok: () => ok
 });
 module.exports = __toCommonJS(index_exports);
 
+// src/error.ts
+var DriverAdapterError = class extends Error {
+  constructor(payload) {
+    super(typeof payload["message"] === "string" ? payload["message"] : payload.kind);
+    __publicField(this, "name", "DriverAdapterError");
+    __publicField(this, "cause");
+    this.cause = payload;
+  }
+};
+function isDriverAdapterError(error) {
+  return error["name"] === "DriverAdapterError" && typeof error["cause"] === "object";
+}
+
 // src/result.ts
 function ok(value) {
   return {
@@ -57,7 +73,7 @@ function err(error) {
 // src/binder.ts
 var ErrorRegistryInternal = class {
   constructor() {
-    this.registeredErrors = [];
+    __publicField(this, "registeredErrors", []);
   }
   consumeError(id) {
     return this.registeredErrors[id];
@@ -79,10 +95,12 @@ var bindAdapter = (adapter) => {
     errorRegistry,
     queryRaw: wrapAsync(errorRegistry, adapter.queryRaw.bind(adapter)),
     executeRaw: wrapAsync(errorRegistry, adapter.executeRaw.bind(adapter)),
+    executeScript: wrapAsync(errorRegistry, adapter.executeScript.bind(adapter)),
+    dispose: wrapAsync(errorRegistry, adapter.dispose.bind(adapter)),
     provider: adapter.provider,
     transactionContext: async (...args) => {
       const ctx = await createTransactionContext(...args);
-      return ctx.map((tx) => bindTransactionContext(errorRegistry, tx));
+      return ctx.map((ctx2) => bindTransactionContext(errorRegistry, ctx2));
     }
   };
   if (adapter.getConnectionInfo) {
@@ -117,8 +135,11 @@ var bindTransaction = (errorRegistry, transaction) => {
 function wrapAsync(registry, fn) {
   return async (...args) => {
     try {
-      return await fn(...args);
+      return ok(await fn(...args));
     } catch (error) {
+      if (isDriverAdapterError(error)) {
+        return err(error.cause);
+      }
       const id = registry.registerNewError(error);
       return err({ kind: "GenericJs", id });
     }
@@ -127,8 +148,11 @@ function wrapAsync(registry, fn) {
 function wrapSync(registry, fn) {
   return (...args) => {
     try {
-      return fn(...args);
+      return ok(fn(...args));
     } catch (error) {
+      if (isDriverAdapterError(error)) {
+        return err(error.cause);
+      }
       const id = registry.registerNewError(error);
       return err({ kind: "GenericJs", id });
     }
@@ -180,6 +204,7 @@ var import_debug = require("@prisma/debug");
 0 && (module.exports = {
   ColumnTypeEnum,
   Debug,
+  DriverAdapterError,
   bindAdapter,
   err,
   ok

package/dist/index.mjs

@@ -1,3 +1,20 @@
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+
+// src/error.ts
+var DriverAdapterError = class extends Error {
+  constructor(payload) {
+    super(typeof payload["message"] === "string" ? payload["message"] : payload.kind);
+    __publicField(this, "name", "DriverAdapterError");
+    __publicField(this, "cause");
+    this.cause = payload;
+  }
+};
+function isDriverAdapterError(error) {
+  return error["name"] === "DriverAdapterError" && typeof error["cause"] === "object";
+}
+
 // src/result.ts
 function ok(value) {
   return {
@@ -27,7 +44,7 @@ function err(error) {
 // src/binder.ts
 var ErrorRegistryInternal = class {
   constructor() {
-    this.registeredErrors = [];
+    __publicField(this, "registeredErrors", []);
   }
   consumeError(id) {
     return this.registeredErrors[id];
@@ -49,10 +66,12 @@ var bindAdapter = (adapter) => {
     errorRegistry,
     queryRaw: wrapAsync(errorRegistry, adapter.queryRaw.bind(adapter)),
     executeRaw: wrapAsync(errorRegistry, adapter.executeRaw.bind(adapter)),
+    executeScript: wrapAsync(errorRegistry, adapter.executeScript.bind(adapter)),
+    dispose: wrapAsync(errorRegistry, adapter.dispose.bind(adapter)),
     provider: adapter.provider,
     transactionContext: async (...args) => {
       const ctx = await createTransactionContext(...args);
-      return ctx.map((tx) => bindTransactionContext(errorRegistry, tx));
+      return ctx.map((ctx2) => bindTransactionContext(errorRegistry, ctx2));
     }
   };
   if (adapter.getConnectionInfo) {
@@ -87,8 +106,11 @@ var bindTransaction = (errorRegistry, transaction) => {
 function wrapAsync(registry, fn) {
   return async (...args) => {
     try {
-      return await fn(...args);
+      return ok(await fn(...args));
     } catch (error) {
+      if (isDriverAdapterError(error)) {
+        return err(error.cause);
+      }
       const id = registry.registerNewError(error);
       return err({ kind: "GenericJs", id });
     }
@@ -97,8 +119,11 @@ function wrapAsync(registry, fn) {
 function wrapSync(registry, fn) {
   return (...args) => {
     try {
-      return fn(...args);
+      return ok(fn(...args));
     } catch (error) {
+      if (isDriverAdapterError(error)) {
+        return err(error.cause);
+      }
       const id = registry.registerNewError(error);
       return err({ kind: "GenericJs", id });
     }
@@ -149,6 +174,7 @@ import { Debug } from "@prisma/debug";
 export {
   ColumnTypeEnum,
   Debug,
+  DriverAdapterError,
   bindAdapter,
   err,
   ok

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prisma/driver-adapter-utils",
-  "version": "6.5.0-dev.8",
+  "version": "6.5.0-dev.80",
   "description": "Internal set of utilities and types for Prisma's driver adapters.",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -31,7 +31,7 @@
   "license": "Apache-2.0",
   "sideEffects": false,
   "dependencies": {
-    "@prisma/debug": "6.5.0-dev.8"
+    "@prisma/debug": "6.5.0-dev.80"
   },
   "scripts": {
     "dev": "DEV=true tsx helpers/build.ts",