github-project

> JavaScript SDK for GitHub's new Projects

Features

• Use GitHub Projects (beta) as a database of issues and pull requests with custom fields.
• Simple interaction with item fields and content (draft/issue/pull request) properties.
• Look up items by issue/pull request node IDs or number and repository name.
• 100% test coverage and type definitions.

Usage

import GitHubProject from "github-project";

A project always belongs to a user or organization account and has a number. For authentication you can pass a personal access token with project and write:org scopes. For read-only access the read:org and read:project scopes are sufficient.

fields is map of internal field names to the project's column labels. The comparison is case-insensitive. "Priority" will match both a field with the label "Priority" and one with the label "priority". An error will be thrown if a project field isn't found, unless the field is set to optional: true.

const options = {
  owner: "my-org",
  number: 1,
  token: "ghp_s3cR3t",
  fields: {
    priority: "Priority",
    dueAt: "Due",
    lastUpdate: { name: "Last Update", optional: true },
  },
};

const project = new GitHubProject(options);

// Alternatively, you can call the factory method to get a project instance
// const project = await GithubProject.getInstance(options)

// get project data
const projectData = await project.get();
console.log(projectData.description);

// log out all items
const items = await project.items.list();
for (const item of items) {
  // every item has a `.fields` property for the custom fields
  // and an `.content` property which is set unless the item is a draft
  console.log(
    "%s is due on %s (Priority: %d, Assignees: %j)",
    item.fields.title,
    item.fields.dueAt,
    item.fields.priority,
    item.type === "REDACTED"
      ? "_redacted_"
      : item.content.assignees.map(({ login }) => login).join(","),
  );
}

// add a new item using an existing issue
// You would usually retrieve the issue node ID from an event payload, such as `event.issue.node_id`
const newItem = await project.items.add(issue.node_id, { priority: 1 });

// retrieve a single item using the issue node ID (passing item node ID as string works, too)
const item = await project.items.getByContentId(issue.node_id);

// item is undefined when not found
if (item) {
  // update an item
  const updatedItem = await project.items.update(item.id, { priority: 2 });

  // remove item
  await project.items.remove(item.id);
}

API

Constructor

const project = new GitHubProject(options);

Factory method

The factory method is useful when you want immediate access to the project's data, for example to get the project's title. Will throw an error if the project doesn't exist.

const project = GitHubProject.getInstance(options);

function (projectFieldName, userFieldName) {
  return projectFieldName === userFieldName
}

function (fieldOptionValue, userValue) {
  return fieldOptionValue === userValue
}

project.getProperties()

const projectData = await project.getProperties();

Returns project level data url, title, description and databaseId

project.items.list()

const items = await project.items.list();

Returns the first 100 items of the project.

project.items.addDraft()

const newItem = await project.items.addDraft(content /*, fields*/);

Adds a new draft issue item to the project, sets the fields if any were passed, and returns the new item.

project.items.add()

const newItem = await project.items.add(contentId /*, fields*/);

Adds a new item to the project, sets the fields if any were passed, and returns the new item. If the item already exists then it's a no-op, the existing item is still updated with the passed fields if any were passed.

project.items.get()

const item = await project.items.get(itemNodeId);

Retrieve a single item based on its issue or pull request node ID. Resolves with undefined if item cannot be found.

project.items.getByContentId()

const item = await project.items.getByContentId(contentId);

Retrieve a single item based on its issue or pull request node ID. Resolves with undefined if item cannot be found.

project.items.getByContentRepositoryAndNumber()

const item = await project.items.getByContentRepositoryAndNumber(
  repositoryName,
  issueOrPullRequestNumber,
);

Retrieve a single item based on its issue or pull request node ID. Resolves with undefined if item cannot be found.

project.items.update()

const updatedItem = await project.items.update(itemNodeId, fields);

Update an exist item. To unset a field, set it to null. Returns undefined if item cannot be found.

project.items.updateByContentId()

const updatedItem = await project.items.updateByContentId(contentId, fields);

Update an exist item based on the node ID of its linked issue or pull request. To unset a field, set it to null. Returns undefined if item cannot be found.

project.items.updateByContentRepositoryAndNumber()

const updatedItem = await project.items.updateByContentRepositoryAndNumber(
  repositoryName,
  issueOrPullRequestNumber
  fields
);

Update an exist item based on the node ID of its linked issue or pull request. To unset a field, set it to null. Returns undefined if item cannot be found.

project.items.archive()

await project.items.archive(itemNodeId);

Archives a single item. Resolves with the archived item or with undefined if item was not found.

project.items.archiveByContentId()

await project.items.archiveByContentId(contentId);

Archives a single item based on the Node ID of its linked issue or pull request. Resolves with the archived item or with undefined if item was not found.

project.items.archiveByContentRepositoryAndNumber()

await project.items.archiveByContentRepositoryAndNumber(
  repositoryName,
  issueOrPullRequestNumber,
);

Archives a single item based on the Node ID of its linked issue or pull request. Resolves with the archived item or with undefined if item was not found.

project.items.remove()

await project.items.remove(itemNodeId);

Removes a single item. Resolves with the removed item or with undefined if item was not found.

project.items.removeByContentId()

await project.items.removeByContentId(contentId);

Removes a single item based on the Node ID of its linked issue or pull request. Resolves with the removed item or with undefined if item was not found.

