jira-list-functions.js

const { default: axios } = require("axios");
const { getJiraClient, resolveHost } = require("./helpers");

const DEFAULT_FIELDS = ["created", "description", "summary", "status", "priority"];
const DEFAULT_MAX_RESULTS = 50;
const DEFAULT_START_AT = 0;

function listIssues({
  host,
  email,
  apiToken,
  project,
  status,
  startDate,
  endDate,
  overrideJql: customJqlString,
  maxResults = DEFAULT_MAX_RESULTS,
  startAt = DEFAULT_START_AT,
  fields = DEFAULT_FIELDS,
}) {
  const jiraClient = getJiraClient({ host, email, apiToken });

  const jqlSegments = [];
  if (customJqlString) {
    jqlSegments.push(customJqlString);
  }
  if (!customJqlString && project) {
    jqlSegments.push(`project = ${project}`);
  }
  if (!customJqlString && status) {
    jqlSegments.push(`status = ${status}`);
  }
  if (!customJqlString && startDate) {
    jqlSegments.push(`updated >= ${startDate}`);
  }
  if (!customJqlString && endDate) {
    jqlSegments.push(`updated <= ${endDate}`);
  }

  const searchOptions = { maxResults, startAt };
  if (fields !== "*") {
    searchOptions.fields = fields;
  }

  return jiraClient.searchJira(jqlSegments.join(" AND "), searchOptions);
}

function listAssigneeDetails({
  host,
  email,
  apiToken,
  startDate,
  endDate,
  overrideJql: customJqlString,
  users: assignee,
  maxResults = DEFAULT_MAX_RESULTS,
  startAt = DEFAULT_START_AT,
  fields = DEFAULT_FIELDS,
}) {
  const jiraClient = getJiraClient({ host, email, apiToken });

  const jqlSegments = [];
  if (customJqlString) {
    jqlSegments.push(customJqlString);
  }
  if (!customJqlString && assignee) {
    jqlSegments.push(`assignee in ('${assignee}')`);
  }
  if (!customJqlString && startDate) {
    jqlSegments.push(`created >= ${startDate}`);
  }
  if (!customJqlString && endDate) {
    jqlSegments.push(`created <= ${endDate}`);
  }

  const jql = jqlSegments.join(" AND ");
  const searchOptions = { maxResults, startAt };
  if (fields && fields !== "*") {
    searchOptions.fields = fields;
  }

  return jiraClient.searchJira(jql, searchOptions);
}

function listTransitions({
  host,
  email,
  apiToken,
  issue,
}) {
  const jiraClient = getJiraClient({ host, email, apiToken });
  return jiraClient.listTransitions(issue);
}

function listProjects({
  host,
  email,
  apiToken,
}) {
  const jiraClient = getJiraClient({ host, email, apiToken });
  return jiraClient.listProjects();
}

function listProjectVersions({
  host,
  email,
  apiToken,
  project,
}) {
  const jiraClient = getJiraClient({ host, email, apiToken });
  return jiraClient.getVersions(project);
}

async function listIssueTypes({
  host,
  email,
  apiToken,
  project,
}) {
  const client = getJiraClient({ host, email, apiToken });

  if (!project) {
    return client.listIssueTypes();
  }

  const { issueTypes } = await client.getProject(project);
  return issueTypes;
}

async function listUsers({
  host,
  email,
  apiToken,
  group,
}) {
  const client = getJiraClient({ host, email, apiToken });

  const result = await (group ? client.getUsersInGroup(group) : client.getUsers());
  return (group ? result.users.items : result) ?? [];
}

async function listStatus({
  host,
  email,
  apiToken,
  project,
}) {
  const client = getJiraClient({ host, email, apiToken });

  const statuses = await client.listStatus();
  if (!project) {
    return statuses;
  }

  const mappedStatuses = statuses.map((status) => ({
    ...status,
    isGlobal: !Reflect.has(status, "scope"),
  }));

  const filteredStatuses = mappedStatuses.filter((status) => (
    status.isGlobal
    || status.scope.project?.id === project
  ));

  return filteredStatuses;
}

async function listGroups(params) {
  const {
    host,
    email,
    apiToken,
    query,
  } = params;

  const { host: resolvedHost, protocol } = resolveHost(host);
  const fullBaseUrl = `${protocol}://${resolvedHost}`;

  const urlParams = {};
  if (query) {
    urlParams.query = query;
  }

  const { data } = await axios({
    method: "GET",
    baseURL: fullBaseUrl,
    url: "/rest/api/2/groups/picker",
    auth: {
      password: apiToken,
      username: email,
    },
    headers: {
      Accept: "application/json",
    },
    params: urlParams,
  });

  return data;
}

module.exports = {
  listIssues,
  listTransitions,
  listProjects,
  listProjectVersions,
  listAssigneeDetails,
  listIssueTypes,
  listUsers,
  listStatus,
  listGroups,
};