feat: support iteration fields (#95)

Following the issue #94 I
created, here is the start of solution.

I'm not used to Typescript so sorry if I make rookie mistakes. :)

Closes #94

---------

Co-authored-by: Gregor Martynus <[email protected]>

Author: blombard

api/lib/item-fields-nodes-to-fields-map.js

@@ -43,8 +43,7 @@ function projectFieldValueNodeToValue(projectField, node) {
       return projectField.optionsById[node.optionId];
     case "ProjectV2ItemFieldTextValue":
       return node.text;
-    // TODO: implement iteration fields
-    // case "ProjectV2ItemFieldIterationValue":
-    // return null;
+    case "ProjectV2ItemFieldIterationValue":
+      return node.title;
   }
 }

api/lib/project-fields-nodes-to-fields-map.js

@@ -129,6 +129,28 @@ export function projectFieldsNodesToFieldsMap(state, project, nodes) {
         );
       }
 
+      // If the field is of type "Iteration", then the `configuration` property will be set.
+      if (node.configuration) {
+        acc[userFieldNameAlias].optionsById = node.configuration.iterations.concat(node.configuration.completedIterations).reduce(
+          (acc, option) => {
+            return {
+              ...acc,
+              [option.id]: option.title,
+            };
+          },
+          {}
+        );
+        acc[userFieldNameAlias].optionsByValue = node.configuration.iterations.concat(node.configuration.completedIterations).reduce(
+          (acc, option) => {
+            return {
+              ...acc,
+              [option.title]: option.id,
+            };
+          },
+          {}
+        );
+      }
+
       return acc;
     },
     optionalFields

api/lib/queries.js

@@ -53,11 +53,13 @@ const queryProjectNodes = `
       ... on ProjectV2IterationField {
         configuration {
           iterations {
+            id
             title
             duration
             startDate
           }
           completedIterations {
+            id
             title
             duration
             startDate
@@ -186,7 +188,7 @@ export const getProjectItemsPaginatedQuery = `
               ${queryItemFieldNodes}
             }
           }
-        } 
+        }
       }
     }
   }

index.d.ts

@@ -241,6 +241,24 @@ export type ProjectFieldNode = {
    * `options` is only set on `ProjectV2SingleSelectField`
    */
   options?: { id: string; name: string }[];
+
+  /**
+   * `configuration` is only set on `ProjectV2IterationField`
+   */
+  configuration?: {
+    iterations: {
+      id: string;
+      title: string;
+      duration: number;
+      startDate: string;
+    }[];
+    completedIterations: {
+      id: string;
+      title: string;
+      duration: number;
+      startDate: string;
+    }[];
+  };
 };
 
 export type ProjectField =

test/recorded/api.items.update-iteration/fixtures.json

@@ -0,0 +1,34 @@
+// @ts-check
+
+/**
+ * Prepare state in order to record fixtures for test.js. Returns array of arguments that will be passed
+ * passed as `test(project, ...arguments)`.
+ *
+ * @param {import("@octokit/openapi-types").components["schemas"]["repository"]} repository
+ * @param {import("@octokit/core").Octokit} octokit
+ * @param {import("../../..").default<{text: string, number: number, date: string, singleSelect: "One" | "Two" | "Three", iteration: "Iteration 1" | "Iteration 2" | "Iteration 3"}>} project
+ * @returns {Promise<[string]>}
+ */
+export async function prepare(repository, octokit, project) {
+  // create a test issue
+  const { data: issue } = await octokit.request(
+    "POST /repos/{owner}/{repo}/issues",
+    {
+      owner: repository.owner.login,
+      repo: repository.name,
+      title: "Issue",
+      body: "This is a test issue",
+    }
+  );
+
+  // add issue to project
+  const item = await project.items.add(issue.node_id, {
+    text: "text",
+    number: "1",
+    date: new Date("2020-02-02").toISOString(),
+    singleSelect: "One",
+    iteration: "Iteration 1",
+  });
+
+  return [item.id];
+}

test/recorded/api.items.update-iteration/prepare.js

@@ -0,0 +1,20 @@
+// @ts-check
+
+import GitHubProject from "../../../index.js";
+
+/**
+ * @param {import("../../../").default} defaultTestProject
+ * @param {string} [itemId]
+ */
+export function test(defaultTestProject, itemId = "PVTI_1") {
+  const project = new GitHubProject({
+    owner: defaultTestProject.owner,
+    number: defaultTestProject.number,
+    octokit: defaultTestProject.octokit,
+    fields: {
+      iteration: "Iteration",
+    },
+  });
+
+  return project.items.update(itemId, { iteration: "Iteration 2" });
+}

test/recorded/api.items.update-iteration/test.js

@@ -15,6 +15,6 @@ export function test(defaultTestingProject, itemId = "PVTI_1") {
       "🎯text": "Text",
     },
   });
-  
+
   return project.items.update(itemId, { "🎯text": "new text" });
 }

test/recorded/api.items.update-with-emoji-alias/test.js

@@ -7177,6 +7177,33 @@ Generated by [AVA](https://avajs.dev).
       type: 'ISSUE',
     }
 
+## api.items.update-iteration
+
+> Snapshot 1
+
+    {
+      content: {
+        assignees: [],
+        closed: false,
+        closedAt: undefined,
+        createdAt: '2022-02-02T12:00:00Z',
+        databaseId: 1001,
+        id: 'I_1',
+        labels: [],
+        milestone: null,
+        number: 1,
+        repository: 'test-repository',
+        title: 'Issue',
+        url: 'https://github.com/github-project-fixtures/test-repository/issues/1',
+      },
+      fields: {
+        iteration: 'Iteration 2',
+      },
+      id: 'PVTI_1',
+      isArchived: false,
+      type: 'ISSUE',
+    }
+
 ## api.items.update-not-found
 
 > Snapshot 1