@lokalise/prisma-utils 5.0.1 → 6.0.0

package/README.md

@@ -2,26 +2,143 @@
 
 This package provides reusable helpers for Prisma query builder.
 
-# Usage
+## Installation
+
+```bash
+npm install @lokalise/prisma-utils
+```
+
+## Features
+
+### Prisma Client Factory
+
+Factory function to create a Prisma client instance with default configuration and optional Prometheus metrics integration.
+
+**Without metrics:**
+
+```typescript
+import { prismaClientFactory } from '@lokalise/prisma-utils'
+import { PrismaClient } from '@prisma/client'
+
+const prisma = prismaClientFactory(PrismaClient, {
+  // Your Prisma client options
+})
+```
+
+**With Prometheus metrics:**
+
+```typescript
+import { prismaClientFactory } from '@lokalise/prisma-utils'
+import { PrismaClient } from '@prisma/client'
+import * as promClient from 'prom-client'
+
+const prisma = prismaClientFactory(
+  PrismaClient,
+  {
+    // Your Prisma client options
+  },
+  { promClient }
+)
+```
+
+The factory automatically:
+- Sets default transaction isolation level to `ReadCommitted`
+- Extends the client with Prometheus metrics when `promClient` is provided
+
+#### Prisma Metrics Collection
+
+When you provide `promClient` to the factory, the following metrics are automatically collected:
+
+- **`prisma_queries_total`**: Total number of Prisma queries executed
+  - Labels: `model`, `operation`, `status` (success/error)
+- **`prisma_query_duration_seconds`**: Duration of Prisma queries in seconds
+  - Labels: `model`, `operation`
+  - Buckets: [0.001, 0.005, 0.01, 0.05, 0.1, 0.5, 1, 5]
+- **`prisma_errors_total`**: Total number of Prisma query errors
+  - Labels: `model`, `operation`, `error_code`
+
+These metrics are automatically exposed through the Prometheus registry and can be scraped by your monitoring system.
+
+### Prisma Transactions
+
+Helper for executing Prisma transactions with intelligent automatic retry mechanism, optimized for distributed databases like CockroachDB.
+
+#### Basic Usage
+
+**With multiple operations:**
 
 ```typescript
 import { prismaTransaction } from '@lokalise/prisma-utils'
+import type { Either } from '@lokalise/node-core'
 
-const result: Either<unknown, [Item, Segment]> = await prismaTransaction(prisma, [
-	prisma.item.create({ data: TEST_ITEM_1 }),
-	prisma.segment.create({ data: TEST_SEGMENT_1 }),
-])
+const result: Either<unknown, [Item, Segment]> = await prismaTransaction(
+  prisma,
+  { dbDriver: 'CockroachDb' },
+  [
+    prisma.item.create({ data: { value: 'item-1' } }),
+    prisma.segment.create({ data: { name: 'segment-1' } }),
+  ]
+)
 ```
 
-This implementation will retry the transaction on P2034 error, which satisfies Prisma recommendations for distributed databases such as CockroachDB.
+**With transaction callback:**
+
+```typescript
+const result: Either<unknown, User> = await prismaTransaction(
+  prisma,
+  { dbDriver: 'CockroachDb' },
+  async (tx) => {
+    const user = await tx.user.create({ data: { name: 'John' } })
+    await tx.profile.create({ data: { userId: user.id, bio: 'Developer' } })
+    return user
+  }
+)
+```
 
-### Prisma metrics plugin
+#### Automatic Retry Mechanism
 
-Plugin to collect and send metrics to prometheus. Prisma metrics will be added to our app metrics.
+The transaction helper automatically retries on the following error conditions:
 
-Add the plugin to your Fastify instance by registering it with the following options:
+**Prisma Error Codes:**
+- **P2034**: Write conflict / Serialization failure (common in distributed databases)
+- **P2028**: Transaction API error
+- **P1017**: Server closed the connection
+
+**CockroachDB-specific:**
+- Automatically detects and retries CockroachDB retry transaction errors.
+
+#### Retry Strategy
+
+1. **Exponential Backoff**: Delay between retries increases exponentially
+   - Formula: `2^(retry-1) × baseRetryDelayMs`
+   - Example: 100ms → 200ms → 400ms → 800ms...
+
+2. **Smart Timeout Adjustment**: If transaction times out (P2028 with "transaction is closed"), the timeout is 
+ automatically doubled on retry (up to `maxTimeout`)
+
+3. **Configurable Options**:
+
+```typescript
+const result = await prismaTransaction(
+  prisma,
+  {
+    dbDriver: 'CockroachDb',       // Enable CockroachDB-specific retries
+    retriesAllowed: 2,             // Default: 2 (total 3 attempts)
+    baseRetryDelayMs: 100,         // Default: 100ms
+    maxRetryDelayMs: 30000,        // Default: 30s (max delay between retries)
+    timeout: 5000,                 // Default: 5s (transaction timeout)
+    maxTimeout: 30000,             // Default: 30s (max transaction timeout)
+  },
+  [
+    // Your transaction operations
+  ]
+)
+```
 
