Update graphqlcodegenerator monorepo to v4 (major) #615

renovate · 2023-05-24T09:46:37Z

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
@graphql-codegen/cli	`3.3.1` -> `4.0.0`
@graphql-codegen/typescript	`3.0.4` -> `4.0.0`
@graphql-codegen/typescript-operations	`3.0.4` -> `4.0.0`

Release Notes

dotansimha/graphql-code-generator (@graphql-codegen/cli)

`v4.0.0`

Compare Source

Major Changes

bb66c2a31 Thanks @n1ru4l! - Require Node.js >= 16. Drop support for Node.js 14

Patch Changes

#9449 4d9ea1a5a Thanks @n1ru4l! - dependencies updates:
- Updated dependency graphql-config@^5.0.0 ↗︎ (from ^4.5.0, in dependencies)
#9449 4d9ea1a5a Thanks @n1ru4l! - dependencies updates:
- Updated dependency @graphql-tools/apollo-engine-loader@^8.0.0 ↗︎ (from ^7.3.6, in dependencies)
- Updated dependency @graphql-tools/code-file-loader@^8.0.0 ↗︎ (from ^7.3.17, in dependencies)
- Updated dependency @graphql-tools/git-loader@^8.0.0 ↗︎ (from ^7.2.13, in dependencies)
- Updated dependency @graphql-tools/github-loader@^8.0.0 ↗︎ (from ^7.3.28, in dependencies)
- Updated dependency @graphql-tools/graphql-file-loader@^8.0.0 ↗︎ (from ^7.5.0, in dependencies)
- Updated dependency @graphql-tools/json-file-loader@^8.0.0 ↗︎ (from ^7.4.1, in dependencies)
- Updated dependency @graphql-tools/load@^8.0.0 ↗︎ (from ^7.8.0, in dependencies)
- Updated dependency @graphql-tools/prisma-loader@^8.0.0 ↗︎ (from ^7.2.69, in dependencies)
- Updated dependency @graphql-tools/url-loader@^8.0.0 ↗︎ (from ^7.17.17, in dependencies)
- Updated dependency @graphql-tools/utils@^10.0.0 ↗︎ (from ^9.0.0, in dependencies)
- Updated dependency cosmiconfig@^8.1.3 ↗︎ (from ^7.0.0, in dependencies)
- Updated dependency graphql-config@^5.0.1 ↗︎ (from ^4.5.0, in dependencies)
#9371 d431f426e Thanks @Axxxx0n! - Fixed option ignoreNoDocuments when using graphql configs
#9275 2a5da5894 Thanks @milesrichardson! - Trigger rebuilds in watch mode while respecting rules of precedence and negation, both in terms of global (top-level) config vs. local (per-output target) config, and in terms of watch patterns (higher priority) vs. documents/schemas (lower priority). This fixes an issue with overly-aggressive rebuilds during watch mode.
Updated dependencies [4d9ea1a5a, 4d9ea1a5a, f46803a8c, 63827fabe, bb66c2a31]:
- @graphql-codegen/core @4.0.0
- @graphql-codegen/plugin-helpers @5.0.0

dotansimha/graphql-code-generator (@graphql-codegen/typescript)

`v4.0.0`

Compare Source

Major Changes

#9375 ba84a3a27 Thanks @eddeee888! - Implement Scalars with input/output types

In GraphQL, Scalar types can be different for client and server. For example, given the native GraphQL ID:

A client may send string or number in the input
A client receives string in its selection set (i.e output)
A server receives string in the resolver (GraphQL parses string or number received from the client to string)
A server may return string or number (GraphQL serializes the value to string before sending it to the client )

Currently, we represent every Scalar with only one type. This is what codegen generates as base type:

export type Scalars = {
  ID: string;
};

Then, this is used in both input and output type e.g.

export type Book = {
  __typename?: 'Book';
  id: Scalars['ID']; // Output's ID can be `string` 👍
};

export type QueryBookArgs = {
  id: Scalars['ID']; // Input's ID can be `string` or `number`. However, the type is only `string` here 👎
};

