❤
npm
Sign UpSign In

@managed-api/jira-cloud-v3-core
TypeScript icon, indicating that this package has built-in type declarations

2.0.0 • Public • Published

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

Supported API calls

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

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.

0.22.0

  • Custom fields can be added to field object in following Issue 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.

0.21.0

  • Updated OpenApi Specification

0.20.0

  • Added support for the following Issue.Priority method:

    • Search priorities that can be used as Issue.Priority.searchPriorities or All.searchIssuePriorities.

  • The following methods are no longer deprecated:

    • Get notification scheme that can be used as Issue.Notification.Scheme.getScheme or All.getIssueNotificationScheme.
    • Get resolution that can be used as Issue.Resolution.getResolution or All.getIssueResolution.
    • Get priority that can be used as Issue.Priority.getPriority or All.getIssuePriority.

0.18.0

  • The following methods are deprecated:

    • Get priorities that can be used as Issue.Priority.getPriorities or All.getIssuePriorities.
    • Get priority that can be used as Issue.Priority.getPriority or All.getIssuePriority.
    • Get resolutions that can be used as Issue.Resolution.getResolutions or All.getIssueResolutions.
    • Get resolution that can be used as Issue.Resolution.getResolution or All.getIssueResolution.
    • Get notification scheme that can be used as Issue.Notification.Scheme.getScheme or All.getIssueNotificationScheme.
    • Get project notification scheme that can be used as Project.Notification.Scheme.getScheme or All.getProjectNotificationScheme.

Copyright Adaptavist 2024 (c) All rights reserved

Readme

Keywords

none

Package Sidebar

Install

npm i @managed-api/jira-cloud-v3-core

Weekly Downloads

11

Version

2.0.0

License

UNLICENSED

Unpacked Size

3.16 MB

Total Files

2168

Last publish

Collaborators

  • mtapsi
  • jtrumm
  • theshumanator
  • ssarapov
  • adaptavist-horizon-dev
  • jsaks
  • eknoll
Try on RunKit
Report malware