feat: item.type se to "DRAFT_ISSUE" when item is a draft

README.md

@@ -19,10 +19,10 @@
 Browsers
 </th><td width=100%>
 Load <code>github-project</code> directly from <a href="https://cdn.skypack.dev">cdn.skypack.dev</a>
-        
+
 ```html
 <script type="module">
-import GitHubProject from "https://cdn.skypack.dev/github-project";
+  import GitHubProject from "https://cdn.skypack.dev/github-project";
 </script>
 ```
 
@@ -66,7 +66,7 @@ for (const item of items) {
     item.fields.title,
     item.fields.dueAt,
     item.fields.priority,
-    item.isDraft
+    item.type === "DRAFT_ISSUE"
       ? "_draft_"
       : item.content.assignees.map(({ login }) => login).join(",")
   );

api/items.get-by-content-repository-and-number.js

@@ -21,7 +21,7 @@ export async function getItemByContentRepositoryAndNumber(
   const stateWithItems = await getStateWithProjectItems(project, state);
 
   return stateWithItems.items.find((item) => {
-    if (item.isDraft === true) return;
+    if (item.type === "DRAFT_ISSUE") return;
 
     return (
       item.content.repository === repositoryName &&

api/items.remove-by-content-repository-and-name.js

@@ -22,7 +22,7 @@ export async function removeItemByContentRepositoryAndNumber(
   const stateWithItems = await getStateWithProjectItems(project, state);
 
   const existingItem = stateWithItems.items.find((item) => {
-    if (item.isDraft === true) return;
+    if (item.type === "DRAFT_ISSUE") return;
 
     return (
       item.content.repository === repositoryName &&

api/items.update-by-content-repository-and-number.js

@@ -25,7 +25,7 @@ export async function updateItemByContentRepositoryAndNumber(
   const stateWithItems = await getStateWithProjectItems(project, state);
 
   const item = stateWithItems.items.find((item) => {
-    if (item.isDraft === true) return;
+    if (item.type === "DRAFT_ISSUE") return;
 
     return (
       item.content.repository === repositoryName &&

api/lib/project-item-node-to-github-project-item.js

@@ -14,12 +14,11 @@ export function projectItemNodeToGitHubProjectItem(state, itemNode) {
   const fields = itemFieldsNodesToFieldsMap(state, itemNode.fieldValues.nodes);
 
   // item is draft
-  if (!itemNode.content || itemNode.type === 'DRAFT_ISSUE') {
+  if (!itemNode.content || itemNode.type === "DRAFT_ISSUE") {
     return {
       id: itemNode.id,
       type: itemNode.type,
       fields,
-      isDraft: true,
     };
   }
 
@@ -55,7 +54,6 @@ export function projectItemNodeToGitHubProjectItem(state, itemNode) {
     id: itemNode.id,
     type: itemNode.type,
     fields,
-    isDraft: false,
     // @ts-expect-error - complains about `.merged` property
     content,
   };

index.d.ts

@@ -97,13 +97,11 @@ type DraftItem<TFields> = {
   id: string;
   type: "DRAFT_ISSUE";
   fields: TFields;
-  isDraft: true;
 };
 type NonDraftItem<TFields> = {
   id: string;
   type: "ISSUE" | "PULL_REQUEST" | "REDACTED";
   fields: TFields;
-  isDraft: false;
   content: Issue | PullRequest;
 };
 

index.test-d.ts

@@ -75,12 +75,12 @@ export async function listItemsTest() {
   });
   const [item] = await project.items.list();
 
-  if (item.isDraft === true) {
+  if (item.type === "DRAFT_ISSUE") {
     expectType<string>(item.id);
     expectType<string | null>(item.fields.title);
     expectNotType<"Title">(item.fields.title);
 
-    // @ts-expect-error - `.content` is not set if `.isDraft` is true
+    // @ts-expect-error - `.content` is not set if `.type` is "DRAFT_ISSUE"
     item.content;
   } else {
     expectType<string>(item.id);
@@ -100,7 +100,7 @@ export async function addItemTest() {
   const item = await project.items.add("issue node_id");
 
   expectType<string>(item.id);
-  expectType<false>(item.isDraft);
+  expectNotType<"DRAFT_ISSUE">(item.type);
   expectType<string | null>(item.fields.title);
   expectNotType<"Title">(item.fields.title);
 
@@ -121,7 +121,7 @@ export async function addItemWithFieldsTest() {
   });
 
   expectType<string>(item.id);
-  expectType<false>(item.isDraft);
+  expectNotType<"DRAFT_ISSUE">(item.type);
   expectType<string | null>(item.fields.title);
   expectNotType<"Title">(item.fields.title);
   expectType<string | null>(item.fields.myField);
@@ -148,7 +148,7 @@ export async function getItemTest() {
     return;
   }
 
-  if (item.isDraft === true) {
+  if (item.type === "DRAFT_ISSUE") {
     expectType<string>(item.id);
     expectType<string | null>(item.fields.title);
     expectNotType<"Title">(item.fields.title);
@@ -157,7 +157,7 @@ export async function getItemTest() {
     // @ts-expect-error any Property 'notField' does not exist on type
     item.fields.notField;
 
-    // @ts-expect-error - `.content` is not set if `.isDraft` is true
+    // @ts-expect-error - `.content` is not set if `.type` is "DRAFT_ISSUE"
     item.content;
   } else {
     expectType<string>(item.id);
@@ -185,7 +185,7 @@ export async function getItemByContentIdTest() {
     return;
   }
 
-  if (item.isDraft === true) {
+  if (item.type === "DRAFT_ISSUE") {
     expectType<string>(item.id);
     expectType<string | null>(item.fields.title);
     expectNotType<"Title">(item.fields.title);
@@ -194,7 +194,7 @@ export async function getItemByContentIdTest() {
     // @ts-expect-error any Property 'notField' does not exist on type
     item.fields.notField;
 
-    // @ts-expect-error - `.content` is not set if `.isDraft` is true
+    // @ts-expect-error - `.content` is not set if `.type` is "DRAFT_ISSUE"
     item.content;
   } else {
     expectType<string>(item.id);
@@ -225,7 +225,7 @@ export async function getItemByRepositoryAndNumberTest() {
     return;
   }
 
-  if (item.isDraft === true) {
+  if (item.type === "DRAFT_ISSUE") {
     expectType<string>(item.id);
     expectType<string | null>(item.fields.title);
     expectNotType<"Title">(item.fields.title);
@@ -234,7 +234,7 @@ export async function getItemByRepositoryAndNumberTest() {
     // @ts-expect-error any Property 'notField' does not exist on type
     item.fields.notField;
 
-    // @ts-expect-error - `.content` is not set if `.isDraft` is true
+    // @ts-expect-error - `.content` is not set if `.type` is "DRAFT_ISSUE"
     item.content;
   } else {
     expectType<string>(item.id);
@@ -264,7 +264,7 @@ export async function updateItemTest() {
     return;
   }
 
-  if (item.isDraft === true) {
+  if (item.type === "DRAFT_ISSUE") {
     expectType<string>(item.id);
     expectType<string | null>(item.fields.title);
     expectNotType<"Title">(item.fields.title);
@@ -273,7 +273,7 @@ export async function updateItemTest() {
     // @ts-expect-error any Property 'notField' does not exist on type
     item.fields.notField;
 
-    // @ts-expect-error - `.content` is not set if `.isDraft` is true
+    // @ts-expect-error - `.content` is not set if `.type` is "DRAFT_ISSUE"
     item.content;
   } else {
     expectType<string>(item.id);
@@ -303,7 +303,7 @@ export async function updateItemByContentIdTest() {
     return;
   }
 
-  if (item.isDraft === true) {
+  if (item.type === "DRAFT_ISSUE") {
     expectType<string>(item.id);
     expectType<string | null>(item.fields.title);
     expectNotType<"Title">(item.fields.title);
@@ -312,7 +312,7 @@ export async function updateItemByContentIdTest() {
     // @ts-expect-error any Property 'notField' does not exist on type
     item.fields.notField;
 
-    // @ts-expect-error - `.content` is not set if `.isDraft` is true
+    // @ts-expect-error - `.content` is not set if `.type` is "DRAFT_ISSUE"
     item.content;
   } else {
     expectType<string>(item.id);
@@ -346,7 +346,7 @@ export async function updateItemByContentRepositoryAndNumberTest() {
     return;
   }
 
-  if (item.isDraft === true) {
+  if (item.type === "DRAFT_ISSUE") {
     expectType<string>(item.id);
     expectType<string | null>(item.fields.title);
     expectNotType<"Title">(item.fields.title);
@@ -355,7 +355,7 @@ export async function updateItemByContentRepositoryAndNumberTest() {
     // @ts-expect-error any Property 'notField' does not exist on type
     item.fields.notField;
 
-    // @ts-expect-error - `.content` is not set if `.isDraft` is true
+    // @ts-expect-error - `.content` is not set if `.type` is "DRAFT_ISSUE"
     item.content;
   } else {
     expectType<string>(item.id);

test.js

@@ -295,13 +295,11 @@ test("project.items.list() without configuring custom fields", async (t) => {
       id: "PNI_lADOBYMIeM0lfM4AAzDD",
       fields: { title: "Manual entry", status: null },
       type: "DRAFT_ISSUE",
-      isDraft: true,
     },
     {
       id: "PNI_lADOBYMIeM0lfM4AAzDx",
       type: "PULL_REQUEST",
       fields: { title: "Update README.md", status: "In Progress" },
-      isDraft: false,
       content: {
         isIssue: false,
         isPullRequest: true,
@@ -326,7 +324,6 @@ test("project.items.list() without configuring custom fields", async (t) => {
         title: "Enforce setting project via github actions",
         status: null,
       },
-      isDraft: false,
       content: {
         isIssue: true,
         isPullRequest: false,
@@ -615,7 +612,6 @@ test("project.items.add() without configuring custom fields", async (t) => {
       title: "Enforce setting project via github actions",
       status: null,
     },
-    isDraft: false,
     content: {
       isIssue: true,
       isPullRequest: false,

test.js.md

@@ -105,7 +105,6 @@ Generated by [AVA](https://avajs.dev).
           title: 'Yes',
         },
         id: 'PNI_lADOBYMIeM0lfM4AAzDD',
-        isDraft: true,
         type: 'DRAFT_ISSUE',
       },
       {
@@ -131,7 +130,6 @@ Generated by [AVA](https://avajs.dev).
           title: null,
         },
         id: 'PNI_lADOBYMIeM0lfM4AAzDx',
-        isDraft: false,
         type: 'PULL_REQUEST',
       },
       {
@@ -156,7 +154,6 @@ Generated by [AVA](https://avajs.dev).
           title: null,
         },
         id: 'PNI_lADOBYMIeM0lfM4ADfm9',
-        isDraft: false,
         type: 'ISSUE',
       },
     ]
@@ -196,6 +193,5 @@ Generated by [AVA](https://avajs.dev).
         title: null,
       },
       id: 'PNI_lADOBYMIeM0lfM4ADfm9',
-      isDraft: false,
       type: 'ISSUE',
     }

test/fixtures/add-item/issue/new-issue-item.js

@@ -7,7 +7,6 @@ export const newIssueItemFixture = {
     relevantToUsers: null,
     suggestedChangelog: null,
   },
-  isDraft: false,
   content: {
     isIssue: true,
     isPullRequest: false,

test/fixtures/add-item/pull-request/new-pull-request-item.js

@@ -7,7 +7,6 @@ export const newPullRequestItemFixture = {
     relevantToUsers: null,
     suggestedChangelog: null,
   },
-  isDraft: false,
   content: {
     isIssue: false,
     isPullRequest: true,

test/fixtures/get-item/draft-item.js

@@ -7,5 +7,4 @@ export const draftItemFixture = {
     relevantToUsers: "Yes",
     suggestedChangelog: null,
   },
-  isDraft: true,
 };

test/fixtures/get-item/issue-item.js

@@ -7,7 +7,6 @@ export const issueItemFixture = {
     relevantToUsers: null,
     suggestedChangelog: null,
   },
-  isDraft: false,
   content: {
     isIssue: true,
     isPullRequest: false,

test/fixtures/list-items/items.js

@@ -8,7 +8,6 @@ export const listItemsFixture = [
       relevantToUsers: "Yes",
       suggestedChangelog: null,
     },
-    isDraft: true,
   },
   {
     id: "PNI_lADOBYMIeM0lfM4AAzDx",
@@ -19,7 +18,6 @@ export const listItemsFixture = [
       relevantToUsers: null,
       suggestedChangelog: null,
     },
-    isDraft: false,
     content: {
       isIssue: false,
       isPullRequest: true,
@@ -46,7 +44,6 @@ export const listItemsFixture = [
       relevantToUsers: null,
       suggestedChangelog: null,
     },
-    isDraft: false,
     content: {
       isIssue: true,
       isPullRequest: false,