protoc-gen-pothos 0.3.2 → 0.3.4

package/LICENSE

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

@@ -2,4 +2,53 @@
 
 Build GraphQL schema from Protobuf and [Pothos GraphQL](https://pothos-graphql.dev/).
 
-- repository: https://github.com/proto-graphql/proto-graphql-js
+## Supported Protocol Buffers Implementations
+
+- [ts-proto](https://github.com/stephenh/ts-proto)
+
+## Configuration with [Buf](https://docs.buf.build/installation)
+
+```yaml
+# proto/buf.yaml
+version: v1
+deps:
+  - buf.build/proto-graphql/proto-graphql
+```
+
+### with [ts-proto](https://github.com/stephenh/ts-proto)
+
+```yaml
+# proto/buf.gen.yaml
+version: v1
+plugins:
+  - name: ts
+    out: ../src/__generated__/proto
+    strategy: all
+    path: ../node_modules/.bin/protoc-gen-ts_proto
+    opt:
+      - esModuleInterop=true     # required
+      - unrecognizedEnum=false   # required
+      - outputTypeRegistry=true  # required
+    strategy: all
+  - name: pothos
+    path: ../node_modules/.bin/protoc-gen-pothos
+    out: ../src/__generated__/pothos
+    opt:
+      - pothos_builder_path=../../builder
+      - import_prefix=../proto
+```
+
+### Supported options
+
+- `import_prefix` (`string`, required)
+  - path to out dir of ts-proto
+- `pothos_builder_path` (`string`, required)
+  - path to file that exports pothos builder
+- `emit_imported_files` (`bool`, optional)
+  - if `true`, protoc-gen-pothos also emits types defined in imported `.proto` file.
+- `custom_type` (`string`, optional)
+- `long_number` (`string`, optional, default `String`)
+
+## Author
+
+- Masayuki Izumi ([twitter: @izumin5210](https://github.com/izumin5210), [github: @izumin5210](https://github.com/izumin5210))

package/lib/dslgen/printers/inputObjectType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"inputObjectType.d.ts","sourceRoot":"","sources":["../../../src/dslgen/printers/inputObjectType.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,eAAe,EAGhB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,IAAI,EAAkC,MAAM,SAAS,CAAC;AAG/D,OAAO,EAGL,oBAAoB,EAGrB,MAAM,QAAQ,CAAC;AAEhB;;;;;;;;;;;;;GAaG;AACH,wBAAgB,yBAAyB,CACvC,IAAI,EAAE,eAAe,EACrB,IAAI,EAAE,oBAAoB,GACzB,IAAI,CAkDN"}
+{"version":3,"file":"inputObjectType.d.ts","sourceRoot":"","sources":["../../../src/dslgen/printers/inputObjectType.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,eAAe,EAIhB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,IAAI,EAAkC,MAAM,SAAS,CAAC;AAG/D,OAAO,EAGL,oBAAoB,EAGrB,MAAM,QAAQ,CAAC;AAEhB;;;;;;;;;;;;;GAaG;AACH,wBAAgB,yBAAyB,CACvC,IAAI,EAAE,eAAe,EACrB,IAAI,EAAE,oBAAoB,GACzB,IAAI,CAsDN"}

package/lib/dslgen/printers/inputObjectType.js

@@ -35,7 +35,9 @@ function createInputObjectTypeCode(type, opts) {
         }
         return f.isNullable()
             ? (0, ts_poet_1.code) `${f.name}?: ${typeNode} | null,`
-            : (0, ts_poet_1.code) `${f.name}: ${typeNode},`;
+            : (0, ts_poet_1.code) `${f.name}: ${f.type instanceof codegen_core_1.ScalarType && f.type.isCustomScalar()
+                ? (0, ts_poet_1.code) `NonNullable<${typeNode}>`
+                : typeNode},`;
     }))}
     };
   `;

package/module/dslgen/printers/inputObjectType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"inputObjectType.d.ts","sourceRoot":"","sources":["../../../src/dslgen/printers/inputObjectType.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,eAAe,EAGhB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,IAAI,EAAkC,MAAM,SAAS,CAAC;AAG/D,OAAO,EAGL,oBAAoB,EAGrB,MAAM,QAAQ,CAAC;AAEhB;;;;;;;;;;;;;GAaG;AACH,wBAAgB,yBAAyB,CACvC,IAAI,EAAE,eAAe,EACrB,IAAI,EAAE,oBAAoB,GACzB,IAAI,CAkDN"}
+{"version":3,"file":"inputObjectType.d.ts","sourceRoot":"","sources":["../../../src/dslgen/printers/inputObjectType.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,eAAe,EAIhB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,IAAI,EAAkC,MAAM,SAAS,CAAC;AAG/D,OAAO,EAGL,oBAAoB,EAGrB,MAAM,QAAQ,CAAC;AAEhB;;;;;;;;;;;;;GAaG;AACH,wBAAgB,yBAAyB,CACvC,IAAI,EAAE,eAAe,EACrB,IAAI,EAAE,oBAAoB,GACzB,IAAI,CAsDN"}

package/module/dslgen/printers/inputObjectType.js

@@ -1,4 +1,4 @@
-import { compact, InputObjectType, protobufGraphQLExtensions, protoType, } from "@proto-graphql/codegen-core";
+import { compact, InputObjectType, protobufGraphQLExtensions, protoType, ScalarType, } from "@proto-graphql/codegen-core";
 import { code, imp, joinCode, literalOf } from "ts-poet";
 import { createFieldRefCode, createNoopFieldRefCode } from "./field";
 import { fieldTypeShape, pothosBuilder, pothosRef, shapeType, } from "./util";
@@ -32,7 +32,9 @@ export function createInputObjectTypeCode(type, opts) {
         }
         return f.isNullable()
             ? code `${f.name}?: ${typeNode} | null,`
-            : code `${f.name}: ${typeNode},`;
+            : code `${f.name}: ${f.type instanceof ScalarType && f.type.isCustomScalar()
+                ? code `NonNullable<${typeNode}>`
+                : typeNode},`;
     }))}
     };
   `;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "protoc-gen-pothos",
