Registry / productivity / jira-data-center-client

jira-data-center-client

library1.0.39jsnpmunverified

A TypeScript client for Jira Server and Data Center REST APIs. Currently at version 1.0.39 with weekly releases. Designed specifically for Jira On-Premise environments, it offers full type safety with auto-generated interfaces for all endpoints. Key differentiators: native TypeScript support, zero runtime dependencies, and comprehensive coverage of Jira Server/Data Center features without needing Atlassian Connect. Requires Node >=22.

productivity

npm install jira-data-center-client

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · JIRA-DATA-CENTER-C

jira-data-center-client

productivityjavascriptv1.0.39

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

JiraClient

✓ import { JiraClient } from 'jira-data-center-client'

✗ const JiraClient = require('jira-data-center-client')

ESM-only package; use import, not require.

createClient

✓ import { createClient } from 'jira-data-center-client'

✗ import { createClient } from 'jira-data-center-client/index'

Factory function for creating client instances.

Issue

✓ import type { Issue } from 'jira-data-center-client'

✗ import { Issue } from 'jira-data-center-client'

Use 'import type' for type-only imports to avoid runtime overhead.

JiraClientConfig

✓ import type { JiraClientConfig } from 'jira-data-center-client'

Configuration interface for client options.

Initializes a Jira Data Center client with basic auth and fetches an issue by key.

import { createClient } from 'jira-data-center-client'; const client = createClient({ host: 'https://your-jira-instance.atlassian.net', authentication: { basic: { username: process.env.JIRA_USERNAME ?? '', password: process.env.JIRA_API_TOKEN ?? '' } } }); async function getIssue(issueKey: string) { try { const issue = await client.issues.getIssue({ issueIdOrKey: issueKey }); console.log(issue.fields?.summary); } catch (error) { console.error('Failed to fetch issue:', error); } } getIssue('TEST-123');

Debug

Known issues

breakingVersion 1.0.0 changed the client initialization API from constructor to factory function.

fix

Use createClient() instead of new JiraClient().

affects: <1.0.0

breakingNode.js version requirement changed from >=18 to >=22 in version 1.0.0.

fix

Upgrade Node.js to >=22.

affects: <1.0.0

deprecatedThe 'password' field in authentication config is deprecated in favor of 'apiToken'.

fix

Use 'authentication: { basic: { apiToken: '...' } }'.

affects: >=1.0.30

gotchaClient methods return raw AxiosResponse objects, not just data. You must access .data.

fix

Use const { data } = await client.issues.getIssue(...);

affects: >=1.0.0

gotchaRate limiting is not handled automatically. 429 responses must be handled by the user.

fix

Implement retry logic with exponential backoff for 429 status codes.

affects: >=1.0.0

Errors

Common errors & fixes

Error: Cannot find module 'jira-data-center-client'

Package not installed or not in node_modules.

fix

Run 'npm install jira-data-center-client'.

TypeError: client.issues.getIssue is not a function

Old API using new JiraClient() instead of createClient().

fix

Use 'createClient()' to instantiate the client.

AxiosError: Request failed with status code 401

Invalid or missing authentication credentials.

fix

Check JIRA_USERNAME and JIRA_API_TOKEN environment variables or basic auth config.

Upgrade

Version history

1.0.39latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

18 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/evrimalacan/jira-data-center-client ↗

packagejira-data-center-client ↗

homepagehttps://github.com/evrimalacan/jira-data-center-client#readme ↗