-- `isEnabled`;
-- `collectionOptions` (by default we collect metrics `every 5 seconds`) to override default collector behaviour
+#### Why This Matters
 
-Once the plugin has been added to your Fastify instance and loaded, we will start collection prisma metrics.
+Distributed databases like CockroachDB use optimistic concurrency control, which can result in serialization errors 
+when multiple transactions compete for the same resources. This helper abstracts away the complexity of handling these 
+errors, providing a robust and efficient way to ensure your transactions succeed even under high contention.
+By automatically retrying failed transactions with an intelligent backoff strategy, you can significantly improve the 
+reliability and performance of your application when using distributed databases.

package/dist/{errors → src/errors}/cockroachdbError.d.ts

@@ -1,4 +1,4 @@
-import type { PrismaClientKnownRequestError } from '@prisma/client/runtime/library';
+import type { PrismaClientKnownRequestError } from '@prisma/client/runtime/client';
 /**
  * Check if the error is a CockroachDB transaction retry error
  *

package/dist/src/errors/cockroachdbError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cockroachdbError.js","sourceRoot":"","sources":["../../../src/errors/cockroachdbError.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,kCAAkC,GAAG,OAAO,CAAA;AAElD;;;;GAIG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,KAAoC,EAAW,EAAE;IAC7F,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAA;IACvB,IAAI,CAAC,IAAI;QAAE,OAAO,KAAK,CAAA;IAEvB,OAAO,IAAI,CAAC,IAAI,KAAK,kCAAkC,CAAA;AACzD,CAAC,CAAA"}

package/dist/src/errors/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/errors/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAA"}

package/dist/{errors → src/errors}/prismaError.d.ts

@@ -1,4 +1,4 @@
-import type { PrismaClientKnownRequestError } from '@prisma/client/runtime/library';
+import type { PrismaClientKnownRequestError } from '@prisma/client/runtime/client';
 /**
  * What is checked?
  * 	1. error is defined and not null

package/dist/src/errors/prismaError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prismaError.js","sourceRoot":"","sources":["../../../src/errors/prismaError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAG7C;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAC7C,KAAc,EAC0B,EAAE,CAC1C,CAAC,CAAC,KAAK;IACP,OAAO,CAAC,KAAK,CAAC;IACd,MAAM,IAAI,KAAK;IACf,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ;IAC9B,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;AAE5B,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,KAAoC,EAAW,EAAE,CAC9F,KAAK,CAAC,IAAI,KAAK,wBAAwB;IACvC,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,4BAA4B,CAAC,CAAA;AAEpE;;;GAGG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,OAAO,CAAA;AAE7C;;;;GAIG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,OAAO,CAAA;AAEjD;;;GAGG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,OAAO,CAAA;AAErD;;;GAGG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,OAAO,CAAA;AAE/C;;GAEG;AACH,MAAM,CAAC,MAAM,qCAAqC,GAAG,OAAO,CAAA"}

package/dist/src/factory/extendPrismaClientWithMetrics.d.ts

@@ -0,0 +1,3 @@
+import type Prometheus from 'prom-client';
+import type { PrismaClient } from '../../test/db-client/client.ts';
+export declare const extendPrismaClientWithMetrics: <Client extends PrismaClient>(prisma: Client, promClient: typeof Prometheus) => Client;

package/dist/src/factory/extendPrismaClientWithMetrics.js

@@ -0,0 +1,90 @@
+export const extendPrismaClientWithMetrics = (prisma, promClient) => createExtendedClient(prisma, registerMetricsIfNeeded(promClient));
+const METRICS_PREFIX = 'prisma';
+const createExtendedClient = (prisma, metrics) => {
+    return prisma.$extends({
+        name: 'metrics-collector',
+        query: {
+            $allModels: {
+                async $allOperations({ model, operation, args, query }) {
+                    const startTime = Date.now();
+                    const resolvedModel = model ?? 'unknown';
+                    let result = { result: undefined };
+                    try {
+                        const response = await query(args);
+                        result = { result: response };
+                    }
+                    catch (error) {
+                        result = { error };
+                    }
+                    finally {
+                        const duration = (Date.now() - startTime) / 1000;
+                        // Always record metrics (success or error)
+                        metrics.queriesTotal.inc({
+                            model: resolvedModel,
+                            operation,
+                            status: result.error ? 'error' : 'success',
+                        });
+                        metrics.queryDuration.observe({ model: resolvedModel, operation }, duration);
+                        if (result.error) {
+                            const errorCode = result.error?.code || 'unknown';
+                            metrics.errorsTotal.inc({
+                                model: resolvedModel,
+                                operation,
+                                error_code: errorCode,
+                            });
+                        }
+                    }
+                    if (result.error)
+                        throw result.error;
+                    return result.result;
+                },
+            },
+        },
+    });
+};
+/**
+ * Register Prometheus metrics if they don't already exist
+ */
+const registerMetricsIfNeeded = (promClient) => {
+    const existingMetrics = getExistingMetrics(promClient);
+    if (existingMetrics)
+        return existingMetrics;
+    const queriesTotal = new promClient.Counter({
+        name: `${METRICS_PREFIX}_queries_total`,
+        help: 'Total number of Prisma queries executed',
+        labelNames: ['model', 'operation', 'status'],
+        registers: [promClient.register],
+    });
+    const queryDuration = new promClient.Histogram({
+        name: `${METRICS_PREFIX}_query_duration_seconds`,
+        help: 'Duration of Prisma queries in seconds',
+        labelNames: ['model', 'operation'],
+        buckets: [0.001, 0.005, 0.01, 0.05, 0.1, 0.5, 1, 5],
+        registers: [promClient.register],
+    });
+    const errorsTotal = new promClient.Counter({
+        name: `${METRICS_PREFIX}_errors_total`,
+        help: 'Total number of Prisma query errors',
+        labelNames: ['model', 'operation', 'error_code'],
+        registers: [promClient.register],
+    });
+    return { queriesTotal, queryDuration, errorsTotal };
+};
+/**
+ * Check if metrics already exist in the registry
+ */
+const getExistingMetrics = (promClient) => {
+    try {
+        const queriesTotal = promClient.register.getSingleMetric(`${METRICS_PREFIX}_queries_total`);
+        const queryDuration = promClient.register.getSingleMetric(`${METRICS_PREFIX}_query_duration_seconds`);
+        const errorsTotal = promClient.register.getSingleMetric(`${METRICS_PREFIX}_errors_total`);
+        if (queriesTotal && queryDuration && errorsTotal) {
+            return { queriesTotal, queryDuration, errorsTotal };
+        }
+    }
+    catch {
+        // If any error occurs (e.g. metrics not found), return null to create new metrics
+    }
+    return null;
+};
+//# sourceMappingURL=extendPrismaClientWithMetrics.js.map