-  "version": "0.3.2",
+  "version": "0.3.4",
   "description": "Generate DSL for Pothos GraphQL from Protocol Buffers IDL",
   "keywords": [
     "graphql",
@@ -23,24 +23,30 @@
     "node": ">= 14.0.0"
   },
   "dependencies": {
-    "@proto-graphql/codegen-core": "^0.3.2",
-    "@proto-graphql/proto-descriptors": "^0.3.1",
-    "@proto-graphql/protoc-plugin-helpers": "^0.2.3",
     "google-protobuf": "^3.21.2",
-    "ts-poet": "^6.3.0"
+    "ts-poet": "^6.3.0",
+    "@proto-graphql/codegen-core": "0.3.4",
+    "@proto-graphql/proto-descriptors": "0.3.3",
+    "@proto-graphql/protoc-plugin-helpers": "0.2.6"
   },
   "devDependencies": {
-    "@types/google-protobuf": "^3.15.6"
+    "@proto-graphql/eslint-config": "0.1.0",
+    "@proto-graphql/testapis-proto": "0.1.0",
+    "@proto-graphql/tsconfig": "0.1.0"
   },
   "files": [
     "bin/",
-    "include/",
     "lib/",
     "module/"
   ],
   "scripts": {
-    "build": "tsc --build tsconfig.cjs.json && tsc --build tsconfig.module.json",
-    "clean": "rimraf lib/ module/ && tsc --build tsconfig.cjs.json --clean && tsc --build tsconfig.module.json --clean",
+    "build": "pnpm run build:cjs && pnpm run build:module",
+    "build:cjs": "tsc --build tsconfig.cjs.json",
+    "build:module": "tsc --build tsconfig.module.json",
+    "clean": "pnpm run clean:cjs && pnpm run clean:module",
+    "clean:cjs": "pnpm run build:cjs --clean",
+    "clean:module": "pnpm run build:module --clean",
+    "lint": "eslint --fix .",
     "test": "jest --coverage"
   }
-}
+}