prisma-extension-kysely 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Eoin O'Brien
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,107 @@
+# Prisma Kysely Extension
+
+[![npm version](https://badge.fury.io/js/prisma-extension-kysely.svg)](https://badge.fury.io/js/prisma-extension-kysely)
+[![npm downloads](https://img.shields.io/npm/dm/prisma-extension-kysely.svg)](https://www.npmjs.com/package/prisma-extension-kysely)
+[![GitHub license](https://img.shields.io/github/license/oslabs-beta/prisma-extension-kysely.svg)](https://www.npmjs.com/package/prisma-extension-kysely)
+[![Node.js CI](https://github.com/eoin-obrien/prisma-extension-kysely/actions/workflows/node.js.yml/badge.svg)](https://github.com/eoin-obrien/prisma-extension-kysely/actions/workflows/node.js.yml)
+[![Node.js Package (GitHub)](https://github.com/eoin-obrien/prisma-extension-kysely/actions/workflows/npm-publish-github-packages.yml/badge.svg)](https://github.com/eoin-obrien/prisma-extension-kysely/actions/workflows/npm-publish-github-packages.yml)
+[![Node.js Package (npm)](https://github.com/eoin-obrien/prisma-extension-kysely/actions/workflows/npm-publish.yml/badge.svg)](https://github.com/eoin-obrien/prisma-extension-kysely/actions/workflows/npm-publish.yml)
+
+Writing and maintaining raw SQL queries for Prisma can be a tedious and error-prone task. The moment you need to write a query that is not supported out-of-the-box by Prisma, you lose all of that type-safety and autocompletion. This is where `prisma-extension-kysely` comes in! It allowa you to easily write raw SQL queries in a type-safe manner with [`kysely`](https://kysely.dev/) and integrate them seamlessly with Prisma.
+
+## Features
+
+- **Type-safe** — Write raw SQL queries in a type-safe manner with `kysely`
+- **Seamless integration** — Use `kysely` queries with Prisma as if they were native
+- **Autocompletion** — Get autocompletion for your queries in your IDE
+- **Type inference** — Get type inference for your queries in your IDE
+
+## Get started
+
+Click the **Use this template** button and provide details for your Client extension
+
+Install the dependencies:
+
+```shell
+npm install prisma-extension-kysely kysely
+```
+
+Set up the excellent [`prisma-kysely`](https://www.npmjs.com/package/prisma-kysely) library to automatically generate types for your database:
+
+```shell
+npm install -D prisma-kysely
+```
+
+Add `prisma-kysely` as a generator to your `schema.prisma`:
+
+```prisma
+generator kysely {
+  provider = "prisma-kysely"
+}
+```
+
+Generate the types:
+
+```shell
+npx prisma generate
+```
+
+Extend your Prisma Client:
+
+```typescript
+import kyselyExtension from "prisma-extension-kysely";
+import type { DB } from "./prisma/generated/types";
+
+// Don't forget to customize this to match your database!
+const kysely = new Kysely<DB>({
+  dialect: {
+    createAdapter: () => new PostgresAdapter(),
+    createDriver: () => new DummyDriver(),
+    createIntrospector: (db) => new PostgresIntrospector(db),
+    createQueryCompiler: () => new PostgresQueryCompiler(),
+  },
+});
+
+const prisma = new PrismaClient().$extends(kyselyExtension({ kysely }));
+```
+
+It's that simple! Now you can write raw SQL queries with `kysely` and use them with Prisma:
+
+```typescript
+// Replace this...
+const result = prisma.$queryRaw`SELECT * FROM User WHERE id = ${id}`;
+
+// With this!
+const query = prisma.$kysely
+  .selectFrom("User")
+  .selectAll()
+  .where("id", "=", id);
+
+// Thanks to kysely's magic, everything is type-safe!
+const result = await prisma.$kyselyQuery(query);
+
+// You can also execute queries without fetching the results
+await prisma.$kyselyExecute(
+  prisma.$kysely.deleteFrom("User").where("id", "=", id),
+);
+```
+
+## Examples
+
+Check out the [example](example) directory for a sample project!
+
+```shell
+cd examples
+npm install
+npx prisma db push
+npm run dev
+```
+
+## Learn more
+
+- [Kysely](https://kysely.dev/)
+- [`prisma-kysely`](https://www.npmjs.com/package/prisma-kysely)
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

package/dist/index.d.ts

@@ -0,0 +1,34 @@
+import type { PrismaPromise } from "@prisma/client/runtime/library";
+import type { Compilable, Kysely, Simplify } from "kysely";
+/**
+ * The configuration object for the Prisma Kysely extension
+ */
+export type PrismaKyselyExtensionArgs<Database> = {
+    /**
+     * The Kysely instance to provide to the Prisma client
+     */
+    kysely: Kysely<Database>;
+};
+/**
+ * Define a Prisma extension that adds Kysely query builder methods to the Prisma client
+ * @param extensionArgs The extension configuration object
+ */
+declare const _default: <Database>(extensionArgs: PrismaKyselyExtensionArgs<Database>) => (client: any) => import("@prisma/client/extension").PrismaClientExtends<import("@prisma/client/runtime/library").InternalArgs<{}, {}, {}, {
+    /**
+     * The Kysely instance used by the Prisma client
+     */
+    $kysely: Kysely<Database>;
+    /**
+     * Execute a Kysely query and return the result
+     * @param query A Kysely select, insert, delete or update query builder
+     * @returns The result of the query
+     */
+    $kyselyQuery<T>(query: Compilable<T>): Promise<import("kysely/dist/cjs/util/type-utils").DrainOuterGeneric<{ [K in keyof T]: T[K]; }>[]>;
+    /**
+     * Execute a Kysely query and return the number of rows affected
+     * @param query A Kysely select, insert, delete or update query builder
+     * @returns The number of rows affected
+     */
+    $kyselyExecute(query: Compilable): PrismaPromise<number>;
+}> & import("@prisma/client/runtime/library").DefaultArgs>;
+export default _default;

package/dist/index.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const extension_1 = require("@prisma/client/extension");
+/**
+ * Define a Prisma extension that adds Kysely query builder methods to the Prisma client
+ * @param extensionArgs The extension configuration object
+ */
+exports.default = (extensionArgs) => extension_1.Prisma.defineExtension((client) => {
+    return client.$extends({
+        name: "prisma-extension-kysely",
+        client: {
+            /**
+             * The Kysely instance used by the Prisma client
+             */
+            $kysely: extensionArgs.kysely,
+            /**
+             * Execute a Kysely query and return the result
+             * @param query A Kysely select, insert, delete or update query builder
+             * @returns The result of the query
+             */
+            $kyselyQuery(query) {
+                const { sql, parameters } = query.compile();
+                const ctx = extension_1.Prisma.getExtensionContext(this);
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                return ctx.$queryRawUnsafe(sql, ...parameters);
+            },
+            /**
+             * Execute a Kysely query and return the number of rows affected
+             * @param query A Kysely select, insert, delete or update query builder
+             * @returns The number of rows affected
+             */
+            $kyselyExecute(query) {
+                const { sql, parameters } = query.compile();
+                const ctx = extension_1.Prisma.getExtensionContext(this);
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                return ctx.$executeRawUnsafe(sql, ...parameters);
+            },
+        },
+    });
+});

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "prisma-extension-kysely",
+  "version": "1.0.0",
+  "author": {
+    "name": "Eoin O'Brien",
+    "url": "https://eoin.ai",
+    "email": "eoin@tracworx.ai"
+  },
+  "description": "Prisma extension for Kysely",
+  "keywords": [
+    "prisma",
+    "@prisma/client",
+    "extension",
+    "kysely",
+    "sql",
+    "query builder",
+    "orm",
+    "database",
+    "postgresql",
+    "mysql",
+    "sqlite"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "test": "prisma generate && prisma db push && jest",
+    "build": "tsc",
+    "prepare": "husky install",
+    "commit": "git-cz",
+    "lint": "eslint .",
+    "format": "prettier --write .",
+    "format:check": "prettier --check ."
+  },
+  "config": {
+    "commitizen": {
+      "path": "@commitlint/cz-commitlint"
+    }
+  },
+  "peerDependencies": {
+    "@prisma/client": "latest"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^18.4.3",
+    "@commitlint/config-conventional": "^18.4.3",
+    "@commitlint/cz-commitlint": "^18.4.3",
+    "@prisma/client": "latest",
+    "@types/jest": "^29.5.10",
+    "@typescript-eslint/eslint-plugin": "^6.13.0",
+    "@typescript-eslint/parser": "^6.13.0",
+    "commitizen": "^4.3.0",
+    "eslint": "^8.54.0",
+    "eslint-config-prettier": "^9.0.0",
+    "husky": "^8.0.3",
+    "inquirer": "^8.2.6",
+    "jest": "^29.7.0",
+    "jest-mock-extended": "^3.0.5",
+    "kysely": "^0.26.3",
+    "prettier": "3.1.0",
+    "prisma": "latest",
+    "prisma-kysely": "^1.7.1",
+    "ts-jest": "^29.1.1",
+    "typescript": "^4.9.5"
+  }
+}