@managed-api/jira-cloud-v3-core NPM

Managed API for Jira Cloud

Managed API for Jira Cloud is an API Client for Jira Cloud by Adaptavist primarily designed for the use in ScriptRunner Connect. You can read more about Managed APIs here.

This is a runtime agnostic version of the Managed API (with core suffix) that makes it easy to port it to any runtime you may want to use this Managed API on.

Platform specific ports

ScriptRunner Connect

Supported API calls

fetch
Application
- Role
  - getRole
  - getRoles
Avatar
Dashboard
Filter
- createFilter
- deleteFilter
- getFilter
- getMyFilters
- searchFilters
- updateFilter
- Column
- Favourite
- Share
  - getDefaultScope
  - setDefaultScope
  - Permission
Group
GroupAndUserPicker
- findUsersAndGroups
Instance
Issue
- assignIssue
- createIssue
- createIssues
- deleteIssue
- editIssue
- getChangeLogs
- getChangeLogsById
- getIssue
- sendNotification
- Attachment
  - addAttachments
  - deleteAttachment
  - getAttachmentContent
  - Metadata
- Comment
  - addComment
  - deleteComment
  - getComment
  - getComments
  - getCommentsByIds
  - updateComment
  - Property
- Field
  - getContexts
  - getFields
  - getFieldsPaginated
  - Configuration
  - Custom
- Link
  - createLink
  - deleteLink
  - getLink
  - Remote
  - Type
- Metadata
  - getCreateMetadata
  - getEditMetadata
- Navigator
  - getDefaultColumns
  - setDefaultColumns
- Notification
  - Scheme
    - getScheme
    - getSchemes
- Priority
  - getPriorities
  - getPriority
  - searchPriorities
- Property
  - deleteProperty
  - getKeys
  - getProperty
  - setProperty
- Resolution
  - getResolution
  - getResolutions
- Search
  - checkAgainstJql
  - searchByJql
  - searchByJqlEnhancedSearch
- Security
  - getLevel
  - getMembers
  - Scheme
    - getScheme
    - getSchemes
- Transition
  - getTransitions
  - performTransition
- Type
  - createType
  - deleteType
  - getAlternativeTypes
  - getType
  - getTypesForProject
  - getTypesForUser
  - loadTypeAvatar
  - updateType
  - Property
  - Scheme
  - Screen
    - Scheme
- Vote
  - addVote
  - deleteVote
  - getVotes
- Watcher
  - addWatcher
  - deleteWatcher
  - getWatchers
- Worklog
  - addWorklog
  - deleteWorklog
  - getDeletedIds
  - getFromIds
  - getUpdatedIds
  - getWorklog
  - getWorklogs
  - updateWorklog
  - Property
Jql
Label
- getLabels
Myself
Permission
Project
- createProject
- deleteProject
- deleteProjectAsync
- getProject
- getProjects
- getStatuses
- restoreDeletedProject
- updateProject
- Avatar
  - deleteAvatar
  - getAvatars
  - loadAvatar
  - setAvatar
- Category
  - createCategory
  - deleteCategory
  - getCategories
  - getCategory
  - updateCategory
- Component
  - createComponent
  - deleteComponent
  - getComponent
  - getComponents
  - getComponentsPaginated
  - getIssueCount
  - updateComponent
- IssueType
  - getHierarchy
- Notification
  - Scheme
    - getScheme
- Permission
  - Scheme
- Property
  - deleteProperty
  - getProperty
  - getPropertyKeys
  - setProperty
- Role
  - createRole
  - deleteRole
  - fullyUpdateRole
  - getDetails
  - getRole
  - getRoleForProject
  - getRoles
  - getRolesForProject
  - partiallyUpdateRole
  - Actor
    - addActors
    - deleteActors
    - setActors
    - Default
- Security
  - Scheme
    - getIssueScheme
- Type
  - getAccessibleTypeByKey
  - getLicensedTypes
  - getTypeByKey
  - getTypes
- Validation
  - getValidProjectKey
  - getValidProjectName
  - validateProjectKey
