prisma-kysely 3.0.0 → 3.1.0

package/README.md

@@ -39,12 +39,49 @@ without losing the safety of the TypeScript type system?
        fileName = "types.ts"
        // Optionally generate runtime enums to a separate file
        enumFileName = "enums.ts"
+       // Optionally add content at the start of generated files (imports, pragmas, comments, etc.)
+       banner = "import type { Decimal } from 'decimal.js';"
+       // For multi-line, use Prisma's triple-quoted string syntax (see below)
    }
    ```
 
 3. Run `prisma migrate dev` or `prisma generate` and use your freshly generated
    types when instantiating Kysely!
 
+### Banner Configuration
+
+The `banner` option allows you to add custom content at the start of generated files. This is particularly useful for importing custom types and libraries:
+
+```prisma
+generator kysely {
+    provider = "prisma-kysely"
+    output = "../src/db"
+    fileName = "types.ts"
+
+    // Add custom imports for libraries you need in generated types
+    banner = """
+import type { Decimal } from 'decimal.js';
+import { Big } from 'big.js';
+import * as moment from 'moment';
+import { v4 as uuid } from 'uuid';
+import type { SomeType } from './custom-types';
+"""
+}
+```
+
+This will generate a file that starts with:
+
+```typescript
+import type { Decimal } from "decimal.js";
+import { Big } from "big.js";
+import * as moment from "moment";
+import { v4 as uuid } from "uuid";
+import type { SomeType } from "./custom-types";
+
+import type { ColumnType } from "kysely";
+// ... rest of generated types
+```
+
 ### Motivation
 
 Prisma's migration and schema definition workflow is undeniably great, and the
@@ -81,6 +118,7 @@ hope it's just as useful for you! 😎
 | `enumFileName`           | The filename for the generated enums. Omitting this will generate enums and files in the same file.                                                                                                                                                                                                                                                                                 |            |
 | `camelCase`              | Enable support for Kysely's camelCase plugin                                                                                                                                                                                                                                                                                                                                        | `false`    |
 | `exportWrappedTypes`     | Kysely wrapped types such as `Selectable<Model>` are also exported as described in the [Kysely documentation](https://kysely.dev/docs/getting-started#types). The exported types follow the naming conventions of the document.                                                                                                                                                     | `false`    |
+| `banner`                 | Content to prepend to the start of generated file(s). Useful for custom imports, pragma directives (e.g., `// @ts-nocheck`), comments, or any other content. Supports single-line strings or multi-line via Prisma triple-quoted strings (`""" ... """`). The content is inserted verbatim at the top of the file(s).                                                               |            |
 | `readOnlyIds`            | Use Kysely's `GeneratedAlways` for `@id` fields with default values, preventing insert and update.                                                                                                                                                                                                                                                                                  | `false`    |
 | `[typename]TypeOverride` | Allows you to override the resulting TypeScript type for any Prisma type. Useful when targeting a different environment than Node (e.g. WinterCG compatible runtimes that use UInt8Arrays instead of Buffers for binary types etc.) Check out the [config validator](https://github.com/valtyr/prisma-kysely/blob/main/src/utils/validateConfig.ts) for a complete list of options. |            |
 | `dbTypeName`             | Allows you to override the exported type with all tables                                                                                                                                                                                                                                                                                                                            | `DB`       |

package/dist/generator.js

@@ -23,7 +23,7 @@ import path3 from "node:path";
 // package.json
 var package_default = {
   name: "prisma-kysely",
-  version: "3.0.0",
+  version: "3.1.0",
   description: "Generate Kysely database types from a Prisma schema",
   repository: {
     url: "git+https://github.com/valtyr/prisma-kysely.git"
@@ -87,7 +87,7 @@ var package_default = {
   devDependencies: {
     "@changesets/cli": "^2.29.8",
     "@types/bun": "^1.3.5",
-    "@types/node": "24.10.1",
+    "@types/node": "25.1.0",
     "@types/pg": "^8.16.0",
     "@types/prettier": "3.0.0",
     "@typescript-eslint/eslint-plugin": "^8.52.0",
@@ -260,10 +260,11 @@ import ts7 from "typescript";
 // src/helpers/generateFile.ts
 import ts6 from "typescript";
 var printer = ts6.createPrinter({ newLine: ts6.NewLineKind.LineFeed });
-var generateFile = (statements, { withEnumImport, withLeader, exportWrappedTypes }) => {
+var generateFile = (statements, { withEnumImport, withLeader, exportWrappedTypes, banner }) => {
   const file = ts6.factory.createSourceFile(statements, ts6.factory.createToken(ts6.SyntaxKind.EndOfFileToken), ts6.NodeFlags.None);
   const result = printer.printFile(file);
-  const leader = `import type { ColumnType${result.includes("GeneratedAlways") ? ", GeneratedAlways" : ""}${exportWrappedTypes ? ", Insertable, Selectable, Updateable" : ""} } from "kysely";
+  const leader = `${banner ? `${banner}
+` : ""}import type { ColumnType${result.includes("GeneratedAlways") ? ", GeneratedAlways" : ""}${exportWrappedTypes ? ", Insertable, Selectable, Updateable" : ""} } from "kysely";
 export type Generated<T> = T extends ColumnType<infer S, infer I, infer U>
   ? ColumnType<S, I | undefined, U>
   : ColumnType<T, T | undefined, T>;
@@ -304,7 +305,8 @@ function generateFiles(opts) {
       content: generateFile([...statements, opts.databaseType], {
         withEnumImport: false,
         withLeader: true,
-        exportWrappedTypes: opts.exportWrappedTypes
+        exportWrappedTypes: opts.exportWrappedTypes,
+        banner: opts.banner
       })
     };
     return [typesFileWithEnums];
@@ -317,7 +319,8 @@ function generateFiles(opts) {
         names: opts.enumNames
       },
       withLeader: true,
-      exportWrappedTypes: opts.exportWrappedTypes
+      exportWrappedTypes: opts.exportWrappedTypes,
+      banner: opts.banner
     })
   };
   if (opts.enums.length === 0)
@@ -327,7 +330,8 @@ function generateFiles(opts) {
     content: generateFile(opts.enums.flatMap((e) => [e.objectDeclaration, e.typeDeclaration]), {
       withEnumImport: false,
       withLeader: false,
-      exportWrappedTypes: opts.exportWrappedTypes
+      exportWrappedTypes: opts.exportWrappedTypes,
+      banner: opts.banner
     })
   };
   return [typesFileWithoutEnums, enumFile];
@@ -749,7 +753,8 @@ var configValidator = z.object({
   groupBySchema: booleanStringLiteral.default(false),
   defaultSchema: z.string().default("public"),
   filterBySchema: z.array(z.string()).optional(),
-  exportWrappedTypes: booleanStringLiteral.default(false)
+  exportWrappedTypes: booleanStringLiteral.default(false),
+  banner: z.string().optional()
 }).strict().transform((config) => {
   if (!config.enumFileName) {
     config.enumFileName = config.fileName;
@@ -862,7 +867,8 @@ generatorHandler({
       groupBySchema: config.groupBySchema,
       defaultSchema: config.defaultSchema,
       importExtension: config.importExtension,
-      exportWrappedTypes: config.exportWrappedTypes
+      exportWrappedTypes: config.exportWrappedTypes,
+      banner: config.banner
     });
     await Promise.allSettled(files.map(({ filepath, content }) => {
       const writeLocation = path3.join(options.generator.output?.value || "", filepath);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prisma-kysely",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "Generate Kysely database types from a Prisma schema",
   "repository": {
     "url": "git+https://github.com/valtyr/prisma-kysely.git"
@@ -64,7 +64,7 @@
   "devDependencies": {
     "@changesets/cli": "^2.29.8",
     "@types/bun": "^1.3.5",
-    "@types/node": "24.10.1",
+    "@types/node": "25.1.0",
     "@types/pg": "^8.16.0",
     "@types/prettier": "3.0.0",
     "@typescript-eslint/eslint-plugin": "^8.52.0",