@pkgverse/prismock 2.0.0-beta.10 → 2.0.0-beta.12

package/README.md

@@ -1,8 +1,14 @@
 # prismock
 
-[![npm](https://img.shields.io/npm/v/prismock)](https://www.npmjs.com/package/prismock)
-[![Build](https://circleci.com/gh/morintd/prismock.svg?style=shield)](https://app.circleci.com/pipelines/github/morintd/prismock)
-[![npm](https://img.shields.io/npm/dm/prismock)](https://www.npmjs.com/package/prismock)
+[![npm](https://img.shields.io/npm/v/@pkgverse/prismock)](https://www.npmjs.com/package/@pkgverse/prismock)
+[![npm](https://img.shields.io/npm/dm/@pkgverse/prismock)](https://www.npmjs.com/package/prismock)
+
+## NOTE
+Originally forked from https://github.com/morintd/prismock. This library is awesome, and I felt it could use some modernization to work with newer versions of prisma and add support for
+client extensions. My current intention is to try to maintain this and stay up to speed with bug-fixes. The focus is ESM-first, so although both ESM and CJS exports are provided,
+I haven't personally tested the CJS functionality.
+
+---
 
 This is a mock for `PrismaClient`. It actually reads your `schema.prisma` and generate models based on it.
 
@@ -19,43 +25,44 @@ After setting up [Prisma](https://www.prisma.io/docs/getting-started/setup-prism
 yarn
 
 ```sh
-$ yarn add -D prismock
+$ yarn add -D @pkgverse/prismock
 ```
 
 npm
 
 ```
-$ npm add --save-dev prismock
+$ npm add --save-dev @pkgverse/prismock
 ```
 
 # Usage
 
-There are a few options here, depending on your application architecture.
-
-## Automatically (recommended)
-
-You can create a `__mocks__` directory at the root of your project, with a sub-directory named `@prisma`. Inside the `@prisma` directory, create a `client.js` file (or `client.ts` for TypeScript).
-
-Inside the `client` file, you can re-export the `@prisma/client` module, and replace `PrismaClient` by `PrismockClient`:
-
 ```ts
-import { PrismockClient } from 'prismock';
+import { Prisma, PrismaClient } from "${your_prisma_client_directory}"
+import { createPrismockClient } from 'prismock';
+
+// Pass in the Prisma namespace, and manually define the type of your prisma client
+let mockedClient = await createPrismockClient<PrismaClient>(Prisma)
 
-export * from '@prisma/client';
-export { PrismockClient as PrismaClient };
+// Optionally apply your client extensions to the client
+mockedClient = applyExtensions(mockedClient)
 ```
 
-That's it, prisma will be mocked in all your tests (tested with Jest & ViTest)
+That's it, prisma will be mocked in all your tests (tested with ViTest)
 
 ## PrismaClient
 
-You can mock the PrismaClient directly in your test, or setupTests ([Example](https://github.com/morintd/prismock/blob/master/src/__tests__/example-prismock.test.ts)):
+You can mock the PrismaClient directly in your test, or setupTests ([Example](https://github.com/JQuezada0/prismock/blob/beta/src/__tests__/client/example-prismock.test.ts)):
 
 ```ts
-jest.mock('@prisma/client', () => {
+import { vi } from "vitest"
+
+vi.mock('@prisma/client', async () => {
+  const actual = await vi.importActual<typeof import("@prisma/client")>("@prisma/client")
+  const actualPrismock = await vi.importActual<typeof import("prismock")>("prismock")
+
   return {
-    ...jest.requireActual('@prisma/client'),
-    PrismaClient: jest.requireActual('prismock').PrismockClient,
+    ...actual,
+    PrismaClient: await actualPrismock.createPrismockClass(actual.Prisma),
   };
 });
 ```
@@ -65,29 +72,21 @@ jest.mock('@prisma/client', () => {
 You can instantiate a `PrismockClient` directly and use it in your test, or pass it to a test version of your app.
 
 ```ts
-import { PrismockClient } from 'prismock';
+import { Prisma } from '${your_prisma_client_directory}';
+import { createPrismockClient } from 'prismock';
 
-import { PrismaService } from './prisma.service';
-
-const prismock = new PrismockClient();
-const app = createApp(prismock);
+const client = await createPrismockClient(Prisma);
 ```
 
 Then, you will be able to write your tests as if your app was using an in-memory Prisma client.
 
-## Using custom client path
-
-If you are using a custom [client path](https://www.prisma.io/docs/orm/prisma-client/setup-and-configuration/generating-prisma-client#using-a-custom-output-path), you need the [createPrismock](https://github.com/morintd/prismock/blob/master/docs/using-custom-client-path.md) method.
-
 ## Use with decimal.js
 
 See [use with decimal.js](https://github.com/morintd/prismock/blob/master/docs/use-with-decimal-js.md).
 
 ## Internal data
 
-Two additional functions are returned compared to the PrismaClient, `getData`, and `reset`. In some edge-case, we need to directly access, or reset, the data store management by _prismock_.
-
-Most of the time, you won't need it in your test, but keep in mind they exist
+Two additional functions are returned compared to the PrismaClient, `getData`, and `reset`.
 
 ```ts
 const prismock = new PrismockClient();

package/dist/index.d.ts

@@ -1,2 +1,2 @@
 export { generatePrismock, generatePrismockSync } from './lib/prismock';
-export { createPrismock, createPrismockClient, Prismock, type PrismaModule, createPrismockClass } from './lib/client';
+export { createPrismock, createPrismockClient, Prismock, type PrismaModule, createPrismockClass, PrismockClientType } from './lib/client';

package/dist/index.mjs

@@ -5241,11 +5241,17 @@ function generateClient(delegates, getData, setData) {
     }
   };
 }
-async function createPrismockClass(prismaModule) {
-  const { Prisma: Prisma2 } = await import("@prisma/client");
+async function createPrismockClass(prismaModuleInput) {
+  const prismaModule = await (async () => {
+    if (prismaModuleInput) {
+      return prismaModuleInput;
+    }
+    const { Prisma: Prisma2 } = await import("@prisma/client");
+    return Prisma2;
+  })();
   const c = class PrismockClientDefault extends Prismock {
     constructor() {
-      super(Prisma2);
+      super(prismaModule);
     }
   };
   return c;

package/dist/lib/client.d.ts

@@ -33,7 +33,7 @@ export declare function generateClient<T = PrismaClient>(delegates: Record<strin
 export type PrismaModule<PC = PrismaClient> = {
     dmmf: runtime.BaseDMMF;
 };
-export declare function createPrismockClass(prismaModule?: PrismaModule): Promise<typeof PrismaClient>;
+export declare function createPrismockClass<PC extends (new (...args: any[]) => any) = typeof PrismaClient>(prismaModuleInput?: PrismaModule): Promise<typeof PrismaClient>;
 export declare function createPrismock(): Promise<PrismaClient<import(".prisma").Prisma.PrismaClientOptions, never, runtime.DefaultArgs> & PrismockData>;
 export declare function createPrismockClient<PC = PrismaClient>(prismaModule: PrismaModule<PC>): Promise<PrismockClientType<PC>>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pkgverse/prismock",
-  "version": "2.0.0-beta.10",
+  "version": "2.0.0-beta.12",
   "description": "A mock for PrismaClient, dedicated to unit testing.",
   "repository": {
     "url": "https://github.com/JQuezada0/prismock"