prisma-nestjs-graphql 21.0.1 → 21.1.0

package/README.md

@@ -361,6 +361,28 @@ export class BigIntFilter {
 
 It will affect all inputs and outputs types (including models).
 
+#### `customImport`
+
+Allow to declare custom import statements. (Only works with emitSingle = true)
+
+```sh
+generator nestgraphql {
+    decorate_{key}_from = "module specifier"
+    decorate_{key}_name = "import name"
+    decorate_{key}_defaultImport = "default import name" | true
+    decorate_{key}_namespaceImport = "namespace import name"
+    decorate_{key}_namedImport = "import name" | true
+}
+```
+
+Where `{key}` any identifier to group values (written in [flatten](https://github.com/hughsk/flat) style)
+
+- `decorate_{key}_from` - module specifier to import from (e.g `class-validator`)
+- `decorate_{key}_name` - import name or name with namespace
+- `decorate_{key}_defaultImport` - import as default
+- `decorate_{key}_namespaceImport` - use this name as import namespace
+- `decorate_{key}_namedImport` - named import (without namespace)
+
 ## Documentation and field options
 
 Comments with triple slash will projected to typescript code comments
@@ -736,30 +758,35 @@ import { generate } from 'prisma-nestjs-graphql/generate';
 
 ## Similar Projects
 
-- https://github.com/jasonraimondi/prisma-generator-nestjs-graphql
-- https://github.com/omar-dulaimi/prisma-class-validator-generator
-- https://github.com/kimjbstar/prisma-class-generator
-- https://github.com/odroe/nest-gql-mix
-- https://github.com/rfermann/nestjs-prisma-graphql-generator
-- https://github.com/madscience/graphql-codegen-nestjs
-- https://github.com/wSedlacek/prisma-generators/tree/master/libs/nestjs
-- https://github.com/EndyKaufman/typegraphql-prisma-nestjs
-- https://github.com/MichalLytek/typegraphql-prisma
-- https://github.com/mk668a/nestjs-prisma-graphql-crud-gen
+- <https://github.com/jasonraimondi/prisma-generator-nestjs-graphql>
+- <https://github.com/omar-dulaimi/prisma-class-validator-generator>
+- <https://github.com/kimjbstar/prisma-class-generator>
+- <https://github.com/odroe/nest-gql-mix>
+- <https://github.com/rfermann/nestjs-prisma-graphql-generator>
+- <https://github.com/madscience/graphql-codegen-nestjs>
+- <https://github.com/wSedlacek/prisma-generators/tree/master/libs/nestjs>
+- <https://github.com/EndyKaufman/typegraphql-prisma-nestjs>
+- <https://github.com/MichalLytek/typegraphql-prisma>
+- <https://github.com/mk668a/nestjs-prisma-graphql-crud-gen>
 
 ## Resources
 
-- Todo - https://github.com/unlight/prisma-nestjs-graphql/issues/2
-- https://github.com/prisma/prisma/blob/main/packages/client/src/generation/TSClient/TSClient.ts
-- https://ts-ast-viewer.com/
-- https://github.com/unlight/nestjs-graphql-prisma-realworld-example-app
-- https://www.prisma.io/docs/reference/tools-and-interfaces/prisma-schema/data-model
-- JSON type for the code first approach - https://github.com/nestjs/graphql/issues/111#issuecomment-631452899
-- https://github.com/paljs/prisma-tools/tree/master/packages/plugins
-- https://github.com/wasp-lang/wasp
+- Todo - <https://github.com/unlight/prisma-nestjs-graphql/issues/2>
+- <https://github.com/prisma/prisma/blob/main/packages/client/src/generation/TSClient/TSClient.ts>
+- <https://ts-ast-viewer.com/>
+- <https://github.com/unlight/nestjs-graphql-prisma-realworld-example-app>
+- <https://www.prisma.io/docs/reference/tools-and-interfaces/prisma-schema/data-model>
+- JSON type for the code first approach - <https://github.com/nestjs/graphql/issues/111#issuecomment-631452899>
+- <https://github.com/paljs/prisma-tools/tree/master/packages/plugins>
+- <https://github.com/wasp-lang/wasp>
 
 ## TODO
 
 - keyof typeof SortOrder -> `SortOrder`
 - dummy-createfriends.input.ts -> `create-friends`
 - check 'TODO FIXME'
+- 22.12 node require esm (update all deps to latest)
+
+## License
+
+[MIT License](https://opensource.org/licenses/MIT) (c) 2025

package/generate.cjs

@@ -281,7 +281,7 @@ class ImportDeclarationMap extends Map {
 }
 
 async function generateFiles(args) {
-  const { project, config, output, eventEmitter } = args;
+  const { config, eventEmitter, output, project } = args;
   if (config.emitSingle) {
     const rootDirectory = project.getDirectory(output) || project.createDirectory(output);
     const sourceFile = rootDirectory.getSourceFile("index.ts") || rootDirectory.createSourceFile("index.ts", undefined, { overwrite: true });
@@ -332,9 +332,9 @@ async function generateFiles(args) {
           }
           if (statement.defaultImport) {
             imports.create({
+              defaultImport: statement.defaultImport,
               from: statement.moduleSpecifier,
-              name: statement.defaultImport,
-              defaultImport: statement.defaultImport
+              name: statement.defaultImport
             });
           }
           if (statement.namespaceImport) {
@@ -356,6 +356,9 @@ async function generateFiles(args) {
         }
       }
     }
+    for (const customImport of config.customImport) {
+      imports.create(customImport);
+    }
     sourceFile.set({
       kind: tsMorph.StructureKind.SourceFile,
       statements: [...imports.toStatements(), ...enums, ...classes]
@@ -365,9 +368,9 @@ async function generateFiles(args) {
     project.compilerOptions.set({
       declaration: true,
       declarationDir: output,
-      rootDir: output,
-      outDir: output,
       emitDecoratorMetadata: false,
+      outDir: output,
+      rootDir: output,
       skipLibCheck: true
     });
     const emitResult = await project.emit();
@@ -416,12 +419,12 @@ function getGraphqlImport(args) {
   const {
     config,
     fileType,
-    location,
-    typeName,
+    getSourceFile,
     isId,
+    location,
     noTypeId,
     sourceFile,
-    getSourceFile
+    typeName
   } = args;
   if (location === "scalar") {
     if (isId && !noTypeId) {
@@ -462,8 +465,8 @@ function getGraphqlImport(args) {
   const specifier = relativePath(
     sourceFile.getFilePath(),
     getSourceFile({
-      type: sourceFileType,
-      name: typeName
+      name: typeName,
+      type: sourceFileType
     }).getFilePath()
   );
   return { name: typeName, specifier };
@@ -564,7 +567,8 @@ function getPropertyType(args) {
     return [type];
   }
   if (location === "enumTypes") {
-    return [`keyof typeof ${type}`];
+    const enumType = "`${" + type + "}`";
+    return [enumType];
   }
   if (location === "scalar") {
     return [type];
@@ -1360,9 +1364,13 @@ function isListInput(typeName, model, field) {
   return typeName === `${model}Create${field}Input` || typeName === `${model}Update${field}Input`;
 }
 
+function getEnumName(referenceName) {
+  return referenceName.slice(3, -2);
+}
+
 const nestjsGraphql = "@nestjs/graphql";
 function outputType(outputType2, args) {
-  const { getSourceFile, models, eventEmitter, fieldSettings, getModelName, config } = args;
+  const { config, eventEmitter, fieldSettings, getModelName, getSourceFile, models } = args;
   const importDeclarations = new ImportDeclarationMap();
   const fileType = "output";
   const modelName = getModelName(outputType2.name) || "";
@@ -1379,21 +1387,21 @@ function outputType(outputType2, args) {
     type: fileType
   });
   const classStructure = {
-    kind: tsMorph.StructureKind.Class,
-    isExported: true,
-    name: outputType2.name,
     decorators: [
       {
-        name: "ObjectType",
-        arguments: []
+        arguments: [],
+        name: "ObjectType"
       }
     ],
+    isExported: true,
+    kind: tsMorph.StructureKind.Class,
+    name: outputType2.name,
     properties: []
   };
   importDeclarations.add("Field", nestjsGraphql);
   importDeclarations.add("ObjectType", nestjsGraphql);
   for (const field of outputType2.fields) {
-    const { location, isList, type } = field.outputType;
+    const { isList, location, type } = field.outputType;
     const outputTypeName = getOutputTypeName(String(type));
     const settings = isCountOutput ? undefined : model && fieldSettings.get(model.name)?.get(field.name);
     const propertySettings = settings?.getPropertyType({
@@ -1409,11 +1417,11 @@ function outputType(outputType2, args) {
       })
     );
     const property = propertyStructure({
-      name: field.name,
-      isNullable: field.isNullable,
       hasQuestionToken: isCountOutput ? true : undefined,
-      propertyType,
-      isList
+      isList,
+      isNullable: field.isNullable,
+      name: field.name,
+      propertyType
     });
     classStructure.properties?.push(property);
     if (propertySettings) {
@@ -1438,46 +1446,43 @@ function outputType(outputType2, args) {
     } else {
       const graphqlImport = getGraphqlImport({
         config,
-        sourceFile,
         fileType,
-        location,
+        getSourceFile,
         isId: false,
-        typeName: outputTypeName,
-        getSourceFile
+        location,
+        sourceFile,
+        typeName: outputTypeName
       });
+      const referenceName = location === "enumTypes" ? getEnumName(propertyType[0]) : propertyType[0];
       graphqlType = graphqlImport.name;
-      let referenceName = propertyType[0];
-      if (location === "enumTypes") {
-        referenceName = lodash.last(referenceName.split(" "));
-      }
       if (graphqlImport.specifier && !importDeclarations.has(graphqlImport.name) && (graphqlImport.name !== outputType2.name && !shouldHideField || shouldHideField && referenceName === graphqlImport.name)) {
         importDeclarations.set(graphqlImport.name, {
-          namedImports: [{ name: graphqlImport.name }],
-          moduleSpecifier: graphqlImport.specifier
+          moduleSpecifier: graphqlImport.specifier,
+          namedImports: [{ name: graphqlImport.name }]
         });
       }
     }
     assert.ok(property.decorators, "property.decorators is undefined");
     if (shouldHideField) {
       importDeclarations.add("HideField", nestjsGraphql);
-      property.decorators.push({ name: "HideField", arguments: [] });
+      property.decorators.push({ arguments: [], name: "HideField" });
     } else {
       property.decorators.push({
-        name: "Field",
         arguments: [
           isList ? `() => [${graphqlType}]` : `() => ${graphqlType}`,
           JSON5.stringify({
             ...settings?.fieldArguments(),
             nullable: Boolean(field.isNullable)
           })
-        ]
+        ],
+        name: "Field"
       });
       if (isCustomsApplicable) {
         for (const options of settings || []) {
           if ((options.kind === "Decorator" && options.output && options.match?.(field.name)) ?? true) {
             property.decorators.push({
-              name: options.name,
-              arguments: options.arguments
+              arguments: options.arguments,
+              name: options.name
             });
             assert.ok(options.from, "Missed 'from' part in configuration or field setting");
             importDeclarations.create(options);
@@ -1486,8 +1491,8 @@ function outputType(outputType2, args) {
       }
     }
     eventEmitter.emitSync("ClassProperty", property, {
-      location,
       isList,
+      location,
       propertyType
     });
   }
@@ -1756,6 +1761,24 @@ function createConfig(data) {
       arguments: element.arguments ? JSON5.parse(element.arguments) : undefined
     });
   }
+  const customImport = [];
+  const configCustomImport = Object.values(
+    config.customImport || {}
+  );
+  for (const element of configCustomImport) {
+    if (!element) continue;
+    assert.ok(
+      element.from && element.name,
+      `Missed 'from' or 'name' part in configuration for customImport`
+    );
+    customImport.push({
+      from: element.from,
+      name: element.name,
+      namedImport: toBoolean(element.namedImport),
+      defaultImport: toBoolean(element.defaultImport) ? true : element.defaultImport,
+      namespaceImport: element.namespaceImport
+    });
+  }
   return {
     outputFilePattern,
     tsConfigFilePath: createTsConfigFilePathValue(config.tsConfigFilePath),
@@ -1779,7 +1802,8 @@ function createConfig(data) {
       config.unsafeCompatibleWhereUniqueInput
     ),
     graphqlScalars: config.graphqlScalars || {},
-    decorate
+    decorate,
+    customImport
   };
 }
 const tsConfigFileExists = lodash.memoize((filePath) => {
@@ -1819,9 +1843,8 @@ function toBoolean(value) {
 }
 
 function generateFileName(args) {
-  const { template, type, name, getModelName } = args;
+  const { getModelName, name, template, type } = args;
   return pupa(template, {
-    type,
     get model() {
       const result = getModelName(name) || "prisma";
       return lodash.kebabCase(result);
@@ -1840,7 +1863,8 @@ function generateFileName(args) {
       get type() {
         return pluralize(type);
       }
-    }
+    },
+    type
   });
 }
 
@@ -1983,7 +2007,7 @@ const middleKeywords = [
 
 const AwaitEventEmitter = require$1("await-event-emitter").default;
 async function generate(args) {
-  const { connectCallback, generator, skipAddOutputSourceFiles, dmmf } = args;
+  const { connectCallback, dmmf, generator, skipAddOutputSourceFiles } = args;
   const generatorOutputValue = generator.output?.value;
   assert.ok(generatorOutputValue, "Missing generator configuration: output");
   const config = createConfig(generator.config);
@@ -2005,12 +2029,12 @@ async function generate(args) {
     eventEmitter.emitSync("Warning", message);
   }
   const project = new tsMorph.Project({
-    tsConfigFilePath: config.tsConfigFilePath,
-    skipAddingFilesFromTsConfig: true,
-    skipLoadingLibFiles: !config.emitCompiled,
     manipulationSettings: {
       quoteKind: tsMorph.QuoteKind.Single
-    }
+    },
+    skipAddingFilesFromTsConfig: true,
+    skipLoadingLibFiles: !config.emitCompiled,
+    tsConfigFilePath: config.tsConfigFilePath
   });
   if (!skipAddOutputSourceFiles) {
     project.addSourceFilesAtPaths([
@@ -2030,30 +2054,30 @@ async function generate(args) {
   const fieldSettings = /* @__PURE__ */ new Map();
   const getModelName = createGetModelName(modelNames);
   const getSourceFile = factoryGetSourceFile({
-    output: generatorOutputValue,
-    project,
+    eventEmitter,
     getModelName,
+    output: generatorOutputValue,
     outputFilePattern: config.outputFilePattern,
-    eventEmitter
+    project
   });
   const { datamodel, schema } = JSON.parse(JSON.stringify(dmmf));
   const removeTypes = /* @__PURE__ */ new Set();
   const eventArguments = {
-    schema,
-    models,
+    classTransformerTypeModels: /* @__PURE__ */ new Set(),
     config,
-    modelNames,
-    modelFields,
-    fieldSettings,
-    project,
-    output: generatorOutputValue,
-    getSourceFile,
-    eventEmitter,
-    typeNames: /* @__PURE__ */ new Set(),
     enums: lodash.mapKeys(datamodel.enums, (x) => x.name),
+    eventEmitter,
+    fieldSettings,
     getModelName,
+    getSourceFile,
+    modelFields,
+    modelNames,
+    models,
+    output: generatorOutputValue,
+    project,
     removeTypes,
-    classTransformerTypeModels: /* @__PURE__ */ new Set()
+    schema,
+    typeNames: /* @__PURE__ */ new Set()
   };
   if (connectCallback) {
     await connectCallback(eventEmitter, eventArguments);
@@ -2065,7 +2089,7 @@ async function generate(args) {
   for (const model of datamodel.types || []) {
     await eventEmitter.emit("Model", model, eventArguments);
   }
-  const { inputObjectTypes, outputObjectTypes, enumTypes } = schema;
+  const { enumTypes, inputObjectTypes, outputObjectTypes } = schema;
   await eventEmitter.emit("PostBegin", eventArguments);
   for (const enumType of enumTypes.prisma.concat(enumTypes.model || [])) {
     await eventEmitter.emit("EnumType", enumType, eventArguments);
@@ -2085,9 +2109,9 @@ async function generate(args) {
   for (const inputType2 of inputTypes) {
     const event = {
       ...eventArguments,
-      inputType: inputType2,
+      classDecoratorName: "InputType",
       fileType: "input",
-      classDecoratorName: "InputType"
+      inputType: inputType2
     };
     if (inputType2.fields.length === 0) {
       removeTypes.add(inputType2.name);

package/generate.d.ts

@@ -385,6 +385,13 @@ type DecorateElement = {
     defaultImport?: string | true;
     namespaceImport?: string;
 };
+type CustomImport = {
+    from: string;
+    name: string;
+    namedImport: boolean;
+    defaultImport?: string | true;
+    namespaceImport?: string;
+};
 declare function createConfig(data: Record<string, unknown>): {
     outputFilePattern: string;
     tsConfigFilePath: string | undefined;
@@ -405,6 +412,7 @@ declare function createConfig(data: Record<string, unknown>): {
     unsafeCompatibleWhereUniqueInput: boolean;
     graphqlScalars: Record<string, ImportNameSpec | undefined>;
     decorate: DecorateElement[];
+    customImport: CustomImport[];
 };
 type ConfigInputItem = {
     typeName: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prisma-nestjs-graphql",
-  "version": "21.0.1",
+  "version": "21.1.0",
   "license": "MIT",
   "description": "Generate object types, inputs, args, etc. from prisma schema file for usage with @nestjs/graphql module",
   "bin": "bin.js",

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2023
-
-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.