prisma-mock 1.0.0-alpha.9 → 1.0.0

package/README.md

@@ -76,34 +76,16 @@ beforeEach(() => {
 })
 ```
 
+## API
+
 ### Exports
 
 The library provides three different exports:
 
 - **`prisma-mock`** (default): The recommended way to use the library. Automatically uses the Prisma client from `@prisma/client/default`, so you don't need to pass Prisma as an argument.
-- **`prisma-mock/client`**: Use this when you need to explicitly pass the Prisma namespace (try the default export first).
+- **`prisma-mock/client`**: Use this when you need to explicitly pass the Prisma namespace.
 - **`prisma-mock/legacy`**: The old API for backward compatibility. This export is deprecated but maintained for existing codebases.
 
-### Legacy Export
-
-The legacy export maintains the old API signature for backward compatibility:
-
-```js
-import createPrismaMock from "prisma-mock/legacy"
-import { mockDeep } from "jest-mock-extended"
-
-const client = createPrismaMock(
-  { user: [{ id: 1, name: "John" }] }, // data
-  Prisma.dmmf.datamodel, // datamodel (optional)
-  mockDeep(), // mockClient (optional)
-  { enableIndexes: true } // options (optional)
-)
-```
-
-**Note**: If you're starting a new project, use the default export instead. The legacy export is only for maintaining existing codebases that haven't migrated yet.
-
-## API
-
 ### Default Export (`prisma-mock`)
 
 ```ts
@@ -118,6 +100,24 @@ createPrismaMock<P extends PrismaClient = PrismaClient>(
 ): P & { $getInternalState: () => Required<PrismaMockData<P>> }
 ```
 
+### Parameters
+
+- **`options`** (optional): Configuration options (see below)
+
+#### Options
+
+- **`data`** (optional): Initial mock data for the Prisma models. An object containing keys for tables and values as arrays of objects.
+- **`datamodel`** (optional): The Prisma datamodel, typically `Prisma.dmmf.datamodel` (default).
+- **`mockClient`** (optional): A `jest-mock-extended` or `vitest-mock-extended` instance. If not provided, a plain object is used instead.
+- **`caseInsensitive`** (boolean, default: `false`): If true, all string comparisons are case insensitive
+- **`enableIndexes`** (boolean, default: `true`) If true, enables indexing for better query performance on primary keys, unique fields, and foreign keys
+
+### Return Value
+
+Returns a mock Prisma client with all standard model methods plus:
+
+- `$getInternalState()`: Method to access the internal data state for testing/debugging
+
 ### Client Export (`prisma-mock/client`)
 
 ```ts
@@ -133,30 +133,28 @@ createPrismaMock<PClient extends PrismaClient, P extends typeof Prisma = typeof
 ): PClient & { $getInternalState: () => Required<PrismaMockData<PClient>> }
 ```
 
-### Parameters
-
-#### Default Export
-
-- **`options`** (optional): Configuration options (see below)
-
-#### Client Export
+#### Parameters
 
 - **`prisma`** (required): The Prisma namespace (e.g., `Prisma` from `@prisma/client`). This is used to access the datamodel and type information.
-- **`options`** (optional): Configuration options (see below)
+- **`options`** (optional): Configuration options. Same as the default export, with the exception of the `datamodel` not being optional.
 
-#### Options
+### Legacy Export (`prisma-mock/legacy`)
 
-- **`data`** (optional): Initial mock data for the Prisma models. An object containing keys for tables and values as arrays of objects.
-- **`datamodel`** (optional): The Prisma datamodel, typically `Prisma.dmmf.datamodel`. Defaults to the Prisma client's datamodel.
-- **`mockClient`** (optional): A `jest-mock-extended` or `vitest-mock-extended` instance. If not provided, a plain object is used instead.
-- **`caseInsensitive`** (boolean, default: `false`): If true, all string comparisons are case insensitive
-- **`enableIndexes`** (boolean, default: `true`) If true, enables indexing for better query performance on primary keys, unique fields, and foreign keys
+The legacy export maintains the old API signature for backward compatibility:
 
-### Return Value
+```js
+import createPrismaMock from "prisma-mock/legacy"
+import { mockDeep } from "jest-mock-extended"
 
-Returns a mock Prisma client with all standard model methods plus:
+const client = createPrismaMock(
+  { user: [{ id: 1, name: "John" }] }, // data
+  Prisma.dmmf.datamodel, // datamodel (optional)
+  mockDeep(), // mockClient (optional)
+  { enableIndexes: true } // options (optional)
+)
+```
 
-- `$getInternalState()`: Method to access the internal data state for testing/debugging
+**Note**: If you're starting a new project, use the default export instead. The legacy export is only for maintaining existing codebases that haven't migrated yet.
 
 ## DMMF Generator
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prisma-mock",
-  "version": "1.0.0-alpha.9",
+  "version": "1.0.0",
   "description": "Mock prisma for unit testing database",
   "main": "lib/index.js",
   "repository": {