package/dist/src/factory/extendPrismaClientWithMetrics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extendPrismaClientWithMetrics.js","sourceRoot":"","sources":["../../../src/factory/extendPrismaClientWithMetrics.ts"],"names":[],"mappings":"AAIA,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAC3C,MAAc,EACd,UAA6B,EACrB,EAAE,CAAC,oBAAoB,CAAC,MAAM,EAAE,uBAAuB,CAAC,UAAU,CAAC,CAAW,CAAA;AAQxF,MAAM,cAAc,GAAG,QAAQ,CAAA;AAE/B,MAAM,oBAAoB,GAAG,CAAC,MAAoB,EAAE,OAAqB,EAAE,EAAE;IAC3E,OAAO,MAAM,CAAC,QAAQ,CAAC;QACrB,IAAI,EAAE,mBAAmB;QACzB,KAAK,EAAE;YACL,UAAU,EAAE;gBACV,KAAK,CAAC,cAAc,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE;oBACpD,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;oBAC5B,MAAM,aAAa,GAAG,KAAK,IAAI,SAAS,CAAA;oBACxC,IAAI,MAAM,GAA6B,EAAE,MAAM,EAAE,SAAS,EAAE,CAAA;oBAE5D,IAAI,CAAC;wBACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,CAAA;wBAClC,MAAM,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAA;oBAC/B,CAAC;oBAAC,OAAO,KAAK,EAAE,CAAC;wBACf,MAAM,GAAG,EAAE,KAAK,EAAE,CAAA;oBACpB,CAAC;4BAAS,CAAC;wBACT,MAAM,QAAQ,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,GAAG,IAAI,CAAA;wBAEhD,2CAA2C;wBAC3C,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC;4BACvB,KAAK,EAAE,aAAa;4BACpB,SAAS;4BACT,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS;yBAC3C,CAAC,CAAA;wBAEF,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,QAAQ,CAAC,CAAA;wBAE5E,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;4BACjB,MAAM,SAAS,GAAI,MAAM,CAAC,KAAmC,EAAE,IAAI,IAAI,SAAS,CAAA;4BAChF,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC;gCACtB,KAAK,EAAE,aAAa;gCACpB,SAAS;gCACT,UAAU,EAAE,SAAS;6BACtB,CAAC,CAAA;wBACJ,CAAC;oBACH,CAAC;oBAED,IAAI,MAAM,CAAC,KAAK;wBAAE,MAAM,MAAM,CAAC,KAAK,CAAA;oBACpC,OAAO,MAAM,CAAC,MAAM,CAAA;gBACtB,CAAC;aACF;SACF;KACF,CAAC,CAAA;AACJ,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,uBAAuB,GAAG,CAAC,UAA6B,EAAgB,EAAE;IAC9E,MAAM,eAAe,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAA;IACtD,IAAI,eAAe;QAAE,OAAO,eAAe,CAAA;IAE3C,MAAM,YAAY,GAAG,IAAI,UAAU,CAAC,OAAO,CAAC;QAC1C,IAAI,EAAE,GAAG,cAAc,gBAAgB;QACvC,IAAI,EAAE,yCAAyC;QAC/C,UAAU,EAAE,CAAC,OAAO,EAAE,WAAW,EAAE,QAAQ,CAAC;QAC5C,SAAS,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC;KACjC,CAAC,CAAA;IAEF,MAAM,aAAa,GAAG,IAAI,UAAU,CAAC,SAAS,CAAC;QAC7C,IAAI,EAAE,GAAG,cAAc,yBAAyB;QAChD,IAAI,EAAE,uCAAuC;QAC7C,UAAU,EAAE,CAAC,OAAO,EAAE,WAAW,CAAC;QAClC,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;QACnD,SAAS,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC;KACjC,CAAC,CAAA;IAEF,MAAM,WAAW,GAAG,IAAI,UAAU,CAAC,OAAO,CAAC;QACzC,IAAI,EAAE,GAAG,cAAc,eAAe;QACtC,IAAI,EAAE,qCAAqC;QAC3C,UAAU,EAAE,CAAC,OAAO,EAAE,WAAW,EAAE,YAAY,CAAC;QAChD,SAAS,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC;KACjC,CAAC,CAAA;IAEF,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,WAAW,EAAE,CAAA;AACrD,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,kBAAkB,GAAG,CAAC,UAA6B,EAAuB,EAAE;IAChF,IAAI,CAAC;QACH,MAAM,YAAY,GAAG,UAAU,CAAC,QAAQ,CAAC,eAAe,CAAC,GAAG,cAAc,gBAAgB,CAAC,CAAA;QAC3F,MAAM,aAAa,GAAG,UAAU,CAAC,QAAQ,CAAC,eAAe,CACvD,GAAG,cAAc,yBAAyB,CAC3C,CAAA;QACD,MAAM,WAAW,GAAG,UAAU,CAAC,QAAQ,CAAC,eAAe,CAAC,GAAG,cAAc,eAAe,CAAC,CAAA;QAEzF,IAAI,YAAY,IAAI,aAAa,IAAI,WAAW,EAAE,CAAC;YACjD,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,WAAW,EAAkB,CAAA;QACrE,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;QACP,kFAAkF;IACpF,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC,CAAA"}