project.items.removeByContentRepositoryAndNumber()

await project.items.removeByContentRepositoryAndNumber(
  repositoryName,
  issueOrPullRequestNumber,
);

Removes a single item based on the Node ID of its linked issue or pull request. Resolves with the removed item or with undefined if item was not found.

Errors

Expected errors are thrown using custom Error classes. You can check for any error thrown by github-project or for specific errors.

Custom errors are designed in a way that error.message does not leak any user content. All errors do provide a .toHumanMessage() method if you want to provide a more helpful error message which includes both project data as well ase user-provided data.

import Project, { GitHubProjectError } from "github-project";

try {
  await myScript(new Project(options));
} catch (error) {
  if (error instanceof GitHubProjectError) {
    myLogger.error(
      {
        // .code and .details are always set on GitHubProjectError instances
        code: error.code,
        details: error.details,
        // log out helpful human-readable error message, but beware that it likely contains user content
      },
      error.toHumanMessage(),
    );
  } else {
    // handle any other error
    myLogger.error({ error }, `An unexpected error occurred`);
  }

  throw error;
}

GitHubProjectNotFoundError

Thrown when a project cannot be found based on the owner and number passed to the Project constructor. The error is also thrown if the project exists but cannot be found based on authentication.

import Project, { GitHubProjectNotFoundError } from "github-project";

try {
  await myScript(new Project(options));
} catch (error) {
  if (error instanceof GitHubProjectNotFoundError) {
    analytics.track("GitHubProjectNotFoundError", {
      owner: error.details.owner,
      number: error.details.number,
    });

    myLogger.error(
      {
        code: error.code,
        details: error.details,
      },
      error.toHumanMessage(),
    );
  }

  throw error;
}

Example for error.toHumanMessage():

> Project #1 could not be found for @gr2m

GitHubProjectUnknownFieldError

Thrown when a configured field configured in the Project constructor cannot be found in the project.

import Project, { GitHubProjectUnknownFieldError } from "github-project";

try {
  await myScript(new Project(options));
} catch (error) {
  if (error instanceof GitHubProjectUnknownFieldError) {
    analytics.track("GitHubProjectUnknownFieldError", {
      projectFieldNames: error.details.projectFieldNames,
      userFieldName: error.details.userFieldName,
    });

    myLogger.error(
      {
        code: error.code,
        details: error.details,
      },
      error.toHumanMessage(),
    );
  }

  throw error;
}

Example for error.toHumanMessage():

> "NOPE" could not be matched with any of the existing field names: "My text", "My number", "My Date". If the field should be considered optional, then set it to "nope: { name: "NOPE", optional: true}

GitHubProjectInvalidValueError

Thrown when attempting to set a single select project field to a value that is not included in the field's configured options.

import Project, { GitHubProjectInvalidValueError } from "github-project";

try {
  await myScript(new Project(options));
} catch (error) {
  if (error instanceof GitHubProjectInvalidValueError) {
    analytics.track("GitHubProjectInvalidValueError", {
      fieldName: error.details.field.name,
      userValue: error.details.userValue,
    });

    myLogger.error(
      {
        code: error.code,
        details: error.details,
      },
      error.toHumanMessage(),
    );
  }

  throw error;
}

Example for error.toHumanMessage():

> "unknown" is not compatible with the "My Date" project field

GitHubProjectUnknownFieldOptionError

Thrown when attempting to set a single select project field to a value that is not included in the field's configured options. Inherits from GitHubProjectInvalidValueError.

import Project, { GitHubProjectUnknownFieldOptionError } from "github-project";

try {
  await myScript(new Project(options));
} catch (error) {
  if (error instanceof GitHubProjectUnknownFieldOptionError) {
    analytics.track("GitHubProjectUnknownFieldOptionError", {
      fieldName: error.details.field.name,
      userValue: error.details.userValue,
    });

    myLogger.error(
      {
        code: error.code,
        details: error.details,
      },
      error.toHumanMessage(),
    );
  }

  throw error;
}

Example for error.toHumanMessage():

> "unknown" is an invalid option for "Single select"

GitHubProjectUpdateReadOnlyFieldError

Thrown when attempting to set a single select project field to a value that is not included in the field's configured options.

import Project, { GitHubProjectUpdateReadOnlyFieldError } from "github-project";

try {
  await myScript(new Project(options));
} catch (error) {
  if (error instanceof GitHubProjectUpdateReadOnlyFieldError) {
    analytics.track("GitHubProjectUpdateReadOnlyFieldError", {
      fieldName: error.details.field.name,
      userValue: error.details.userValue,
    });

    myLogger.error(
      {
        code: error.code,
        details: error.details,
      },
      error.toHumanMessage(),
    );
  }

  throw error;
}

Example for error.toHumanMessage():

> Cannot update read-only fields: "Assignees" (.assignees) to "gr2m", "Labels" (.labels) to "bug"

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Gregor Martynus 🤔 💻 ⚠️ 👀 🚧 🚇

Mike Surowiec 💻 ⚠️

Tom Elliott 💻 ⚠️ 👀

Sam Lin 💻 ⚠️

Evan Bonsignori 💻 ⚠️ 📖

Baptiste Lombard 💻 ⚠️

This project follows the all-contributors specification. Contributions of any kind welcome!

License

ISC