allow adding extra types and change default CodeGen settings (#58)

.changeset/dry-mice-tickle.md

@@ -0,0 +1,5 @@
+---
+'@0no-co/graphqlsp': minor
+---
+
+Add new option named `extraTypes` which can be used to define an additional set of types to help with the `scalar` definitions

.changeset/mean-ladybugs-crash.md

@@ -0,0 +1,5 @@
+---
+'@0no-co/graphqlsp': minor
+---
+
+Change `avoidOptionals` to false in the base type generation

packages/graphqlsp/README.md

@@ -43,6 +43,7 @@ when on a TypeScript file or adding a file like [this](https://github.com/0no-co
 
 - `schema` allows you to specify a url, `.json` or `.graphql` file as your schema
 - `scalars` allows you to pass an object of scalars that we'll feed into `graphql-code-generator`
+- `extraTypes` allows you to specify imports or declare types to help with `scalar` definitions
 - `shouldCheckForColocatedFragments` when turned on (default), this will scan your imports to find
   unused fragments and provide a message notifying you about them
 

packages/graphqlsp/src/graphql/generateTypes.ts

@@ -6,30 +6,37 @@ import * as typescriptPlugin from '@graphql-codegen/typescript';
 import * as typescriptOperationsPlugin from '@graphql-codegen/typescript-operations';
 import * as typedDocumentNodePlugin from '@graphql-codegen/typed-document-node';
 import * as addPlugin from '@graphql-codegen/add';
-import { Logger } from '..';
 
 export const generateBaseTypes = async (
   schema: GraphQLSchema | null,
   outputFile: string,
-  scalars: Record<string, unknown>
+  scalars: Record<string, unknown>,
+  extraImports?: string
 ) => {
   if (!schema) return;
 
   const config = {
     documents: [],
     config: {
       scalars,
-      // nonOptionalTypename: true,
-      // avoidOptionals, worth looking into
+      avoidOptionals: false,
       enumsAsTypes: true,
       globalNamespace: true,
     },
     filename: outputFile,
     schema: parse(printSchema(schema)),
-    plugins: [{ typescript: {} }],
-    pluginMap: {
-      typescript: typescriptPlugin,
-    },
+    plugins: [
+      { typescript: {} },
+      extraImports && { add: { content: extraImports } },
+    ].filter(Boolean),
+    pluginMap: extraImports
+      ? {
+          typescript: typescriptPlugin,
+          add: addPlugin,
+        }
+      : {
+          typescript: typescriptPlugin,
+        },
   };
 
   // @ts-ignore
@@ -74,11 +81,8 @@ export const generateTypedDocumentNodes = async (
     config: {
       namespacedImportName: 'Types',
       scalars,
-      // nonOptionalTypename: true,
-      // avoidOptionals, worth looking into
+      avoidOptionals: false,
       enumsAsTypes: true,
-      dedupeOperationSuffix: true,
-      dedupeFragments: true,
     },
     filename: outputFile,
     schema: parse(printSchema(schema)),

packages/graphqlsp/src/graphql/getSchema.ts

@@ -17,7 +17,8 @@ export const loadSchema = (
   schema: string,
   logger: Logger,
   baseTypesPath: string,
-  scalars: Record<string, unknown>
+  scalars: Record<string, unknown>,
+  extraImports?: string
 ): { current: GraphQLSchema | null } => {
   const ref: { current: GraphQLSchema | null } = { current: null };
   let url: URL | undefined;

packages/graphqlsp/src/index.ts

@@ -31,6 +31,7 @@ function create(info: ts.server.PluginCreateInfo) {
   logger('Setting up the GraphQL Plugin');
 
   const scalars = info.config.scalars || {};
+  const extraImports = info.config.extraImports;
 
   const proxy = createBasicDecorator(info);
 
@@ -42,7 +43,8 @@ function create(info: ts.server.PluginCreateInfo) {
     info.config.schema,
     logger,
     baseTypesPath,
-    scalars
+    scalars,
+    extraImports
   );
 
   proxy.getSemanticDiagnostics = (filename: string): ts.Diagnostic[] => {