Merge pull request #162 from remorses/prisma-like

Fix bugs before major version change

.github/workflows/ci.yml

@@ -11,6 +11,8 @@ jobs:
 
     steps:
       - uses: actions/checkout@v3
+        with:
+          submodules: true
       - uses: actions/setup-node@v3
         with:
           node-version: 18
@@ -25,7 +27,7 @@ jobs:
       # setup pnpm
       - uses: pnpm/action-setup@v2
         with:
-          version: 7
+          version: 8
           run_install: false
       # scripts
       - run: pnpm i --store-dir ~/pnpm

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "beskar"]
+	path = beskar
+	url = https://github.com/remorses/beskar

CHANGELOG.md

@@ -1,5 +1,11 @@
 For new changes see the new changelog built with [Notaku](https://notaku.so) and Notion: https://changelog.genql.dev
 
+## 2.11
+
+-   Fix custom scalars typed with object types
+-   Make required top level arguments with defaults non required
+-   \_\_scalar: true should exclude scalars with required arguments
+
 ## 2.10.0
 
 Fixed problem generating interfaces without any implementation

architecture.md

@@ -0,0 +1,43 @@
+i have a query made like this
+
+```ts
+type ObjectTypeReq = {
+    args: ArgsType,
+    select: Record<string, TypeReq>
+    include: Record<string, TypeReq>
+}
+
+type UnionTypeReq = {
+    args: ArgsType,
+    select: Record<string, TypeReq>
+    include: Record<string, TypeReq>
+    onA: ObjectTypeReq
+    onB: ObjectTypeReq
+}
+
+type TypeReq = ObjectTypeReq | UnionTypeReq | boolean
+
+getCountries(req: TypeReq): Type
+```
+
+i need to create a class Client with top level methods:
+
+```ts
+class Client {
+    getCountries<Include extends CountryInclude, Select extends CountrySelect>(
+        req: GetCountriesRequest<Include, Select>,
+    ): Selection<Countries, Include, Select> {
+        const { query, variables } = buildQuery(req, 'getCountries')
+    }
+}
+
+type GetCountriesRequest<I, S> = {
+    args: GetCountriesArgs
+    select: Pick<Countries, S>
+    include: I
+}
+
+function buildQuery()
+```
+
+

cli/src/render/requestTypes/objectType.ts

@@ -101,7 +101,7 @@ export const toArgsString = (field: GraphQLField<any, any, any>) => {
         .map(
             (a) =>
                 `${argumentComment(a)}${a.name}${
-                    isNonNullType(a.type) ? ':' : '?:'
+                    isNonNullType(a.type) && a.defaultValue == null ? ':' : '?:'
                 } ${renderTyping(a.type)}`,
         )
         .join(', ')

cli/src/render/typeMap/renderTypeMap.ts

@@ -12,6 +12,7 @@ import {
     isInterfaceType,
     isObjectType,
     isScalarType,
+
     isUnionType,
 } from 'graphql'
 import { excludedTypes } from '../common/excludedTypes'
@@ -37,6 +38,7 @@ export const renderTypeMap = (schema: GraphQLSchema, ctx: RenderContext) => {
                 result.types[t.name] = objectType(t, ctx)
             else if (isUnionType(t)) result.types[t.name] = unionType(t, ctx)
             else if (isScalarType(t) || isEnumType(t)) {
+
                 result.scalars.push(t.name)
                 result.types[t.name] = {}
             }
@@ -67,7 +69,6 @@ export const renderTypeMap = (schema: GraphQLSchema, ctx: RenderContext) => {
     ctx.addCodeBlock(
         JSON.stringify(replaceTypeNamesWithIndexes(result), null, 4),
     )
-
 
 
 }

cli/src/runtime/linkTypeMap.ts

@@ -34,7 +34,24 @@ export const linkTypeMap = (
                         // type scalar properties
                         scalar: Object.keys(fields).filter((f) => {
                             const [type] = fields[f] || []
-                            return type && typeMap.scalars.includes(type)
+
+                            const isScalar =
+                                type && typeMap.scalars.includes(type)
+                            if (!isScalar) {
+                                return false
+                            }
+                            const args = fields[f]?.[1]
+                            const argTypes = Object.values(args || {})
+                                .map((x) => x?.[1])
+                                .filter(Boolean)
+
+                            const hasRequiredArgs = argTypes.some(
+                                (str) => str && str.endsWith('!'),
+                            )
+                            if (hasRequiredArgs) {
+                                return false
+                            }
+                            return true
                         }),
                         // fields with corresponding `type` and `args`
                         fields: Object.assign(

cli/src/runtime/typeSelection.ts

@@ -40,16 +40,15 @@ export type FieldsSelection<SRC extends Anify<DST> | undefined, DST> = {
     ? 'object'
     : 'never']
 
-type HandleObject<SRC extends Anify<DST>, DST> = SRC extends Nil
+type HandleObject<SRC extends Anify<DST>, DST> = DST extends boolean
+    ? SRC
+    : SRC extends Nil
     ? never
     : Pick<
           {
               // using keyof SRC to maintain ?: relations of SRC type
               [Key in keyof SRC]: Key extends keyof DST
-                  ? FieldsSelection<
-                        SRC[Key],
-                        NonNullable<DST[Key]>
-                    >
+                  ? FieldsSelection<SRC[Key], NonNullable<DST[Key]>>
                   : SRC[Key]
           },
           Exclude<keyof DST, FieldsToRemove>

cli/src/typeSelection.test.ts

@@ -23,6 +23,7 @@ type SRC = {
         a: string
         optional?: string
     }[]
+    customScalar: { json: true }
     nested?: {
         list?: {
             edges?: {
@@ -100,6 +101,7 @@ type SRC = {
 
 describe('pick', () => {
     const req = {
+        customScalar: true,
         category: {
             a: 1,
             b: 1,
@@ -149,6 +151,13 @@ describe('pick', () => {
             z.argumentSyntax.a.toLocaleLowerCase
         }),
     )
+    test(
+        'custom scalars',
+        dontExecute(() => {
+            const custom = z.customScalar
+            custom.json
+        }),
+    )
 })
 
 describe('__scalar', () => {
@@ -246,7 +255,7 @@ describe('optional fields', () => {
         optionalObject: {
             x: 1,
             optional: 1,
-        }
+        },
     }
     const z: FieldsSelection<SRC, typeof req> = {} as any
     test(

integration-tests/__snapshots__/simple.ts.js

@@ -95,6 +95,7 @@ subscription SomeName {
 fragment f1 on User {
   name
   common
+  commonButDiffType
   __typename
 }
 
@@ -109,6 +110,7 @@ subscription {
 fragment f1 on User {
   name
   common
+  commonButDiffType
   __typename
 }
 
@@ -139,6 +141,7 @@ fragment f1 on Fork {
 fragment f2 on User {
   name
   common
+  commonButDiffType
   __typename
 }
 
@@ -161,6 +164,7 @@ subscription {
 }
 fragment f1 on User {
   name
+  commonButDiffType
   __typename
 }
 

integration-tests/generate.ts

@@ -9,6 +9,7 @@ generate({
     output: path.join(__dirname, 'generated'),
     scalarTypes: {
         MongoID: 'string',
+        MyCustomScalar: `{ x: string }`,
     },
     // verbose: false,
 }).catch(console.error)

integration-tests/generated/schema.graphql

@@ -9,6 +9,8 @@ enum SomeEnum2 {
   world
 }
 
+scalar MyCustomScalar
+
 input InputWithRequiredFields {
   requiredField: String!
   optionalField: String
@@ -17,7 +19,7 @@ input InputWithRequiredFields {
 type Query {
   """Some description"""
   repository(name: String!, owner: String): Repository!
-  queryWithDefaultArgs(input: DefaultArgsInput, defaultValue: Int = 3): String
+  queryWithDefaultArgs(input: DefaultArgsInput, defaultValue: Int = 3, requiredButDefault: Int! = 1): String
   optionalArgs(name: String, owner: String): Repository!
   user: User
   someScalarValue(x: Float): String
@@ -42,6 +44,8 @@ type RecursiveType {
 type Repository {
   createdAt: String!
   forks(filter: String): ForkConnection
+  scalarButWithRequiredArgs(x: Int!): String!
+  customScalar: MyCustomScalar
 }
 
 type ForkConnection {
@@ -62,6 +66,7 @@ type User {
   """Some description"""
   name: String
   common: Int
+  commonButDiffType: Int
 }
 
 type Subscription {
@@ -73,6 +78,7 @@ union Account = User | Guest
 type Guest {
   anonymous: Boolean
   common: Int
+  commonButDiffType: String
 }
 
 type House implements Point {

integration-tests/generated/schema.ts

@@ -4,6 +4,7 @@
 /* eslint-disable */
 
 export type Scalars = {
+    MyCustomScalar: { x: string },
     String: string,
     Int: number,
     Float: number,
@@ -41,6 +42,8 @@ export interface RecursiveType {
 export interface Repository {
     createdAt: Scalars['String']
     forks: (ForkConnection | null)
+    scalarButWithRequiredArgs: Scalars['String']
+    customScalar: (Scalars['MyCustomScalar'] | null)
     __typename: 'Repository'
 }
 
@@ -65,6 +68,7 @@ export interface User {
     /** Some description */
     name: (Scalars['String'] | null)
     common: (Scalars['Int'] | null)
+    commonButDiffType: (Scalars['Int'] | null)
     __typename: 'User'
 }
 
@@ -78,6 +82,7 @@ export type Account = (User | Guest) & { __isUnion?: true }
 export interface Guest {
     anonymous: (Scalars['Boolean'] | null)
     common: (Scalars['Int'] | null)
+    commonButDiffType: (Scalars['String'] | null)
     __typename: 'Guest'
 }
 
@@ -132,7 +137,7 @@ export interface InputWithRequiredFields {requiredField: Scalars['String'],optio
 export interface QueryGenqlSelection{
     /** Some description */
     repository?: (RepositoryGenqlSelection & { __args: {name: Scalars['String'], owner?: (Scalars['String'] | null)} })
-    queryWithDefaultArgs?: { __args: {input?: (DefaultArgsInput | null), defaultValue?: (Scalars['Int'] | null)} } | boolean | number
+    queryWithDefaultArgs?: { __args: {input?: (DefaultArgsInput | null), defaultValue?: (Scalars['Int'] | null), requiredButDefault?: Scalars['Int']} } | boolean | number
     optionalArgs?: (RepositoryGenqlSelection & { __args?: {name?: (Scalars['String'] | null), owner?: (Scalars['String'] | null)} })
     user?: UserGenqlSelection
     someScalarValue?: { __args: {x?: (Scalars['Float'] | null)} } | boolean | number
@@ -159,6 +164,8 @@ export interface RecursiveTypeGenqlSelection{
 export interface RepositoryGenqlSelection{
     createdAt?: boolean | number
     forks?: (ForkConnectionGenqlSelection & { __args?: {filter?: (Scalars['String'] | null)} })
+    scalarButWithRequiredArgs?: { __args: {x: Scalars['Int']} }
+    customScalar?: boolean | number
     __typename?: boolean | number
     __scalar?: boolean | number
 }
@@ -187,6 +194,7 @@ export interface UserGenqlSelection{
     /** Some description */
     name?: boolean | number
     common?: boolean | number
+    commonButDiffType?: boolean | number
     __typename?: boolean | number
     __scalar?: boolean | number
 }
@@ -206,6 +214,7 @@ export interface AccountGenqlSelection{
 export interface GuestGenqlSelection{
     anonymous?: boolean | number
     common?: boolean | number
+    commonButDiffType?: boolean | number
     __typename?: boolean | number
     __scalar?: boolean | number
 }