release support for index queryField (#317)

* fix: include queryField when mapping index to key (#313)

* fix: update codegen models to use v2 schema shapes (#316)

Co-authored-by: Edward Foyle <[email protected]>

Author: alharris-at

packages/amplify-codegen-e2e-tests/schemas/modelgen/model_gen_schema_with_aws_scalars.graphql

@@ -31,24 +31,24 @@ type User @model {
 type Post @model {
   title: String!
   content: String
-  comments: [Comment] @connection(name: "PostComment")
+  comments: [Comment] @hasMany
 }
 
 type Comment @model {
   comment: String!
-  post: Post @connection(name: "PostComment")
+  post: Post @belongsTo
 }
 
 # 1:1 Connection
 
 type Person @model {
   id: ID!
   name: String!
-  license: License @connection
+  license: License @hasOne
 }
 
 type License @model {
   id: ID!
   number: String!
-  belongsTo: Person @connection
+  belongsTo: Person @belongsTo
 }

packages/appsync-modelgen-plugin/src/__tests__/utils/process-index.test.ts

@@ -219,4 +219,49 @@ describe('processIndex', () => {
     processIndex(model);
     expect(model.directives.length).toBe(3);
   });
+
+  it('adds index with queryFields', () => {
+    const model: CodeGenModel = {
+      directives: [
+        {
+          name: 'model',
+          arguments: {},
+        },
+      ],
+      name: 'testModel',
+      type: 'model',
+      fields: [
+        {
+          type: 'field',
+          isList: false,
+          isNullable: true,
+          name: 'testField',
+          directives: [
+            {
+              name: 'index',
+              arguments: {
+                queryField: 'myQuery',
+                name: 'byItem',
+              },
+            },
+          ],
+        },
+      ],
+    };
+    processIndex(model);
+    expect(model.directives).toEqual([
+      {
+        name: 'model',
+        arguments: {},
+      },
+      {
+        name: 'key',
+        arguments: {
+          name: 'byItem',
+          queryField: 'myQuery',
+          fields: ['testField'],
+        },
+      },
+    ]);
+  });
 });

packages/appsync-modelgen-plugin/src/__tests__/visitors/appsync-visitor.test.ts

@@ -411,6 +411,26 @@ describe('AppSyncModelVisitor', () => {
         },
       });
     });
+
+    it('processes index with queryField', () => {
+      const schema = /* GraphQL */ `
+        type Project @model {
+          id: ID!
+          name: String @index(name: "nameIndex", queryField: "myQuery")
+        }
+      `;
+      const visitor = createAndGenerateVisitor(schema, true);
+      visitor.generate();
+      const projectKeyDirective = visitor.models.Project.directives.find(directive => directive.name === 'key');
+      expect(projectKeyDirective).toEqual({
+        name: 'key',
+        arguments: {
+          name: 'nameIndex',
+          queryField: 'myQuery',
+          fields: ['name'],
+        },
+      });
+    });
   });
 
   describe('auth directive', () => {

packages/appsync-modelgen-plugin/src/utils/process-index.ts

@@ -18,6 +18,7 @@ export const processIndex = (model: CodeGenModel) => {
     name: 'key',
     arguments: {
       name: directive.arguments.name,
+      queryField: directive.arguments.queryField,
       fields: [fieldName].concat((directive.arguments.sortKeyFields as string[]) ?? []),
     },
   }));