- Version
  - createVersion
  - deleteAndReplaceVersion
  - getVersion
  - getVersions
  - getVersionsPaginated
  - mergeVersions
  - moveVersion
  - updateVersion
  - Count
    - getRelatedIssueCount
    - getUnresolvedIssueCount
Screen
User
Workflow

Porting to other runtimes

While the primary reason for creating Managed APIs was to use them in ScriptRunner Connect runtime, then you can easily port them to any runtime of your choosing.

You can do so by extending the *Core Managed API class where you'll be asked to provide implementation for getPlatformImplementation function. In this implementation you have to specify how to perform buffer encoding/decoding operations and how to perform HTTP calls:

{
    buffer: {
        encode(input: string): ArrayBuffer;
        decode(input: ArrayBuffer): string;
    },
    performHttpCall(request: Request): Promise<Response>
}

Here is an example how to create a Node port of the Managed API:

import { JiraCloudApiCore } from "@managed-api/jira-cloud-v3-core";
import { PlatformImplementation, Request, Response, Headers } from "@managed-api/commons-core";
import fetch from "node-fetch";

export class JiraCloudApi extends JiraCloudApiCore {
    constructor(private baseUrl: string, private authToken: string) {
        super();
    }

    protected getPlatformImplementation(): PlatformImplementation {
        return {
            buffer: {
                encode: (input) => Buffer.from(input, 'utf-8'),
                decode: (input) => Buffer.from(input).toString('utf-8')
            },
            performHttpCall: (request) => this.performHttpCall(request)
        };
    }
    
    private async performHttpCall(request: Request): Promise<Response> {
        const requestUrl = `${this.baseUrl}${request.url}`; // Substitute base URL
        request.headers.set('Authorization', `Basic ${this.authToken}`); // Substitute auth token
        const response = await fetch(requestUrl, {
            method: request.method,
            headers: request.headers as any,
            body: request.method.toLowerCase() !== 'get' ? Buffer.from((await request.arrayBuffer()) ?? new ArrayBuffer(0)) : undefined
        });

        const apiHeaders = new Headers();
        response.headers.forEach((value, key) => apiHeaders.append(key, value));

        const body = await response.arrayBuffer();

        return super.buildResponse(response.url, response.status, response.statusText, apiHeaders, body);
    }
}

Please note that the authentication handling details may not be accurate and serve as an example. If you wish to use these Managed APIs without having to concern yourself how to deal with and secure authentication details when working with APIs, then feel free to evaluate ScriptRunner Connect platform.

Contact

At this time Managed APIs are unlicensed and close sourced, but feel free to drop an email to eknoll@adaptavist.com for ideas, suggestions and improvements.

Changelog

3.2.0

Added support for the following method:
- Get attachment content that can be used as Issue.Attachment.getAttachmentContent or All.getIssueAttachmentContent.

3.1.0

Updated ADF code_inline_node and formatted_text_inline_node types.

3.0.0

Added support for the following method:
- Search for issues using JQL enhanced search that can be used as Issue.Search.searchByJqlEnhancedSearch or All.searchIssuesByJqlEnhancedSearch.
Deprecated the following method:
- Search for issues using JQL that can be used as Issue.Search.searchByJql or All.searchIssuesByJql.
Changed the following methods:
- Jql.parseQuery: Make validation required in the request.
- Issue.Security.getMembers: Change issueSecurityLevelId to string in the request.
- User.Search.findUserKeysByQuery: Remove maxResults from request and add maxResult.
- Issue.getIssue: Add failFast, expand and returnIssue to request.
- User.Search.findIssuesAssignableToUser: Add issueId to request.
- Added optional properties to the responses of several methods.

2.3.0

Reverted back to 2.1.0 version

2.0.0

Breaking change: URL and query string parameters are now URL encoded, meaning if you encoded them explicitly before you have to remove your own encoding, otherwise they will get double encoded.

1.4.0

Added null type to several fields in IssueCommonFields.

1.0.0

Added support to pass key property for project field, name property for issuetype, fixVersions, priority, versions, resolution fields for the following methods:
- Create issue that can be used as Issue.createIssue or All.createIssue.
- Bulk create issue that can be used as Issue.createIssues or All.createIssues.
- Edit issue that can be used as Issue.editIssue or All.editIssue.