This PR extends each Scalar to have input and output:

export type Scalars = {
  ID: {
    input: string | number;
    output: string;
  };
};

Then, each input/output GraphQL type can correctly refer to the correct input/output scalar type:

export type Book = {
  __typename?: 'Book';
  id: Scalars['ID']['output']; // Output's ID can be `string` 👍
};

export type QueryBookArgs = {
  id: Scalars['ID']['input']; // Input's ID can be `string` or `number` 👍
};

Note that for typescript-resolvers, the type of ID needs to be inverted. However, the referenced types in GraphQL input/output types should still work correctly:

export type Scalars = {
  ID: {
    input: string;
    output: string | number;
  }
}

export type Book = {
  __typename?: "Book";
  id: Scalars["ID"]['output']; // Resolvers can return `string` or `number` in ID fields 👍
};

export type QueryBookArgs = {
  id: Scalars["ID"]['input']; // Resolvers receive `string` in ID fields 👍
};

export type ResolversTypes = {
  ID: ID: ResolverTypeWrapper<Scalars['ID']['output']>; // Resolvers can return `string` or `number` in ID fields 👍
}

export type ResolversParentTypes = {
  ID: Scalars['ID']['output']; // Resolvers receive `string` or `number` from parents 👍
};

Config changes:

Scalars option can now take input/output types:

config: {
  scalars: {
    ID: {
      input: 'string',
      output: 'string | number'
    }
  }
}

If a string is given (instead of an object with input/output fields), it will be used as both input and output types:

config: {
  scalars: {
    ID: 'string'; // This means `string` will be used for both ID's input and output types
  }
}

BREAKING CHANGE: External module Scalar types need to be an object with input/output fields

config: {
  scalars: {
    ID: './path/to/scalar-module';
  }
}

If correctly, wired up, the following will be generated:

// Previously, imported `ID` type can be a primitive type, now it must be an object with input/output fields
import { ID } from './path/to/scalar-module';

export type Scalars = {
  ID: { input: ID['input']; output: ID['output'] };
};

BREAKING CHANGE: This changes Scalar types which could be referenced in other plugins. If you are a plugin maintainer and reference Scalar, please update your plugin to use the correct input/output types.

bb66c2a31 Thanks @n1ru4l! - Require Node.js >= 16. Drop support for Node.js 14

Minor Changes

#9196 3848a2b73 Thanks @beerose! - Add @defer directive support

When a query includes a deferred fragment field, the server will return a partial response with the non-deferred fields first, followed by the remaining fields once they have been resolved.

Once start using the @defer directive in your queries, the generated code will automatically include support for the directive.

// src/index.tsx
import { graphql } from './gql';
const OrdersFragment = graphql(`
  fragment OrdersFragment on User {
    orders {
      id
      total
    }
  }
`);
const GetUserQuery = graphql(`
  query GetUser($id: ID!) {
    user(id: $id) {
      id
      name
      ...OrdersFragment @&#8203;defer
    }
  }
`);

The generated type for GetUserQuery will have information that the fragment is incremental, meaning it may not be available right away.

// gql/graphql.ts
export type GetUserQuery = { __typename?: 'Query'; id: string; name: string } & ({
  __typename?: 'Query';
} & {
  ' $fragmentRefs'?: { OrdersFragment: Incremental<OrdersFragment> };
});

Apart from generating code that includes support for the @defer directive, the Codegen also exports a utility function called isFragmentReady. You can use it to conditionally render components based on whether the data for a deferred
fragment is available:

const OrdersList = (props: { data: FragmentType<typeof OrdersFragment> }) => {
  const data = useFragment(OrdersFragment, props.data);
  return (
    // render orders list
  )
};

function App() {
  const { data } = useQuery(GetUserQuery);
  return (
    {data && (
      <>
        {isFragmentReady(GetUserQuery, OrdersFragment, data)
					&& <OrdersList data={data} />}
      </>
    )}
  );
}
export default App;

