feat!: support Prisma client type definitions generated outside of node_modules

Author: SegaraRai

.changeset/old-bushes-hope.md

@@ -0,0 +1,35 @@
+---
+"fraci": minor
+---
+
+**BREAKING CHANGE**: Added support for Prisma client type definitions generated outside of node_modules.
+
+The type definition for `PrismaClient` is no longer imported from `@prisma/client`. As a result, you must provide a type definition when instantiating fraci options or extensions. Please migrate as follows:
+
+```diff
+  import { definePrismaFraci, prismaFraci } from "fraci/prisma";
+  import { PrismaClient } from "./path/to/your/prisma/client"; // Adjust the import path to your Prisma client
+
+  const baseClient = new PrismaClient();
+
+- const definition = definePrismaFraci({
++ const definition = definePrismaFraci(baseClient, {  // or you can use `PrismaClient` instead of `baseClient`
+    // your options here
+  });
+
+  const client = baseClient.$extends(
+-   prismaFraci(definition),
++   prismaFraci(baseClient, definition),  // or you can use `PrismaClient` instead of `baseClient`
+  );
+```
+
+Along with this, the `PrismaClient` type argument was added first to the following related public type definitions:
+
+- `prismaFraci`
+- `definePrismaFraci`
+- `FraciForPrisma`
+- `PrismaFraciExtension`
+- `PrismaFraciFieldOptionsRecord`
+- `PrismaFraciOptions`
+
+Furthermore, we are anticipating future changes to Prisma's architecture and reducing imports from `@prisma/client`. As a result, the `PrismaClientConflictError` type no longer inherits from `PrismaClientKnownRequestError`.

.gitignore

@@ -2,6 +2,8 @@
 
 node_modules
 
+prisma/client
+
 dist
 typedoc
 examples-bundled

CHANGELOG.md

@@ -23,27 +23,23 @@
 
 ### Minor Changes
 
-- 9bc7f1d: Implementated Binary Fractional Indexing.
+- 9bc7f1d: Implemented Binary Fractional Indexing.
 
   Added support for binary-based fractional indices using `Uint8Array` for more efficient storage and operations. This implementation provides:
-
   - Improved performance with optimized binary operations for generating and comparing indices
   - Enhanced memory efficiency for applications handling large numbers of indices
   - Specialized factory functions for creating binary or string-based indices
 
   New Features:
-
   - Added `fraciBinary` and `fraciString` factory functions for creating specialized fractional indexing utilities
   - Added `base` and `brand` properties to `Fraci` for better type safety and runtime information
   - Enhanced validation and error handling for binary fractional indices
 
   Breaking Changes:
-
   - **Template Parameter Signature**: Changed template parameter signature for `fraci`, `Fraci`, and `FractionalIndex` types
   - **Removed Properties**: Removed `digitBase` and `lengthBase` properties from `Fraci`
 
   Added comprehensive type system with clear separation between binary and string-based indices:
-
   - `AnyFractionalIndex`, `AnyBinaryFractionalIndex`, `AnyStringFractionalIndex`
   - `AnyFractionalIndexBase`, `AnyBinaryFractionalIndexBase`, `AnyStringFractionalIndexBase`
   - `AnyFraci`, `AnyBinaryFraci`, `AnyStringFraci`
@@ -65,7 +61,6 @@
 ### Minor Changes
 
 - b0c4151: Enhanced error handling:
-
   - Added "Fraci" prefix to error messages to make it easier to identify the source of the error
   - Added comprehensive "Runtime Errors" section to the documentation with detailed information about each error message
   - Provided clear causes and solutions for each error message to improve troubleshooting experience
@@ -75,20 +70,17 @@
 ### Minor Changes
 
 - 6451d6a: **BREAKING CHANGE**: Renamed base constants for better consistency and clarity:
-
   - `BASE16` -> `BASE16L` (lowercase hex digits)
   - `BASE26` -> `BASE26L` (lowercase alphabets)
   - `BASE36` -> `BASE36L` (lowercase alphanumeric)
   - `BASE64` -> `BASE64URL` (URL-safe Base64 characters)
 
   Added new complementary constants:
-
   - `BASE16U` (uppercase hex digits)
 
   The naming convention now uses `L` suffix for lowercase and `U` suffix for uppercase variants.
 
 - 1ba4bab: **BREAKING CHANGE**: Renamed Prisma integration function and type for better consistency with other database integrations:
-
   - `fraciExtension` -> `prismaFraci` - The main function for creating Prisma extensions
   - `FraciExtensionOptions` ->`PrismaFraciOptions` - The options interface for configuration
 
@@ -169,7 +161,7 @@
 
 ### Minor Changes
 
-- d46c49a: **BREAKING CHANGE** Renamed methods and types.
+- d46c49a: **BREAKING CHANGE**: Renamed methods and types.
 - c0a5d80: Support transaction.
 
 ### Patch Changes
@@ -186,7 +178,7 @@
 
 ### Minor Changes
 
-- 364b106: **BREAKING CHANGE:** Removed result extension.
+- 364b106: **BREAKING CHANGE**: Removed result extension.
 
 ## 0.3.0
 

README.md

@@ -114,13 +114,13 @@ Run `bun run build-examples` to see the bundle sizes for each example.
 
 | Integration              | Total Size (minified)     | Total Size (minified + gzipped) |
 | ------------------------ | ------------------------- | ------------------------------- |
-| **Core only (Binary)**   | 3.49 KiB                  | **1.55 KiB**                    |
-| **Core only (String)**   | 4.85 KiB                  | **2.06 KiB**                    |
-| **Core only (Both)**     | 7.95 KiB                  | **3.02 KiB**                    |
-| **Drizzle ORM (Binary)** | 4.55 KiB (Core +1.06 KiB) | **2.01 KiB** (Core +0.46 KiB)   |
-| **Drizzle ORM (String)** | 5.92 KiB (Core +1.07 KiB) | **2.50 KiB** (Core +0.44 KiB)   |
-| **Drizzle ORM (Both)**   | 8.98 KiB (Core +1.03 KiB) | **3.45 KiB** (Core +0.44 KiB)   |
-| **Prisma ORM (Both)**    | 9.29 KiB (Core +1.35 KiB) | **3.63 KiB** (Core +0.62 KiB)   |
+| **Core only (Binary)**   | 3.50 KiB                  | **1.56 KiB**                    |
+| **Core only (String)**   | 4.86 KiB                  | **2.07 KiB**                    |
+| **Core only (Both)**     | 7.96 KiB                  | **3.02 KiB**                    |
+| **Drizzle ORM (Binary)** | 4.56 KiB (Core +1.06 KiB) | **2.01 KiB** (Core +0.46 KiB)   |
+| **Drizzle ORM (String)** | 5.93 KiB (Core +1.07 KiB) | **2.51 KiB** (Core +0.44 KiB)   |
+| **Drizzle ORM (Both)**   | 8.99 KiB (Core +1.03 KiB) | **3.46 KiB** (Core +0.44 KiB)   |
+| **Prisma ORM (Both)**    | 9.30 KiB (Core +1.35 KiB) | **3.64 KiB** (Core +0.62 KiB)   |
 
 ## Security Considerations
 
@@ -511,12 +511,14 @@ model Article {
 #### 2. Configure the Prisma extension
 
 ```typescript
-import { PrismaClient } from "@prisma/client";
 import { BASE62 } from "fraci";
 import { prismaFraci } from "fraci/prisma";
+import { PrismaClient } from "./path/to/your/prisma/client"; // Adjust the import path as needed
 
 const prisma = new PrismaClient().$extends(
-  prismaFraci({
+  prismaFraci(PrismaClient, {
+    //        ^ Here, you have to pass a PrismaClient constructor or instance to help TypeScript
+    //          infer the types correctly. The passed value is NOT used at runtime.
     fields: {
       // Define the fractional index column (table.column)
       "article.fi": {
@@ -538,11 +540,11 @@ const prisma = new PrismaClient().$extends(
 > To configure the Prisma extension for binary fractional indexing:
 >
 > ```typescript
-> import { PrismaClient } from "@prisma/client";
 > import { prismaFraci } from "fraci/prisma";
+> import { PrismaClient } from "./path/to/your/prisma/client";
 >
 > const prisma = new PrismaClient().$extends(
->   prismaFraci({
+>   prismaFraci(PrismaClient, {
 >     fields: {
 >       // Define the binary fractional index column
 >       "article.fi": {