Node.js で Jira の API から課題情報を取得する

npm i dotenv
npm i jira-client
npm i -D @types/jira-client

JIRA_HOST="[会社のアカウント].atlassian.net"
MAIL_ADDRESS="ユーザー名に使っているメールアドレス"
JIRA_API_TOKEN="設定画面から取得したAPIトークン"
PROJECT_NAME="Jiraのプロジェクト名。 課題のJQLでproject = 'XXX'で指定されているやつ"

import JiraApi, { JsonResponse } from "jira-client";
import dotenv from "dotenv";

dotenv.config();

const host = process.env.JIRA_HOST;
const mailAddress = process.env.MAIL_ADDRESS;
const apiToken = process.env.JIRA_API_TOKEN;
const projectName = process.env.PROJECT_NAME;

let jiraClient: JiraApi | undefined;
function getJiraClient() {
  if (
    host === undefined ||
    mailAddress === undefined ||
    apiToken === undefined
  ) {
    throw new Error("環境変数が設定されていません。");
  }
  if (jiraClient === undefined) {
    jiraClient = new JiraApi({
      protocol: "https",
      host,
      username: mailAddress,
      password: apiToken,
      apiVersion: "2",
      strictSSL: true,
    });
  } else {
    console.log("jiraClient はキャッシュされています。");
  }
  return jiraClient;
}

export async function getAllIssues() {
  const client = getJiraClient();
  if (client === undefined) {
    throw new Error("jiraClient が生成されていません。");
  }

  if (projectName === undefined) {
    throw new Error("プロジェクト名が環境変数に設定されていません。");
  }
  const jql = `project = "${projectName}" ORDER BY created DESC`;

  const jiraResponse: JsonResponse = await client.searchJira(jql, {
    startAt: 0,
    maxResults: 10,
  });

  const jira: Jira = {
    startAt: jiraResponse.startAt,
    maxResults: jiraResponse.maxResults,
    total: jiraResponse.total,
    issues: jiraResponse.issues,
  };

  console.log(jira.total);
}

await client.searchJira(jql, {
  startAt: 1,
  maxResults: 10,
});

interface JsonResponse {
  [name: string]: any;
}

customfield_10128: null,
customfield_10007: null,
customfield_10129: null,

export type Jira = {
  startAt: number
  maxResults: number
  total: number
  issues: Issue[]
}

export type Issue = {
  id: string
  key: string
  fields: Fields
}

export type Fields = {
  parent: Parent
  summary: string
  status: Status
  targetServices: TargetService[] // ここは会社特有のもの。fields.customfield_xxxx の値を入れる
  sprints: Sprint[]
  storyPoint: number  // fields.customfield_yyyy の値を入れる
  created: string
  updated: string
  description: string
  statuscategorychangedate: string
}

// サンプルです
function otharfunc() {
  const jira: Jira = {
    startAt: jiraResponse.startAt,
    maxResults: jiraResponse.maxResults,
    total: jiraResponse.total,
    issues: jiraResponse.issues,
  }

  // 型をつける関数を呼んでる
  const typedJira = getTypedJira(jira)
}



function getTypedJira(jira: any): Jira {
  const typedIssues: Issue[] = jira.issues.map((issue: Issue) => {
    const fields: any = issue.fields
    const sprints = fields.customfield_xxxx.map((sprint: any) => {
      return {
        name: sprint.name,
        state: sprint.state,
        startDate: sprint.startDate,
        endDate: sprint.endDate,
      }
    })
    const typedFields: Fields = {
      parent: {
        summary: fields.parent.fields.summary,
      },
      summary: fields.summary,
      status: fields.status,
      targetServices: fields.customfield_xxxx,
      sprints,
      storyPoint: fields.customfield_yyy,
      created: fields.created,
      updated: fields.updated,
      description: fields.description,
      statuscategorychangedate: fields.statuscategorychangedate,
    }
    return {
      id: issue.id,
      key: issue.key,
      fields: typedFields,
    }
  })
  const typedJira: Jira = {
    startAt: jira.startAt,
    maxResults: jira.maxResults,
    total: jira.total,
    issues: typedIssues,
  }
  return typedJira
}