package/dist/src/factory/index.d.ts

@@ -0,0 +1 @@
+export { prismaClientFactory } from './prismaClientFactory.ts';

package/dist/src/factory/index.js

@@ -0,0 +1,2 @@
+export { prismaClientFactory } from "./prismaClientFactory.js";
+//# sourceMappingURL=index.js.map

package/dist/src/factory/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/factory/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA"}

package/dist/src/factory/prismaClientFactory.d.ts

@@ -0,0 +1,20 @@
+import type * as RuntimePrisma from '@prisma/client/runtime/client';
+import type Prometheus from 'prom-client';
+import type { PrismaClient } from '../../test/db-client/client.ts';
+import type { PrismaClientConstructor } from '../../test/db-client/internal/class.ts';
+export type prismaClientFactoryOptions = {
+    promClient?: typeof Prometheus;
+};
+/**
+ * Factory function to create a Prisma client instance with default configuration
+ * and optional Prometheus metrics integration.
+ *
+ * @template Client - The Prisma client type to instantiate
+ * @param builder - The Prisma client constructor
+ * @param options - Prisma client initialization options
+ * @param factoryOptions - Optional factory configuration
+ * @param factoryOptions.promClient - Prometheus client instance to enable metrics collection
+ * @returns A configured Prisma client instance, optionally extended with metrics
+ *
+ */
+export declare const prismaClientFactory: <Client extends PrismaClient>(builder: PrismaClientConstructor, options: RuntimePrisma.PrismaClientOptions, factoryOptions?: prismaClientFactoryOptions) => Client;

