added a default type weights configuration to the function parameters

Author: evanmcneely

src/analysis/buildTypeWeights.ts

@@ -13,7 +13,29 @@ interface TypeWeightObject {
     [index: string]: Type;
 }
 
-function buildTypeWeightsFromSchema(schema: GraphQLSchema): TypeWeightObject {
+interface TypeWeightConfig {
+    mutation?: number;
+    query?: number;
+    object?: number;
+    scalar?: number;
+    connection?: number;
+}
+
+/**
+ * The default type weights object is based off of Shopifys implewentation of query
+ * cost analysis. Our function should input a users configuration of type weights or fall
+ * back on shopifys on
+ */
+function buildTypeWeightsFromSchema(
+    schema: GraphQLSchema,
+    typeWeightsConfig: TypeWeightConfig = {
+        query: 1,
+        mutation: 10,
+        object: 1,
+        scalar: 0,
+        connection: 2,
+    }
+): TypeWeightObject {
     throw Error(`getTypeWeightsFromSchema is not implemented.`);
 }
 export default buildTypeWeightsFromSchema;

test/analysis/buildTypeWeights.test.ts

@@ -7,7 +7,16 @@ describe('Test buildTypeWeightsFromSchema function', () => {
         let schema: GraphQLSchema;
     });
 
-    test('creates the type weight object from graphql schema object', () => {});
+    describe('query types', () => {
+        // cretes type weight object from schema with multipl types
+        test('creates the type weight object from graphql schema object', () => {});
 
-    test('');
+        // creates tyep weight object from schema with nested types
+        test('');
+    });
+
+    /**
+     * Above tests are for query types only
+     * todo testing functionality for mutations, pagination, lists, etc. is not yet implemented
+     */
 });