prisma-nestjs-graphql 15.2.6 → 15.3.0

package/README.md

@@ -4,9 +4,9 @@ Generate object types, inputs, args, etc. from prisma schema file for usage with
 
 ## Features
 
--   Generates only necessary imports
--   Combines zoo of nested/nullable filters
--   Does not generate resolvers, since it's application specific
+- Generates only necessary imports
+- Combines zoo of nested/nullable filters
+- Does not generate resolvers, since it's application specific
 
 ## Install
 
@@ -40,8 +40,8 @@ npm install graphql-type-json prisma-graphql-type-decimal
 
 ```
 
--   [graphql-type-json](https://github.com/taion/graphql-type-json)
--   [prisma-graphql-type-decimal](https://github.com/unlight/prisma-graphql-type-decimal)
+- [graphql-type-json](https://github.com/taion/graphql-type-json)
+- [prisma-graphql-type-decimal](https://github.com/unlight/prisma-graphql-type-decimal)
 
 Or write you own graphql scalar types, [read more on docs.nestjs.com](https://docs.nestjs.com/graphql/scalars).
 
@@ -59,10 +59,10 @@ Type: `string`
 Default: `{model}/{name}.{type}.ts`  
 Possible tokens:
 
--   `{model}` Model name in dashed case or 'prisma' if unknown
--   `{name}` Dashed-case name of model/input/arg without suffix
--   `{type}` Short type name (model, input, args, output)
--   `{plural.type}` Plural short type name (models, inputs, enums)
+- `{model}` Model name in dashed case or 'prisma' if unknown
+- `{name}` Dashed-case name of model/input/arg without suffix
+- `{type}` Short type name (model, input, args, output)
+- `{plural.type}` Plural short type name (models, inputs, enums)
 
 #### `tsConfigFilePath`
 
@@ -149,30 +149,30 @@ generator nestgraphql {
 
 Where:
 
--   `typeName` Full name or partial name of the class where need to choose input type.  
-    Example: `UserCreateInput` full name, `WhereInput` partial name, matches `UserWhereInput`, `PostWhereInput`, etc.
--   `property` Property of the class for which need to choose type. Special case name `ALL` means any / all properties.
--   `pattern` Part of name (or full) of type which should be chosen, you can use
-    wild card or negate symbols, in this case pattern should starts with `match:`,
-    e.g. `match:*UncheckedCreateInput` see [outmatch](https://github.com/axtgr/outmatch#usage) for details.
+- `typeName` Full name or partial name of the class where need to choose input type.  
+  Example: `UserCreateInput` full name, `WhereInput` partial name, matches `UserWhereInput`, `PostWhereInput`, etc.
+- `property` Property of the class for which need to choose type. Special case name `ALL` means any / all properties.
+- `pattern` Part of name (or full) of type which should be chosen, you can use
+  wild card or negate symbols, in this case pattern should starts with `match:`,
+  e.g. `match:*UncheckedCreateInput` see [outmatch](https://github.com/axtgr/outmatch#usage) for details.
 
 Example:
 
 ```ts
 export type PostWhereInput = {
-    author?: XOR<UserRelationFilter, UserWhereInput>;
+  author?: XOR<UserRelationFilter, UserWhereInput>;
 };
 export type UserRelationFilter = {
-    is?: UserWhereInput;
-    isNot?: UserWhereInput;
+  is?: UserWhereInput;
+  isNot?: UserWhereInput;
 };
 
 export type UserWhereInput = {
-    AND?: Enumerable<UserWhereInput>;
-    OR?: Enumerable<UserWhereInput>;
-    NOT?: Enumerable<UserWhereInput>;
-    id?: StringFilter | string;
-    name?: StringFilter | string;
+  AND?: Enumerable<UserWhereInput>;
+  OR?: Enumerable<UserWhereInput>;
+  NOT?: Enumerable<UserWhereInput>;
+  id?: StringFilter | string;
+  name?: StringFilter | string;
 };
 ```
 
@@ -190,8 +190,8 @@ generator nestgraphql {
 ```ts
 @InputType()
 export class PostWhereInput {
-    @Field(() => UserWhereInput, { nullable: true })
-    author?: UserWhereInput;
+  @Field(() => UserWhereInput, { nullable: true })
+  author?: UserWhereInput;
 }
 ```
 
@@ -214,24 +214,24 @@ generator nestgraphql {
 
 Where `{key}` any identifier to group values (written in [flatten](https://github.com/hughsk/flat) style)
 
--   `decorate_{key}_type` - outmatch pattern to match class name
--   `decorate_{key}_field` - outmatch pattern to match field name
--   `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)
--   `decorate_{key}_arguments` - arguments for decorator (if decorator need to be called as function)  
-    Special tokens can be used:
-    -   `{propertyType.0}` - field's type (TypeScript type annotation)
+- `decorate_{key}_type` - outmatch pattern to match class name
+- `decorate_{key}_field` - outmatch pattern to match field name
+- `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)
+- `decorate_{key}_arguments` - arguments for decorator (if decorator need to be called as function)  
+  Special tokens can be used:
+  - `{propertyType.0}` - field's type (TypeScript type annotation)
 
 Example of generated class:
 
 ```ts
 @ArgsType()
 export class CreateOneUserArgs {
-    @Field(() => UserCreateInput, { nullable: false })
-    data!: UserCreateInput;
+  @Field(() => UserCreateInput, { nullable: false })
+  data!: UserCreateInput;
 }
 ```
 
@@ -259,10 +259,10 @@ import { Type } from 'class-transformer';
 
 @ArgsType()
 export class CreateOneUserArgs {
-    @Field(() => UserCreateInput, { nullable: false })
-    @ValidateNested()
-    @Type(() => UserCreateInput)
-    data!: UserCreateInput;
+  @Field(() => UserCreateInput, { nullable: false })
+  @ValidateNested()
+  @Type(() => UserCreateInput)
+  data!: UserCreateInput;
 }
 ```
 
