feat: predefined scalars

Co-authored-by: Ovidiu Popoviciu <[email protected]>

src/generate/parse-graphql/getScalars.spec.ts

@@ -53,3 +53,31 @@ test('ignore built-in Upload scalar', () => {
 
   expect(res).toEqual(['First', 'ThirdOne']);
 });
+
+test('ignore predefined scalars', () => {
+  const schemaString = gql`
+    type TodoItem @key(fields: "id") {
+      id: ID!
+      list: List
+    }
+
+    extend type List {
+      id: ID!
+      todos: [TodoItem!]!
+      incompleteCount: Int!
+    }
+
+    type InMemory {
+      id: ID!
+    }
+
+    scalar First
+    scalar Predefined @predefined
+    scalar Upload
+    scalar ThirdOne
+  `;
+
+  const res = getScalars(schemaString);
+
+  expect(res).toEqual(['First', 'ThirdOne']);
+});

src/generate/parse-graphql/getScalars.ts

@@ -1,15 +1,20 @@
 import gql from 'graphql-tag';
+import { ScalarTypeDefinitionNode } from 'graphql/language/ast';
 
 export default (graphqlString: string): string[] => {
   const graphqlAST = gql`
     ${graphqlString}
   `;
 
-  return (
-    graphqlAST.definitions
-      .filter((d) => d.kind === 'ScalarTypeDefinition')
-      // @ts-ignore
-      .map((f) => f.name.value)
-      .filter((s) => s !== 'Upload')
-  );
+  return (graphqlAST.definitions.filter((d) => d.kind === 'ScalarTypeDefinition') as ScalarTypeDefinitionNode[])
+    .filter((d) => {
+      const isPredefined = Boolean(
+        d.directives?.find((directive) => {
+          return directive.name.value === 'predefined';
+        }),
+      );
+      return !isPredefined;
+    })
+    .map((f) => f.name.value)
+    .filter((s) => s !== 'Upload');
 };

src/generate/templates/genericDataModelSchema.graphql

@@ -28,3 +28,5 @@ directive @requires(fields: _FieldSet!) on FIELD_DEFINITION
 directive @provides(fields: _FieldSet!) on FIELD_DEFINITION
 directive @key(fields: _FieldSet!) on OBJECT | INTERFACE
 directive @extends on OBJECT
+
+directive @predefined on SCALAR