aeolun / ts-jira-client

A Typescript wrapper for the Jira Rest API

Typescript JIRA API for node.js

A Typescript wrapper for the Jira Rest API, now in Typescript. I had this as a fork of jira-client for a while, but I felt the need to completely split it up to modernize it (as well as give myself an easier time deploying).

I've tried to keep the api as close to the original api as possible, but sometimes I've had to make compromises. Where possible any legacy calls have been removed, and replaced with what made most sense considering the latest versions of Jira Datacenter, Cloud, Software and Service Desk.

Warning

Types have been sourced wherever they exist (cloud has more type definitions, either in docs or openapi, than server/datacenter, but no guarantee they are compatible).

If you find any conflicts, or have any suggestions, please feel free to open an issue or a pull request.

Installation

Install with the node package manager pnpm:

$ pnpm install ts-jira-client

Examples

Create the JIRA client

import { JiraApi } from 'ts-jira-client';

// Initialize
var jira = new JiraApi({
  protocol: 'https', // default is https
  host: 'jira.somehost.com', // REQUIRED
  username: 'username',
  password: 'password',
  apiVersion: '2', // default is 2
  strictSSL: true // default is true
});

Find the status of an issue

async function logIssueName() {
  try {
    const issue = await jira.findIssue(issueNumber);
    console.log(`Status: ${issue.fields.status.name}`);
  } catch (err) {
    console.error(err);
  }
}
logIssueName();

Documentation

Can't find what you need in the readme? Check out our documentation here: https://aeolun.github.io/ts-jira-client/

ts-jira-client's Issues

addAttachmentOnIssue It only accepts Buffer, but I would like Stream

The method for adding files to issue only accepts a buffer, this is not very convenient, I want to get a preview of the file in jira and its type, but it turns out that I won't be able to send it.

  /** Add attachment to a Issue
   * [Jira Doc](https://docs.atlassian.com/jira/REST/latest/#api/2/issue/{issueIdOrKey}/attachments-addAttachment)
   * @param issueId - issue id
   * @param readStream - readStream object from fs
   */
  addAttachmentOnIssue(issueId: string, readStream: Buffer) {
    const formData = new FormData();
    formData.append("file", new Blob([readStream], { type: "application/octet-stream" }));
    return this.doRequest<unknown>(
      this.makeRequestHeader(
        this.makeUri({
          pathname: `/issue/${issueId}/attachments`,
        }),
        {
          method: "POST",
          headers: {
            "X-Atlassian-Token": "nocheck",
          },
          data: formData,
        },
      ),
    );
  }

In the classic version of the library it is possible to send streams, as far as I know, this is due to the fact that they use postman instead of axios.

For me, the most important thing is that you can transfer the name and type of the file.