@@ -329,13 +329,45 @@ May generate:
 import { GraphQLBigInt } from 'graphql-scalars';
 
 export class BigIntFilter {
-    @Field(() => GraphQLBigInt, { nullable: true })
-    equals?: bigint | number;
+  @Field(() => GraphQLBigInt, { nullable: true })
+  equals?: bigint | number;
 }
 ```
 
 It will affect all inputs and outputs types (including models).
 
+## Documentation and field options
+
+Comments with double slash will projected to typescript code comments
+and some `@Field()` decorator options
+
+For example:
+
+```prisma
+model Product {
+  // Old description
+  // @deprecated Use new name instead
+  oldName
+}
+```
+
+May produce:
+
+```ts
+@ObjectType()
+export class Product {
+  /**
+   * Old description
+   * @deprecated Use new name instead
+   */
+  @Field(() => String, {
+    description: 'Old description',
+    deprecationReason: 'Use new name instead',
+  })
+  oldName: string;
+}
+```
+
 ## Field Settings
 
 Special directives in triple slash comments for more precise code generation.
@@ -352,9 +384,9 @@ see [outmatch](https://github.com/axtgr/outmatch#usage) for details.
 
 Examples:
 
--   `@HideField()` same as `@HideField({ output: true })`
--   `@HideField({ input: true, output: true })`
--   `@HideField({ match: 'UserCreate*Input' })`
+- `@HideField()` same as `@HideField({ output: true })`
+- `@HideField({ input: true, output: true })`
+- `@HideField({ match: 'UserCreate*Input' })`
 
 ```prisma
 model User {
@@ -373,24 +405,24 @@ May generate classes:
 ```ts
 @ObjectType()
 export class User {
-    @HideField()
-    password: string;
-    @HideField()
-    secret: string;
-    @Field(() => Date, { nullable: false })
-    createdAt: Date;
+  @HideField()
+  password: string;
+  @HideField()
+  secret: string;
+  @Field(() => Date, { nullable: false })
+  createdAt: Date;
 }
 ```
 
 ```ts
 @InputType()
 export class UserCreateInput {
-    @Field()
-    password: string;
-    @HideField()
-    secret: string;
-    @HideField()
-    createdAt: Date;
+  @Field()
+  password: string;
+  @HideField()
+  secret: string;
+  @HideField()
+  createdAt: Date;
 }
 ```
 
@@ -480,9 +512,9 @@ import * as Validator from 'class-validator';
 
 @InputType()
 export class UserCreateInput {
-    @Field(() => String, { nullable: false })
-    @Validator.MinLength(3)
-    name!: string;
+  @Field(() => String, { nullable: false })
+  @Validator.MinLength(3)
+  name!: string;
 }
 ```
 
@@ -539,8 +571,8 @@ import * as Scalars from 'graphql-scalars';
 
 @InputType()
 export class UserCreateInput {
-    @Field(() => Scalars.GraphQLEmailAddress, { nullable: false })
-    email!: string;
+  @Field(() => Scalars.GraphQLEmailAddress, { nullable: false })
+  email!: string;
 }
 ```
 
@@ -602,8 +634,8 @@ import * as TF from 'type-fest';
 
 @ObjectType()
 export class User {
-    @Field(() => GraphQLJSON)
-    data!: TF.JsonObject;
+  @Field(() => GraphQLJSON)
+  data!: TF.JsonObject;
 }
 ```
 
@@ -629,9 +661,9 @@ May generate:
 @Directive('@extends')
 @Directive('@key(fields: "id")')
 export class User {
-    @Field(() => ID, { nullable: false })
-    @Directive('@external')
-    id!: string;
+  @Field(() => ID, { nullable: false })
+  @Directive('@external')
+  id!: string;
 }
 ```
 
@@ -671,21 +703,21 @@ export class User {}
 
 ## Similar Projects
 
--   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/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
 
 ## 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

package/index.js

@@ -749,6 +749,7 @@ function inputType(args) {
         arguments: [
           isList ? `() => [${graphqlType}]` : `() => ${graphqlType}`,
           import_json5.default.stringify({
+            ...settings == null ? void 0 : settings.fieldArguments(),
             nullable: !isRequired
           })
         ]
@@ -849,81 +850,126 @@ var ObjectSettings = class extends Array {
     }
     return resultArguments.map((x) => import_json52.default.stringify(x));
   }
+  fieldArguments() {
+    const item1 = this.find((item) => item.kind === "Field");
+    if (item1) {
+      return item1.arguments;
+    }
+  }
 };
 __name(ObjectSettings, "ObjectSettings");
 function createObjectSettings(args) {
-  var _a, _b, _c, _d, _e;
   const { config, text } = args;
   const result = new ObjectSettings();
   const textLines = text.split("\n");
   const documentationLines = [];
+  let fieldElement = result.find((item) => item.kind === "Field");
+  if (!fieldElement) {
+    fieldElement = {
+      name: "",
+      kind: "Field",
+      arguments: {}
+    };
+  }
   for (const line of textLines) {
     const match = /^@(?<name>\w+(\.(\w+))?)\((?<args>.*)\)/.exec(line);
-    const name = (_a = match == null ? void 0 : match.groups) == null ? void 0 : _a.name;
-    if (!match || !name) {
-      documentationLines.push(line);
-      continue;
+    const { element, documentLine } = createSettingElement({
+      line,
+      config,
+      fieldElement,
+      match
+    });
+    if (element) {
+      result.push(element);
     }
-    const element = {
-      kind: "Decorator",
-      name: "",
-      arguments: [],
-      input: false,
-      output: false,
-      model: false,
-      from: ""
-    };
-    if (name === "TypeGraphQL.omit" || name === "HideField") {
-      Object.assign(element, hideFieldDecorator(match));
-    } else if ([
-      "FieldType",
-      "PropertyType"
-    ].includes(name) && ((_b = match.groups) == null ? void 0 : _b.args)) {
-      const options = customType(match.groups.args);
-      (0, import_lodash4.merge)(element, options.namespace && config.fields[options.namespace], options, {
-        kind: name
-      });
-    } else if (name === "ObjectType" && ((_c = match.groups) == null ? void 0 : _c.args)) {
-      element.kind = "ObjectType";
-      const options = customType(match.groups.args);
-      if (typeof options[0] === "string" && options[0]) {
-        options.name = options[0];
-      }
-      if ((0, import_lodash4.isObject)(options[1])) {
-        (0, import_lodash4.merge)(options, options[1]);
-      }
-      element.arguments = {
-        name: options.name,
-        isAbstract: options.isAbstract
-      };
-    } else if (name === "Directive" && ((_d = match.groups) == null ? void 0 : _d.args)) {
-      const options = customType(match.groups.args);
-      (0, import_lodash4.merge)(element, {
-        model: true,
-        from: "@nestjs/graphql"
-      }, options, {
-        name,
-        namespace: false,
-        kind: "Decorator",
-        arguments: Array.isArray(options.arguments) ? options.arguments.map((s) => import_json52.default.stringify(s)) : options.arguments
-      });
-    } else {
-      const namespace = getNamespace(name);
-      element.namespaceImport = namespace;
-      const options = {
-        name,
-        arguments: (((_e = match.groups) == null ? void 0 : _e.args) || "").split(",").map((s) => (0, import_lodash4.trim)(s)).filter(Boolean)
-      };
-      (0, import_lodash4.merge)(element, namespace && config.fields[namespace], options);
+    if (documentLine) {
+      documentationLines.push(line);
     }
-    result.push(element);
   }
   return {
     settings: result,
-    documentation: documentationLines.filter(Boolean).join("\\n") || void 0
+    documentation: documentationLines.filter(Boolean).join("\n") || void 0
   };
 }
 __name(createObjectSettings, "createObjectSettings");
+function createSettingElement({ line, config, fieldElement, match }) {
+  var _a, _b, _c, _d, _e;
+  const result = {
+    documentLine: "",
+    element: void 0
+  };
+  if (line.startsWith("@deprecated")) {
+    fieldElement.arguments["deprecationReason"] = (0, import_lodash4.trim)(line.slice(11));
+    result.element = fieldElement;
+    return result;
+  }
+  const name = (_a = match == null ? void 0 : match.groups) == null ? void 0 : _a.name;
+  if (!(match && name)) {
+    result.documentLine = line;
+    return result;
+  }
+  const element = {
+    kind: "Decorator",
+    name: "",
+    arguments: [],
+    input: false,
+    output: false,
+    model: false,
+    from: ""
+  };
+  result.element = element;
+  if (name === "TypeGraphQL.omit" || name === "HideField") {
+    Object.assign(element, hideFieldDecorator(match));
+    return result;
+  }
+  if ([
+    "FieldType",
+    "PropertyType"
+  ].includes(name) && ((_b = match.groups) == null ? void 0 : _b.args)) {
+    const options2 = customType(match.groups.args);
+    (0, import_lodash4.merge)(element, options2.namespace && config.fields[options2.namespace], options2, {
+      kind: name
+    });
+    return result;
+  }
+  if (name === "ObjectType" && ((_c = match.groups) == null ? void 0 : _c.args)) {
+    element.kind = "ObjectType";
+    const options2 = customType(match.groups.args);
+    if (typeof options2[0] === "string" && options2[0]) {
+      options2.name = options2[0];
+    }
+    if ((0, import_lodash4.isObject)(options2[1])) {
+      (0, import_lodash4.merge)(options2, options2[1]);
+    }
+    element.arguments = {
+      name: options2.name,
+      isAbstract: options2.isAbstract
+    };
+    return result;
+  }
+  if (name === "Directive" && ((_d = match.groups) == null ? void 0 : _d.args)) {
+    const options2 = customType(match.groups.args);
+    (0, import_lodash4.merge)(element, {
+      model: true,
+      from: "@nestjs/graphql"
+    }, options2, {
+      name,
+      namespace: false,
+      kind: "Decorator",
+      arguments: Array.isArray(options2.arguments) ? options2.arguments.map((s) => import_json52.default.stringify(s)) : options2.arguments
+    });
+    return result;
+  }
+  const namespace = getNamespace(name);
+  element.namespaceImport = namespace;
+  const options = {
+    name,
+    arguments: (((_e = match.groups) == null ? void 0 : _e.args) || "").split(",").map((s) => (0, import_lodash4.trim)(s)).filter(Boolean)
+  };
+  (0, import_lodash4.merge)(element, namespace && config.fields[namespace], options);
+  return result;
+}
+__name(createSettingElement, "createSettingElement");
 function customType(args) {
   var _a;
   const result = {};
@@ -1035,6 +1081,25 @@ var import_lodash5 = require("lodash");
 var import_pupa2 = __toESM(require("pupa"));
 var import_ts_morph5 = require("ts-morph");
 
+// src/helpers/create-comment.ts
+function createComment(documentation, settings) {
+  var _a;
+  const documentationLines = documentation.split("\n");
+  const commentLines = [
+    "/**"
+  ];
+  for (const line of documentationLines) {
+    commentLines.push(` * ${line}`);
+  }
+  const deprecationReason = (_a = settings == null ? void 0 : settings.fieldArguments()) == null ? void 0 : _a.deprecationReason;
+  if (deprecationReason) {
+    commentLines.push(` * @deprecated ${deprecationReason}`);
+  }
+  commentLines.push(" */\n");
+  return commentLines.join("\n");
+}
+__name(createComment, "createComment");
+
 // src/helpers/get-output-type-name.ts
 function getOutputTypeName(name) {
   return name.replace(/(?:OutputType|Output)$/, "");
@@ -1080,8 +1145,7 @@ function modelOutputType(outputType2, args) {
     });
     if (documentation) {
       if (!classStructure.leadingTrivia) {
-        classStructure.leadingTrivia = `/** ${documentation} */
-`;
+        classStructure.leadingTrivia = createComment(documentation);
       }
       objectTypeOptions.description = documentation;
     }
@@ -1147,15 +1211,14 @@ function modelOutputType(outputType2, args) {
       isList
     });
     if (typeof property.leadingTrivia === "string" && (modelField == null ? void 0 : modelField.documentation)) {
-      property.leadingTrivia += `/** ${modelField.documentation} */
-`;
+      property.leadingTrivia += createComment(modelField.documentation, settings);
     }
     (_c = classStructure.properties) == null ? void 0 : _c.push(property);
     if (propertySettings) {
       importDeclarations.create({
         ...propertySettings
       });
-    } else if (!propertySettings && propertyType.includes("Decimal")) {
+    } else if (propertyType.includes("Decimal")) {
       importDeclarations.add("Decimal", "@prisma/client/runtime");
     }
     (0, import_assert3.ok)(property.decorators, "property.decorators is undefined");
@@ -1174,6 +1237,7 @@ function modelOutputType(outputType2, args) {
         arguments: [
           isList ? `() => [${graphqlType}]` : `() => ${graphqlType}`,
           import_json53.default.stringify({
+            ...settings == null ? void 0 : settings.fieldArguments(),
             nullable: Boolean(field.isNullable),
             defaultValue: [
               "number",
@@ -1413,6 +1477,7 @@ function outputType(outputType1, args) {
         arguments: [
           isList ? `() => [${graphqlType}]` : `() => ${graphqlType}`,
           import_json54.default.stringify({
+            ...settings == null ? void 0 : settings.fieldArguments(),
             nullable: Boolean(field.isNullable)
           })
         ]

package/package.json

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