#9304 e1dc75f3c Thanks @esfomeado! - Added support for disabling suffixes on Enums.

Patch Changes

Updated dependencies [4d9ea1a5a, 4d9ea1a5a, 4d9ea1a5a, f46803a8c, 3848a2b73, ba84a3a27, 63827fabe, 50471e651, 5aa95aa96, ca02ad172, e1dc75f3c, bb66c2a31, 5950f5a68, 5aa95aa96]:
- @graphql-codegen/plugin-helpers @5.0.0
- @graphql-codegen/schema-ast @4.0.0
- @graphql-codegen/visitor-plugin-common @4.0.0

dotansimha/graphql-code-generator (@graphql-codegen/typescript-operations)

`v4.0.0`

Compare Source

Major Changes

#9375 ba84a3a27 Thanks @eddeee888! - Implement Scalars with input/output types

In GraphQL, Scalar types can be different for client and server. For example, given the native GraphQL ID:

A client may send string or number in the input
A client receives string in its selection set (i.e output)
A server receives string in the resolver (GraphQL parses string or number received from the client to string)
A server may return string or number (GraphQL serializes the value to string before sending it to the client )

Currently, we represent every Scalar with only one type. This is what codegen generates as base type:

export type Scalars = {
  ID: string;
};

Then, this is used in both input and output type e.g.

export type Book = {
  __typename?: 'Book';
  id: Scalars['ID']; // Output's ID can be `string` 👍
};

export type QueryBookArgs = {
  id: Scalars['ID']; // Input's ID can be `string` or `number`. However, the type is only `string` here 👎
};

This PR extends each Scalar to have input and output:

export type Scalars = {
  ID: {
    input: string | number;
    output: string;
  };
};

Then, each input/output GraphQL type can correctly refer to the correct input/output scalar type:

export type Book = {
  __typename?: 'Book';
  id: Scalars['ID']['output']; // Output's ID can be `string` 👍
};

export type QueryBookArgs = {
  id: Scalars['ID']['input']; // Input's ID can be `string` or `number` 👍
};

Note that for typescript-resolvers, the type of ID needs to be inverted. However, the referenced types in GraphQL input/output types should still work correctly:

export type Scalars = {
  ID: {
    input: string;
    output: string | number;
  }
}

export type Book = {
  __typename?: "Book";
  id: Scalars["ID"]['output']; // Resolvers can return `string` or `number` in ID fields 👍
};

export type QueryBookArgs = {
  id: Scalars["ID"]['input']; // Resolvers receive `string` in ID fields 👍
};

export type ResolversTypes = {
  ID: ID: ResolverTypeWrapper<Scalars['ID']['output']>; // Resolvers can return `string` or `number` in ID fields 👍
}

export type ResolversParentTypes = {
  ID: Scalars['ID']['output']; // Resolvers receive `string` or `number` from parents 👍
};

Config changes:

Scalars option can now take input/output types:

config: {
  scalars: {
    ID: {
      input: 'string',
      output: 'string | number'
    }
  }
}

If a string is given (instead of an object with input/output fields), it will be used as both input and output types:

config: {
  scalars: {
    ID: 'string'; // This means `string` will be used for both ID's input and output types
  }
}

BREAKING CHANGE: External module Scalar types need to be an object with input/output fields

config: {
  scalars: {
    ID: './path/to/scalar-module';
  }
}

If correctly, wired up, the following will be generated:

// Previously, imported `ID` type can be a primitive type, now it must be an object with input/output fields
import { ID } from './path/to/scalar-module';

export type Scalars = {
  ID: { input: ID['input']; output: ID['output'] };
};

BREAKING CHANGE: This changes Scalar types which could be referenced in other plugins. If you are a plugin maintainer and reference Scalar, please update your plugin to use the correct input/output types.

bb66c2a31 Thanks @n1ru4l! - Require Node.js >= 16. Drop support for Node.js 14

Minor Changes

#9196 3848a2b73 Thanks @beerose! - Add @defer directive support