package/dist/src/factory/prismaClientFactory.js

@@ -0,0 +1,26 @@
+import { extendPrismaClientWithMetrics } from "./extendPrismaClientWithMetrics.js";
+/**
+ * Factory function to create a Prisma client instance with default configuration
+ * and optional Prometheus metrics integration.
+ *
+ * @template Client - The Prisma client type to instantiate
+ * @param builder - The Prisma client constructor
+ * @param options - Prisma client initialization options
+ * @param factoryOptions - Optional factory configuration
+ * @param factoryOptions.promClient - Prometheus client instance to enable metrics collection
+ * @returns A configured Prisma client instance, optionally extended with metrics
+ *
+ */
+export const prismaClientFactory = (builder, options, factoryOptions) => {
+    options.transactionOptions = {
+        isolationLevel: 'ReadCommitted',
+        ...options.transactionOptions,
+    };
+    // @ts-expect-error
+    let prismaClient = new builder(options);
+    if (factoryOptions?.promClient) {
+        prismaClient = extendPrismaClientWithMetrics(prismaClient, factoryOptions.promClient);
+    }
+    return prismaClient;
+};
+//# sourceMappingURL=prismaClientFactory.js.map

package/dist/src/factory/prismaClientFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prismaClientFactory.js","sourceRoot":"","sources":["../../../src/factory/prismaClientFactory.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,6BAA6B,EAAE,MAAM,oCAAoC,CAAA;AAMlF;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,OAAgC,EAChC,OAA0C,EAC1C,cAA2C,EACnC,EAAE;IACV,OAAO,CAAC,kBAAkB,GAAG;QAC3B,cAAc,EAAE,eAAe;QAC/B,GAAG,OAAO,CAAC,kBAAkB;KAC9B,CAAA;IAED,mBAAmB;IACnB,IAAI,YAAY,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,CAAA;IACvC,IAAI,cAAc,EAAE,UAAU,EAAE,CAAC;QAC/B,YAAY,GAAG,6BAA6B,CAAC,YAAY,EAAE,cAAc,CAAC,UAAU,CAAC,CAAA;IACvF,CAAC;IAED,OAAO,YAAsB,CAAA;AAC/B,CAAC,CAAA"}

package/dist/src/index.d.ts

@@ -0,0 +1,4 @@
+export * from './errors/index.ts';
+export * from './factory/index.ts';
+export * from './transaction/index.ts';
+export type * from './types.ts';

package/dist/src/index.js

@@ -0,0 +1,4 @@
+export * from "./errors/index.js";
+export * from "./factory/index.js";
+export * from "./transaction/index.js";
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA;AACjC,cAAc,oBAAoB,CAAA;AAClC,cAAc,wBAAwB,CAAA"}

package/dist/src/transaction/index.d.ts

@@ -0,0 +1,2 @@
+export { prismaTransaction } from './prismaTransaction.ts';
+export type * from './types.ts';

package/dist/src/transaction/index.js

@@ -0,0 +1,2 @@
+export { prismaTransaction } from "./prismaTransaction.js";
+//# sourceMappingURL=index.js.map

package/dist/src/transaction/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/transaction/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA"}

package/dist/src/transaction/prismaTransaction.d.ts

@@ -0,0 +1,17 @@
+import type { Either } from '@lokalise/node-core';
+import type * as RuntimePrisma from '@prisma/client/runtime/client';
+import type { PrismaClient } from '../../test/db-client/client.ts';
+import type { PrismaTransactionFn, PrismaTransactionOptions } from './types.ts';
+/**
+ * Perform a Prisma DB transaction with automatic retries if needed.
+ *
+ * @template T | T extends Prisma.PrismaPromise<unknown>[]
+ * @param {PrismaClient} prisma
+ * @param {PrismaTransactionFn<T> | RuntimePrisma.PrismaPromise<unknown>[]} arg	 operation to perform into the transaction
+ * @param {PrismaTransactionOptions} options transaction configuration
+ * @return {Promise<PrismaTransactionReturnType<T>>}
+ */
+export declare const prismaTransaction: {
+    <T, P extends PrismaClient>(prisma: P, options: PrismaTransactionOptions, fn: PrismaTransactionFn<T, P>): Promise<Either<unknown, T>>;
+    <T extends RuntimePrisma.PrismaPromise<unknown>[], P extends PrismaClient>(prisma: P, options: PrismaTransactionOptions, args: [...T]): Promise<Either<unknown, RuntimePrisma.Types.Utils.UnwrapTuple<T>>>;
+};

