@toptal/davinci-graphql-codegen 4.1.9-alpha-cp-rename-root-libs-in-codeowners-2872dfb9.15 → 5.0.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @toptal/davinci-graphql-codegen
 
+## 5.0.0
+
+### Major Changes
+
+- [#2474](https://github.com/toptal/davinci/pull/2474) [`d133536b`](https://github.com/toptal/davinci/commit/d133536be3c7c8c82020e17b58169cd2650f9e75) Thanks [@sashuk](https://github.com/sashuk)!
+- breaking change: the configuration format for `generate-schema` and `generate-operations` is now restricted to the structure described in the README. This change is necessary to ensure that the tool can be used in a consistent manner across all packages. In case of any issues, please rework your configuration or extend the tool to support your use case.
+  - breaking change: the `preset` configuration key has been deleted from the `generate-operations` configuration (it is always set to `near-operation-file`). Please delete it to avoid the configuration validation error.
+
+### Patch Changes
+
+- Updated dependencies [[`74c9bb18`](https://github.com/toptal/davinci/commit/74c9bb1818fee5b314674e308ea3bef3f572c7fe)]:
+  - @toptal/davinci-monorepo@9.0.0
+
 ## 4.1.8
 
 ### Patch Changes

package/README.md

@@ -1,10 +1,10 @@
 # ⚛ GraphQL Codegen
 
-GraphQL Codegen is a library developed by Toptal with the idea in mind of improving DX when generating types for your application. Easy to configure (almost no-config) and extend, and easy to import and use. With this library you'd be able to generate types for all your schemas without worring much about implementation details, and if you need to customize or use a specific plugin to suit your needs, it would be piece of cake just by adding the plugin name to the config (package specific or global).
+GraphQL Codegen is a library developed by Toptal with the idea in mind of improving DX when generating types for your application. Easy to configure (almost no-config) and extend, and easy to import and use. With this library you'd be able to generate types for all your schemas without worrying much about implementation details, and if you need to customize or use a specific plugin to suit your needs, it would be piece of cake just by adding the plugin name to the config (package specific or global).
 
 # 🛠 Generating Schema Types
 
-In order to generate schema types for your GraphQL Gateway the reccomended way is that you create a `lib/graphql` package in your monorepo and create a `codegen.json` file were you will store some configuration needed for later usage. This file will contain a structure like the following<sup>1</sup>:
+In order to generate schema types for your GraphQL Gateway the recommended way is that you create a `lib/graphql` package in your monorepo and create a `codegen.json` file were you will store some configuration needed for later usage. This file will contain a structure like the following<sup>1</sup>:
 
 ```json
 [
@@ -26,16 +26,27 @@ In order to generate schema types for your GraphQL Gateway the reccomended way i
 ]
 ```
 
-The array contains many objects with the following shape:
+The array contains configuration objects specified below (please note that any other configuration options are prohibited):
 
 ```ts
 {
   schema: string
   target: string
+  plugins?: Array<any>
+  config?: {
+    skipTypename?: boolean
+    scalars?: Record<string, string>
+  }
 }
 ```
 
-The `schema` property will point to a protocol (https:// or gs://) or a relative path where the schema will be fetched from. The `target` property will indicate where the schema is going to be stored.
+The `schema` property specifies a protocol (https:// or gs://) or a relative path where the schema will be fetched from.
+
+The `target` property indicates where the schema is going to be stored.
+
+The `plugins` property is optional. The property contains array of [additional plugins](https://the-guild.dev/graphql/codegen/plugins).
+
+The `config.skipTypename` and `config.scalars` properties are optional and affect schema generation [the same way as documented](https://the-guild.dev/graphql/codegen/plugins/typescript/typescript-operations).
 
 ![Captura de pantalla 2021-10-11 a las 11 03 00](https://user-images.githubusercontent.com/9496960/136763291-7ab3f50e-17e0-4fc8-a4b5-965cc15ac0fd.png)
 
@@ -60,9 +71,32 @@ In order to generate operation types for your GraphQL Gateway, you'd need to add
 Then create a `codegen.json` file at the root folder of your package that contains the following data/structure:
 
 ```json
-{
+[{
   "schema": "@toptal/modularity-template-graphql/talent",
   "documents": "src/**/*.gql"
+}]
+```
+
+The array contains configuration objects specified below (please note that any other configuration options are prohibited):
+
+```ts
+{
+  schema: string,
+  documents: string,
+  plugins?: Array<string | {
+    add: { content: string },
+  }>,
+  config?: {
+    documentMode?: string,
+    skipTypename?: boolean,
+    skipTypeNameForRoot?: boolean,
+    avoidOptionals?: boolean,
+    dedupeOperationSuffix?: boolean,
+    useTypeImports?: boolean,
+    inlineFragmentTypes?: string,
+    dedupeFragments?: boolean,
+    scalars: Record<string, string>,
+  },
 }
 ```
 
@@ -70,6 +104,12 @@ The `schema` property in the `codegen.json` file is where this utility is going
 
 The `documents` property is a `glob pattern` that tells this utility where your GraphQL operations are located. Please note that this `glob pattern` does not start with `./` as we use `process.env.INIT_CWD` to resolve where this utility was launched from and therefore, using `./src/**/*.gql` will break the implementation and won't be able to resolve your files.
 
+The `plugins` property is optional. By default, configuration uses `typescript-operations` and `typed-document-node` plugins, and prepends every generated file with `/* eslint-disable */ /* ⚠️ THIS IS AN AUTOGENERATED FILE, DO NOT EDIT ⚠️  */` string (set via `{ add: { content: string } }` configuration).
+
+The `config` property is also optional. See corresponding documentation of [typescript-operations](https://the-guild.dev/graphql/codegen/plugins/typescript/typescript-operations) and [typed-document-node](https://the-guild.dev/graphql/codegen/plugins/typescript/typed-document-node) plugins for more information about these options.
+
+GraphQL Codegen uses `near-operation-file` preset.
+
 # ⚙️ Customizing GraphQL Codegen
 
 GraphQL Codegen is an extensible and configurable tool that gives you the ability to customize many different things to suit your project needs.
@@ -84,26 +124,6 @@ yarn davinci-graphql-codegen generate-schema --config=./graphql/codegen-schema.j
 
 The above script will search for `codegen-schema.json` within `./graphql`.
 
-## Using custom config
-
-To override default configuration, `preset`, `presetConfig`, `plugins`, and `config` options can be added to `codegen.json`.
-
-```json
-// codegen.json
-[
-  {
-    "schema": "@toptal/modularity-template-graphql/talent",
-    "documents": "src/**/*.gql",
-    "preset": "...",
-    "presetConfig": { ... },
-    "plugins": [ ... ],
-    "config": { ... }
-  }
-]
-```
-
-> Please see the https://the-guild.dev/graphql/codegen/docs/config-reference/codegen-config for more information about these options.
-
 ## Customizing the extension of generated files
 
 When generating operations, we have set a default setting that generates your operation types within a file named the same as where your query or mutation is and it will have the `.ts` extension. This is due to that the default extension for your queries or mutations should be `.graphql`. But you might have your query within a `.ts` file that comes with, for instance, a hook that makes use of this query, and if you'd run GraphQL Codegen Operations as is, you'll have that `.ts` file ovewriten. But you can avoid this conflict via CLI with the following command:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-graphql-codegen",
-  "version": "4.1.9-alpha-cp-rename-root-libs-in-codeowners-2872dfb9.15+2872dfb9",
+  "version": "5.0.0",
   "description": "Codegen",
   "author": "Toptal",
   "license": "SEE LICENSE IN LICENSE.MD",
@@ -35,9 +35,10 @@
     "@graphql-tools/load": "^8.0.2",
     "@graphql-tools/schema": "^9.0.19",
     "@graphql-typed-document-node/core": "^3.2.0",
-    "@toptal/davinci-cli-shared": "2.5.1-alpha-cp-rename-root-libs-in-codeowners-2872dfb9.55+2872dfb9",
-    "@toptal/davinci-graphql-codegen-extensions": "1.0.6-alpha-cp-rename-root-libs-in-codeowners-2872dfb9.21+2872dfb9",
-    "@toptal/davinci-monorepo": "8.5.3-alpha-cp-rename-root-libs-in-codeowners-2872dfb9.1+2872dfb9",
+    "@toptal/davinci-cli-shared": "^2.5.0",
+    "@toptal/davinci-graphql-codegen-extensions": "1.0.5",
+    "@toptal/davinci-monorepo": "^9.0.0",
+    "ajv": "8.17.1",
     "babel-plugin-extract-export": "^0.1.0",
     "chalk": "^4.1.2",
     "deepmerge": "^4.2.2",
@@ -58,6 +59,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "sideEffects": false,
-  "gitHead": "2872dfb937ff4735bc5ff853a55f44756ff65296"
+  "sideEffects": false
 }

package/src/commands/generate-operations.js

@@ -4,6 +4,7 @@ import { createOption } from '@toptal/davinci-cli-shared'
 import { generateOperations } from '../generate/index.js'
 import readConfig from '../read-config/index.js'
 import { getConfigurationType } from '../services/get-configutation-type.js'
+import { validateGenerateOperationsConfiguration } from '../utils/validate-configuration/index.js'
 
 const codegenGenerateOperations = async ({
   config,
@@ -18,11 +19,11 @@ const codegenGenerateOperations = async ({
 
   for (const codegenConfiguration of codegenConfigurations) {
     if (getConfigurationType(codegenConfiguration) === 'operations') {
+      validateGenerateOperationsConfiguration(codegenConfiguration)
+
       const {
         schema,
         documents,
-        preset,
-        presetConfig,
         plugins,
         config: customConfig = {},
       } = codegenConfiguration
@@ -30,8 +31,6 @@ const codegenGenerateOperations = async ({
       await generateOperations({
         schema,
         documents,
-        preset,
-        presetConfig,
         plugins,
         extension,
         experiments,

package/src/commands/generate-schema.js

@@ -3,6 +3,7 @@ import chalk from 'chalk'
 import { generateSchema } from '../generate/index.js'
 import readConfig from '../read-config/index.js'
 import { getConfigurationType } from '../services/get-configutation-type.js'
+import { validateGenerateSchemaConfiguration } from '../utils/validate-configuration/index.js'
 
 const codegenGenerateSchema = async ({ projectId, config, verbose }) => {
   process.env.VERBOSE = verbose
@@ -11,6 +12,8 @@ const codegenGenerateSchema = async ({ projectId, config, verbose }) => {
 
   for (const codegenConfiguration of codegenConfigurations) {
     if (getConfigurationType(codegenConfiguration) === 'schema') {
+      validateGenerateSchemaConfiguration(codegenConfiguration)
+
       const {
         schema,
         documents,

package/src/generate/operations.js

@@ -19,8 +19,6 @@ const { readFileSync, writeFileSync } = fsExtra
 const generateOperations = async ({
   schema,
   documents,
-  preset,
-  presetConfig,
   plugins,
   extension,
   experiments,
@@ -64,8 +62,8 @@ const generateOperations = async ({
     generates: {
       [schemaPath]: {
         schema: schemasPathResoltuions,
-        preset: preset || 'near-operation-file',
-        presetConfig: presetConfig || {
+        preset: 'near-operation-file',
+        presetConfig: {
           extension,
           baseTypesPath: `~${primarySchema}/${schemaName}`,
         },

package/src/generate/schema.js

@@ -55,7 +55,7 @@ const generateSchema = async ({
           },
           ...additionalPlugins,
         ],
-        config
+        config,
       },
     },
     hooks: {

package/src/utils/validate-configuration/index.js

@@ -0,0 +1,7 @@
+import validateGenerateSchemaConfiguration from './validate-generate-schema-configuration.js'
+import validateGenerateOperationsConfiguration from './validate-generate-operations-configuration.js'
+
+export {
+  validateGenerateSchemaConfiguration,
+  validateGenerateOperationsConfiguration,
+}

package/src/utils/validate-configuration/validate-against-schema.js

@@ -0,0 +1,17 @@
+import Ajv from 'ajv'
+
+const validateAgainstSchema = (schema, validatedObject) => {
+  const ajv = new Ajv({
+    allowUnionTypes: true,
+  })
+
+  const validate = ajv.compile(schema)
+  const valid = validate(validatedObject)
+
+  return {
+    valid,
+    errorsText: ajv.errorsText(validate.errors),
+  }
+}
+
+export default validateAgainstSchema

package/src/utils/validate-configuration/validate-generate-operations-configuration.js

@@ -0,0 +1,61 @@
+import validateAgainstSchema from './validate-against-schema.js'
+
+const schema = {
+  type: 'object',
+  properties: {
+    schema: { type: ['string', 'array'] },
+    documents: { type: ['string', 'array'] },
+    plugins: {
+      type: 'array',
+      items: {
+        oneOf: [
+          {
+            type: 'string',
+          },
+          {
+            type: 'object',
+            properties: {
+              add: {
+                type: 'object',
+                properties: {
+                  content: { type: 'string' },
+                },
+                required: ['content'],
+              },
+            },
+            required: ['add'],
+          },
+        ],
+      },
+    },
+    config: {
+      type: 'object',
+      properties: {
+        documentMode: { type: 'string' },
+        skipTypename: { type: 'boolean' },
+        skipTypeNameForRoot: { type: 'boolean' },
+        avoidOptionals: { type: 'boolean' },
+        dedupeOperationSuffix: { type: 'boolean' },
+        useTypeImports: { type: 'boolean' },
+        inlineFragmentTypes: { type: 'string' },
+        dedupeFragments: { type: 'boolean' },
+        scalars: { type: 'object' },
+      },
+      additionalProperties: false,
+    },
+  },
+  required: ['schema', 'documents'],
+  additionalProperties: false,
+}
+
+const validateConfiguration = config => {
+  const { valid, errorsText } = validateAgainstSchema(schema, config)
+
+  if (!valid) {
+    throw new Error(
+      `Invalid configuration for generate-operations: ${errorsText}`
+    )
+  }
+}
+
+export default validateConfiguration

package/src/utils/validate-configuration/validate-generate-operations-configuration.test.js

@@ -0,0 +1,74 @@
+import validateConfiguration from './validate-generate-operations-configuration.js'
+
+describe('validate generate-operations configuration', () => {
+  describe('when configuration contains unexpected top-level key', () => {
+    it('throws an error', () => {
+      const config = {
+        schema: 'schema.graphql',
+        documents: 'documents.graphql',
+        config: {},
+        unexpectedKey: 'unexpected value',
+      }
+
+      expect(() => {
+        validateConfiguration(config)
+      }).toThrow(
+        'Invalid configuration for generate-operations: data must NOT have additional properties'
+      )
+    })
+  })
+
+  describe('when configuration contains unexpected format of plugins object', () => {
+    describe('when plugins is not an array', () => {
+      it('throws an error', () => {
+        const config = {
+          schema: 'schema.graphql',
+          documents: 'documents.graphql',
+          plugins: 'unexpected value',
+        }
+
+        expect(() => {
+          validateConfiguration(config)
+        }).toThrow(
+          'Invalid configuration for generate-operations: data/plugins must be array'
+        )
+      })
+    })
+
+    describe('when plugins is an array with unexpected format', () => {
+      it('throws an error', () => {
+        const config = {
+          schema: 'schema.graphql',
+          documents: 'documents.graphql',
+          config: {},
+          plugins: [{ test: 'abc123 ' }],
+        }
+
+        expect(() => {
+          validateConfiguration(config)
+        }).toThrow(
+          "Invalid configuration for generate-operations: data/plugins/0 must be string, data/plugins/0 must have required property 'add', data/plugins/0 must match exactly one schema in oneOf"
+        )
+      })
+    })
+  })
+
+  describe('when configuration contains unexpected config object key', () => {
+    it('throws an error', () => {
+      const config = {
+        schema: 'schema.graphql',
+        documents: 'documents.graphql',
+        config: {
+          skipTypename: true,
+          unexpectedKey: 'unexpected value',
+        },
+      }
+
+      expect(() => {
+        validateConfiguration(config)
+      }).toThrow(
+        'Invalid configuration for generate-operations: data/config must NOT have additional properties'
+      )
+    })
+  })
+})

package/src/utils/validate-configuration/validate-generate-schema-configuration.js

@@ -0,0 +1,44 @@
+import validateAgainstSchema from './validate-against-schema.js'
+
+const schema = {
+  type: 'object',
+  properties: {
+    schema: {
+      type: 'string',
+    },
+    target: {
+      type: 'string',
+    },
+    plugins: {
+      type: 'array',
+      items: {},
+    },
+    config: {
+      type: 'object',
+      properties: {
+        skipTypename: {
+          type: 'boolean',
+        },
+        scalars: {
+          type: 'object',
+          additionalProperties: {
+            type: 'string',
+          },
+        },
+      },
+      additionalProperties: false,
+    },
+  },
+  required: ['schema', 'target'],
+  additionalProperties: false,
+}
+
+const validateConfiguration = config => {
+  const { valid, errorsText } = validateAgainstSchema(schema, config)
+
+  if (!valid) {
+    throw new Error(`Invalid configuration for generate-schema: ${errorsText}`)
+  }
+}
+
+export default validateConfiguration

package/src/utils/validate-configuration/validate-generate-schema-configuration.test.js

@@ -0,0 +1,39 @@
+import validateConfiguration from './validate-generate-schema-configuration.js'
+
+describe('validate generate-schema configuration', () => {
+  describe('when configuration contains unexpected top-level key', () => {
+    it('throws an error', () => {
+      const config = {
+        schema: 'schema.graphql',
+        target: 'typescript',
+        config: {},
+        unexpectedKey: 'unexpected value',
+      }
+
+      expect(() => {
+        validateConfiguration(config)
+      }).toThrow(
+        'Invalid configuration for generate-schema: data must NOT have additional properties'
+      )
+    })
+  })
+
+  describe('when configuration contains unexpected config object key', () => {
+    it('throws an error', () => {
+      const config = {
+        schema: 'schema.graphql',
+        target: 'typescript',
+        config: {
+          skipTypename: true,
+          unexpectedKey: 'unexpected value',
+        },
+      }
+
+      expect(() => {
+        validateConfiguration(config)
+      }).toThrow(
+        'Invalid configuration for generate-schema: data/config must NOT have additional properties'
+      )
+    })
+  })
+})