When a query includes a deferred fragment field, the server will return a partial response with the non-deferred fields first, followed by the remaining fields once they have been resolved.

Once start using the @defer directive in your queries, the generated code will automatically include support for the directive.

// src/index.tsx
import { graphql } from './gql';
const OrdersFragment = graphql(`
  fragment OrdersFragment on User {
    orders {
      id
      total
    }
  }
`);
const GetUserQuery = graphql(`
  query GetUser($id: ID!) {
    user(id: $id) {
      id
      name
      ...OrdersFragment @&#8203;defer
    }
  }
`);

The generated type for GetUserQuery will have information that the fragment is incremental, meaning it may not be available right away.

// gql/graphql.ts
export type GetUserQuery = { __typename?: 'Query'; id: string; name: string } & ({
  __typename?: 'Query';
} & {
  ' $fragmentRefs'?: { OrdersFragment: Incremental<OrdersFragment> };
});

Apart from generating code that includes support for the @defer directive, the Codegen also exports a utility function called isFragmentReady. You can use it to conditionally render components based on whether the data for a deferred
fragment is available:

const OrdersList = (props: { data: FragmentType<typeof OrdersFragment> }) => {
  const data = useFragment(OrdersFragment, props.data);
  return (
    // render orders list
  )
};

function App() {
  const { data } = useQuery(GetUserQuery);
  return (
    {data && (
      <>
        {isFragmentReady(GetUserQuery, OrdersFragment, data)
					&& <OrdersList data={data} />}
      </>
    )}
  );
}
export default App;

#9304 e1dc75f3c Thanks @esfomeado! - Added support for disabling suffixes on Enums.

Patch Changes

Updated dependencies [4d9ea1a5a, 4d9ea1a5a, f46803a8c, 3848a2b73, ba84a3a27, 63827fabe, 50471e651, 5aa95aa96, ca02ad172, e1dc75f3c, bb66c2a31, 5950f5a68, 5aa95aa96]:
- @graphql-codegen/plugin-helpers @5.0.0
- @graphql-codegen/visitor-plugin-common @4.0.0
- @graphql-codegen/typescript @4.0.0

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about these updates again.

If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

https://github.com/int128/hide-comment-action/actions/runs/5067172193

renovate · 2023-05-24T09:47:35Z

Edited/Blocked Notification

Renovate will not automatically rebase this PR, because it does not recognize the last commit author and assumes somebody else may have edited the PR.

You can manually request rebase by checking the rebase/retry box above.

⚠ Warning: custom changes will be lost.

Update graphqlcodegenerator monorepo to v4

0e56162

renovate bot added renovate renovate/@graphql-codegen/cli labels May 24, 2023

renovate bot assigned int128 May 24, 2023

renovate bot requested a review from int128 May 24, 2023 09:46

Generated by GitHub Actions (ts / generate)

8fab2b1

https://github.com/int128/hide-comment-action/actions/runs/5067172193

This comment has been minimized.

Sign in to view

Empty commit to trigger GitHub Actions

2464e14

This comment has been minimized.

Sign in to view

int128 merged commit 1387186 into main May 25, 2023

int128 deleted the renovate/major-graphqlcodegenerator-monorepo branch May 25, 2023 11:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update graphqlcodegenerator monorepo to v4 (major) #615

Update graphqlcodegenerator monorepo to v4 (major) #615

renovate bot commented May 24, 2023

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

renovate bot commented May 24, 2023

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

Update graphqlcodegenerator monorepo to v4 (major) #615

Update graphqlcodegenerator monorepo to v4 (major) #615

Conversation

renovate bot commented May 24, 2023

Release Notes

v4.0.0

Major Changes

Patch Changes

v4.0.0

Major Changes

Minor Changes

Patch Changes

v4.0.0

Major Changes

Minor Changes

Patch Changes

Configuration

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

renovate bot commented May 24, 2023

Edited/Blocked Notification

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

`v4.0.0`

`v4.0.0`

`v4.0.0`