package/dist/{prismaTransaction.js → src/transaction/prismaTransaction.js}

@@ -1,10 +1,9 @@
 import { setTimeout } from 'node:timers/promises';
 import { deepClone } from '@lokalise/node-core';
-import { isCockroachDBRetryTransaction } from "./errors/cockroachdbError.js";
-import { isPrismaClientKnownRequestError, isPrismaTransactionClosedError, PRISMA_SERIALIZATION_ERROR, PRISMA_SERVER_CLOSED_CONNECTION_ERROR, PRISMA_TRANSACTION_ERROR, } from "./errors/prismaError.js";
+import { isCockroachDBRetryTransaction } from "../errors/cockroachdbError.js";
+import { isPrismaClientKnownRequestError, isPrismaTransactionClosedError, PRISMA_SERIALIZATION_ERROR, PRISMA_SERVER_CLOSED_CONNECTION_ERROR, PRISMA_TRANSACTION_ERROR, } from "../errors/index.js";
 const DEFAULT_OPTIONS = {
     retriesAllowed: 2, // first try + 2 retries = 3 tries
-    dbDriver: 'CockroachDb',
     baseRetryDelayMs: 100,
     maxRetryDelayMs: 30000, // 30s
     timeout: 5000, // 5s
@@ -15,11 +14,11 @@ const DEFAULT_OPTIONS = {
  *
  * @template T | T extends Prisma.PrismaPromise<unknown>[]
  * @param {PrismaClient} prisma
- * @param {PrismaTransactionFn<T> | Prisma.PrismaPromise<unknown>[]} arg	 operation to perform into the transaction
- * @param {PrismaTransactionOptions | PrismaTransactionBasicOptions} options transaction configuration
+ * @param {PrismaTransactionFn<T> | RuntimePrisma.PrismaPromise<unknown>[]} arg	 operation to perform into the transaction
+ * @param {PrismaTransactionOptions} options transaction configuration
  * @return {Promise<PrismaTransactionReturnType<T>>}
  */
-export const prismaTransaction = (async (prisma, arg, options) => {
+export const prismaTransaction = (async (prisma, options, arg) => {
     let optionsWithDefaults = { ...DEFAULT_OPTIONS, ...options };
     let result;
     let retries = 0;

package/dist/src/transaction/prismaTransaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prismaTransaction.js","sourceRoot":"","sources":["../../../src/transaction/prismaTransaction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAEjD,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAG/C,OAAO,EAAE,6BAA6B,EAAE,MAAM,+BAA+B,CAAA;AAC7E,OAAO,EACL,+BAA+B,EAC/B,8BAA8B,EAC9B,0BAA0B,EAC1B,qCAAqC,EACrC,wBAAwB,GACzB,MAAM,oBAAoB,CAAA;AAQ3B,MAAM,eAAe,GAAG;IACtB,cAAc,EAAE,CAAC,EAAE,kCAAkC;IACrD,gBAAgB,EAAE,GAAG;IACrB,eAAe,EAAE,KAAK,EAAE,MAAM;IAC9B,OAAO,EAAE,IAAI,EAAE,KAAK;IACpB,UAAU,EAAE,KAAK,EAAE,MAAM;CACkB,CAAA;AAE7C;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,KAAK,EACrC,MAAS,EACT,OAAiC,EACjC,GAAuE,EAC9B,EAAE;IAC3C,IAAI,mBAAmB,GAAG,EAAE,GAAG,eAAe,EAAE,GAAG,OAAO,EAAE,CAAA;IAC5D,IAAI,MAAkD,CAAA;IAEtD,IAAI,OAAO,GAAG,CAAC,CAAA;IACf,GAAG,CAAC;QACF,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;YAChB,MAAM,UAAU,CACd,mBAAmB,CACjB,OAAO,EACP,mBAAmB,CAAC,gBAAgB,EACpC,mBAAmB,CAAC,eAAe,CACpC,CACF,CAAA;QACH,CAAC;QAED,MAAM,GAAG,MAAM,qBAAqB,CAAC,MAAM,EAAE,GAAG,EAAE,mBAAmB,CAAC,CAAA;QACtE,IAAI,MAAM,CAAC,MAAM;YAAE,MAAK;QAExB,MAAM,YAAY,GAAG,cAAc,CAAC,MAAM,EAAE,mBAAmB,CAAC,QAAQ,CAAC,CAAA;QACzE,IAAI,CAAC,YAAY;YAAE,MAAK;QAExB,IAAI,YAAY,KAAK,kBAAkB,EAAE,CAAC;YACxC,mBAAmB,GAAG,SAAS,CAAC,mBAAmB,CAAC,CAAA;YACpD,mBAAmB,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,CACpC,mBAAmB,CAAC,OAAO,GAAG,CAAC,EAC/B,mBAAmB,CAAC,UAAU,CAC/B,CAAA;QACH,CAAC;QAED,OAAO,EAAE,CAAA;IACX,CAAC,QAAQ,OAAO,IAAI,mBAAmB,CAAC,cAAc,EAAC;IAEvD,OAAO,MAAM,IAAI,EAAE,KAAK,EAAE,IAAI,KAAK,CAAC,yBAAyB,CAAC,EAAE,CAAA;AAClE,CAAC,CAWA,CAAA;AAED,MAAM,qBAAqB,GAAG,KAAK,EACjC,MAAS,EACT,GAAuE,EACvE,OAAkC,EACO,EAAE;IAC3C,IAAI,CAAC;QACH,OAAO;YACL,mBAAmB;YACnB,MAAM,EAAE,MAAM,MAAM,CAAC,YAAY,CAAI,GAAG,EAAE,OAAO,CAAC;SACnD,CAAA;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,EAAE,KAAK,EAAE,CAAA;IAClB,CAAC;AACH,CAAC,CAAA;AAED,MAAM,mBAAmB,GAAG,CAC1B,OAAe,EACf,gBAAwB,EACxB,UAAkB,EACV,EAAE;IACV,wDAAwD;IACxD,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,GAAG,gBAAgB,CAAA;IAC5D,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAA;AACvC,CAAC,CAAA;AAED,MAAM,kBAAkB,GAAG;IACzB,0BAA0B;IAC1B,qCAAqC;IACrC,wBAAwB;CACzB,CAAA;AAGD,MAAM,cAAc,GAAG,CACrB,MAAsC,EACtC,QAAkB,EACI,EAAE;IACxB,IAAI,+BAA+B,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;QAClD,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAA;QAC1B,wEAAwE;QACxE,8GAA8G;QAC9G,IAAI,8BAA8B,CAAC,KAAK,CAAC;YAAE,OAAO,kBAAkB,CAAA;QACpE,2DAA2D;QAC3D,IAAI,kBAAkB,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC;YAAE,OAAO,IAAI,CAAA;QACxD,8DAA8D;QAC9D,IAAI,QAAQ,KAAK,aAAa,IAAI,6BAA6B,CAAC,KAAK,CAAC;YAAE,OAAO,IAAI,CAAA;IACrF,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC,CAAA"}

package/dist/src/transaction/types.d.ts

@@ -0,0 +1,15 @@
+import type { Either } from '@lokalise/node-core';
+import type * as RuntimePrisma from '@prisma/client/runtime/client';
+import type { DbDriver } from '../types.ts';
+type InternalTransactionOptions = RuntimePrisma.PrismaClientOptions['transactionOptions'];
+export type PrismaTransactionOptions = {
+    dbDriver: DbDriver;
+    retriesAllowed?: number;
+    baseRetryDelayMs?: number;
+    maxRetryDelayMs?: number;
+    maxTimeout?: number;
+} & InternalTransactionOptions;
+export type PrismaTransactionClient<P> = Omit<P, RuntimePrisma.ITXClientDenyList>;
+export type PrismaTransactionFn<T, P> = (prisma: PrismaTransactionClient<P>) => Promise<T>;
+export type PrismaTransactionReturnType<T> = Either<unknown, T | RuntimePrisma.Types.Utils.UnwrapTuple<RuntimePrisma.PrismaPromise<unknown>[]>>;
+export {};

package/dist/src/transaction/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/src/transaction/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/transaction/types.ts"],"names":[],"mappings":""}

package/dist/src/types.d.ts

@@ -0,0 +1,7 @@
+type ObjectValues<T> = T[keyof T];
+export declare const DbDriverEnum: {
+    readonly COCKROACH_DB: "CockroachDb";
+    readonly POSTGRES: "Postgres";
+};
+export type DbDriver = ObjectValues<typeof DbDriverEnum>;
+export {};

package/dist/src/types.js

@@ -0,0 +1,5 @@
+export const DbDriverEnum = {
+    COCKROACH_DB: 'CockroachDb',
+    POSTGRES: 'Postgres',
+};
+//# sourceMappingURL=types.js.map

package/dist/src/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,YAAY,EAAE,aAAa;IAC3B,QAAQ,EAAE,UAAU;CACZ,CAAA"}

package/dist/test/db-client/client.d.ts

@@ -0,0 +1,31 @@
+import * as runtime from "@prisma/client/runtime/client";
+import * as $Class from "./internal/class.ts";
+import * as Prisma from "./internal/prismaNamespace.ts";
+export * as $Enums from './enums.ts';
+export * from "./enums.ts";
+/**
+ * ## Prisma Client
+ *
+ * Type-safe database client for TypeScript
+ * @example
+ * ```
+ * const prisma = new PrismaClient()
+ * // Fetch zero or more Item1s
+ * const item1s = await prisma.item1.findMany()
+ * ```
+ *
+ * Read more in our [docs](https://pris.ly/d/client).
+ */
+export declare const PrismaClient: $Class.PrismaClientConstructor;
+export type PrismaClient<LogOpts extends Prisma.LogLevel = never, OmitOpts extends Prisma.PrismaClientOptions["omit"] = Prisma.PrismaClientOptions["omit"], ExtArgs extends runtime.Types.Extensions.InternalArgs = runtime.Types.Extensions.DefaultArgs> = $Class.PrismaClient<LogOpts, OmitOpts, ExtArgs>;
+export { Prisma };
+/**
+ * Model Item1
+ *
+ */
+export type Item1 = Prisma.Item1Model;
+/**
+ * Model Item2
+ *
+ */
+export type Item2 = Prisma.Item2Model;

package/dist/test/db-client/client.js

@@ -0,0 +1,36 @@
+/* !!! This is code generated by Prisma. Do not edit directly. !!! */
+/* eslint-disable */
+// biome-ignore-all lint: generated file
+// @ts-nocheck 
+/*
+ * This file should be your main import to use Prisma. Through it you get access to all the models, enums, and input types.
+ * If you're looking for something you can import in the client-side of your application, please refer to the `browser.ts` file instead.
+ *
+ * 🟢 You can import this file directly.
+ */
+import * as process from 'node:process';
+import * as path from 'node:path';
+import { fileURLToPath } from 'node:url';
+globalThis['__dirname'] = path.dirname(fileURLToPath(import.meta.url));
+import * as runtime from "@prisma/client/runtime/client";
+import * as $Enums from "./enums.js";
+import * as $Class from "./internal/class.js";
+import * as Prisma from "./internal/prismaNamespace.js";
+export * as $Enums from "./enums.js";
+export * from "./enums.js";
+/**
+ * ## Prisma Client
+ *
+ * Type-safe database client for TypeScript
+ * @example
+ * ```
+ * const prisma = new PrismaClient()
+ * // Fetch zero or more Item1s
+ * const item1s = await prisma.item1.findMany()
+ * ```
+ *
+ * Read more in our [docs](https://pris.ly/d/client).
+ */
+export const PrismaClient = $Class.getPrismaClientClass();
+export { Prisma };
+//# sourceMappingURL=client.js.map

package/dist/test/db-client/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../test/db-client/client.ts"],"names":[],"mappings":"AACA,qEAAqE;AACrE,oBAAoB;AACpB,wCAAwC;AACxC,eAAe;AACf;;;;;GAKG;AAEH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AACvC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AACjC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AACxC,UAAU,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;AAEtE,OAAO,KAAK,OAAO,MAAM,+BAA+B,CAAA;AACxD,OAAO,KAAK,MAAM,MAAM,YAAY,CAAA;AACpC,OAAO,KAAK,MAAM,MAAM,qBAAqB,CAAA;AAC7C,OAAO,KAAK,MAAM,MAAM,+BAA+B,CAAA;AAEvD,OAAO,KAAK,MAAM,MAAM,YAAY,CAAA;AACpC,cAAc,YAAY,CAAA;AAC1B;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,MAAM,CAAC,oBAAoB,EAAE,CAAA;AAEzD,OAAO,EAAE,MAAM,EAAE,CAAA"}