prisma-mock 1.1.0-alpha.0 → 1.1.0-alpha.2

package/README.md

@@ -14,9 +14,30 @@ yarn add prisma-mock --dev
 
 ## Usage
 
-### Basic Example
+### Prisma 7
 
-Simple example of how to create a prisma mock instance:
+With Prisma 7, you typically generate your client to a custom output directory (such as `./generated/client`), and import the generated `Prisma` namespace from your generated files. Use the `prisma-mock/client` entry point and pass the `Prisma` namespace when
+initializing your mock client.
+
+> **Note:** You will also need to configure and use the [DMMF Generator](#dmmf-generator) to produce the necessary metadata for mocking.
+
+```js
+import createPrismaMock from "prisma-mock/client"
+import { Prisma } from "./generated/client"
+import * as dmmf from "./generated/dmmf"
+
+let client
+
+beforeEach(() => {
+  client = createPrismaMock(Prisma, {
+    datamodel: dmmf,
+  })
+})
+```
+
+### Prisma 6 and below
+
+Simple example of how to create a prisma mock instance using the default (node_module) export:
 
 ```js
 import createPrismaMock from "prisma-mock"
@@ -97,7 +118,11 @@ createPrismaMock<P extends PrismaClient = PrismaClient>(
     caseInsensitive?: boolean
     enableIndexes?: boolean
   }
-): P & { $getInternalState: () => Required<PrismaMockData<P>> }
+): P & { 
+  $getInternalState: () => Required<PrismaMockData<P>>
+  $setInternalState: (state: Required<PrismaMockData<P>>) => void
+  $clear: () => void
+}
 ```
 
 ### Parameters
@@ -117,6 +142,8 @@ createPrismaMock<P extends PrismaClient = PrismaClient>(
 Returns a mock Prisma client with all standard model methods plus:
 
 - `$getInternalState()`: Method to access the internal data state for testing/debugging
+- `$setInternalState(state)`: Method to replace the entire internal data state. Useful for resetting state to a specific snapshot or setting up complex test scenarios. The state is deep copied to avoid reference issues.
+- `$clear()`: Method to reset the internal state back to the initial state
 
 ### Client Export (`prisma-mock/client`)
 
@@ -130,7 +157,11 @@ createPrismaMock<PClient extends PrismaClient, P extends typeof Prisma = typeof
     caseInsensitive?: boolean
     enableIndexes?: boolean
   }
-): PClient & { $getInternalState: () => Required<PrismaMockData<PClient>> }
+): PClient & { 
+  $getInternalState: () => Required<PrismaMockData<PClient>>
+  $setInternalState: (state: Required<PrismaMockData<PClient>>) => void
+  $clear: () => void
+}
 ```
 
 #### Parameters

package/lib/client.d.ts

@@ -2,5 +2,7 @@ import type { Prisma, PrismaClient } from "@prisma/client";
 import { MockPrismaOptions, PrismaMockData } from "./types";
 declare function createPrismaMock<PClient extends PrismaClient, P extends typeof Prisma = typeof Prisma>(prisma: P, options?: MockPrismaOptions<PClient, P>): PClient & {
     $getInternalState: () => Required<PrismaMockData<PClient>>;
+    $setInternalState: (state: Required<PrismaMockData<PClient>>) => void;
+    $clear: () => void;
 };
 export default createPrismaMock;

package/lib/client.js

@@ -22,9 +22,10 @@ function createPrismaMock(prisma, options = {
     enableIndexes: true,
     data: {}
 }) {
+    let internalState = options.data ? (0, deepCopy_1.deepCopy)(options.data) : {};
     // Reference object to hold the mock data state
     let ref = {
-        data: options.data ? (0, deepCopy_1.deepCopy)(options.data) : {},
+        data: internalState,
     };
     // Initialize the mock client (either use provided one or create new)
     let client = options.mockClient ? options.mockClient : {};
@@ -126,8 +127,12 @@ function createPrismaMock(prisma, options = {
     });
     // Add method to access internal state for testing/debugging
     client['$getInternalState'] = () => ref.data;
+    client['$setInternalState'] = (state) => {
+        internalState = (0, deepCopy_1.deepCopy)(state);
+        ref.data = internalState;
+    };
     client['$clear'] = () => {
-        ref.data = options.data ? (0, deepCopy_1.deepCopy)(options.data) : {};
+        ref.data = internalState;
     };
     // @ts-ignore
     return client;

package/lib/index.d.ts

@@ -5,5 +5,7 @@ type MockPrismaOptions<P extends PrismaClient = PrismaClient> = Omit<MockPrismaO
 };
 export default function createPrismaClient<P extends PrismaClient = PrismaClient>(options?: MockPrismaOptions<P>): P & {
     $getInternalState: () => Required<Partial<{ [key in import("./types").IsTable<Uncapitalize<import("./types").IsString<keyof P>>>]: import("./types").PrismaList<P, key>; }>>;
+    $setInternalState: (state: Required<Partial<{ [key in import("./types").IsTable<Uncapitalize<import("./types").IsString<keyof P>>>]: import("./types").PrismaList<P, key>; }>>) => void;
+    $clear: () => void;
 };
 export {};

package/lib/legacy.d.ts

@@ -73,4 +73,74 @@ export default function createPrismaClient(data?: PrismaMockData<PrismaClient>,
             id: string;
         }>[];
     }>>;
+    $setInternalState: (state: Required<Partial<{
+        account: Partial<{
+            name: string;
+            id: number;
+            sort: number;
+        }>[];
+        user: Partial<{
+            name: string;
+            id: number;
+            sort: number;
+            accountId: number;
+            role: import(".prisma/client").$Enums.Role;
+            clicks: number;
+            deleted: boolean;
+            uniqueField: string;
+            age: number;
+        }>[];
+        answers: Partial<{
+            id: number;
+            title: string;
+        }>[];
+        element: Partial<{
+            value: string;
+            userId: number;
+            e_id: number;
+            json: Prisma.JsonValue;
+        }>[];
+        stripe: Partial<{
+            id: number;
+            sort: number;
+            accountId: number;
+            customerId: string;
+            active: boolean;
+        }>[];
+        userAnswers: Partial<{
+            value: string;
+            answerId: number;
+            userId: number;
+        }>[];
+        document: Partial<{
+            name: string;
+            id: string;
+        }>[];
+        post: Partial<{
+            id: number;
+            title: string;
+            published: boolean;
+            authorId: number;
+            updated: Date;
+            created: Date;
+        }>[];
+        pet: Partial<{
+            name: string;
+            id: number;
+            ownerId: number;
+        }>[];
+        toy: Partial<{
+            name: string;
+            id: number;
+            ownerId: number;
+        }>[];
+        transaction: Partial<{
+            id: string;
+            initiator: string;
+        }>[];
+        dbGeneratedId: Partial<{
+            id: string;
+        }>[];
+    }>>) => void;
+    $clear: () => void;
 };

package/package.json

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