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

2.0.0 • Public • Published

Managed API for Tempo Cloud

Managed API for Tempo Cloud is an API Client for Tempo 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 { TempoCloudApiCore } from "@managed-api/tempo-cloud-v4-core";
import { PlatformImplementation, Request, Response, Headers } from "@managed-api/commons-core";
import fetch from "node-fetch";

export class TempoCloudApi extends TempoCloudApiCore {
    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.

0.16.0

Changes

  • Updated OpenApi Specification

  • Field issueId was removed from Worklog.updateWorklog.

  • Changed the previous Plan.getPlans method to Plan.searchPlans.

Added support for the following Plan method:

Added support for the following Worklog.Work method:

0.12.0

Changed response type for the following Account methods:

0.11.0

Added support for the following Account methods:

Added support for the following Account.Category methods:

Added support for the following Account.Category.Type methods:

Added support for the following Account.Link methods:

Added support for the following Customer methods:

0.10.0

Changed response type for the following Work.Attribute methods:

  • Retrieve Attributes that can be used as Work.Attribute.getAttributes or All.getWorkAttributes.

0.9.0

Added support for the following Account methods:

  • Create Account that can be used as Account.createAccount or All.createAccount.
  • Delete Account that can be used as Account.deleteAccount or All.deleteAccount.
  • Update Account that can be used as Account.updateAccount or All.updateAccount.

Added support for the following Work.Attribute methods:

  • Retrieve Attributes that can be used as Work.Attribute.getAttributes or All.getWorkAttributes.
  • Create Attribute that can be used as Work.Attribute.createAttribute or All.createWorkAttribute.
  • Delete Attribute that can be used as Work.Attribute.deleteAttribute or All.deleteWorkAttribute.
  • Retrieve Attribute that can be used as Work.Attribute.getAttribute or All.getWorkAttribute.
  • Update Attribute that can be used as Work.Attribute.updateAttribute or All.updateWorkAttribute.

0.8.0

Added support for the following Account methods:

  • Retrieve Accounts that can be used as Account.getAccounts or All.getAccounts.
  • Search Accounts that can be used as Account.searchAccounts or All.searchAccounts.
  • Retrieve Account that can be used as Account.getAccountById or All.getAccountById.

Added support for the following GenericResource methods:

Added support for the following Plan methods:

0.3.0

Removed support for the following methods:

  • Worklog.Search.getWorklogsByFilterId or All.getWorklogsByFilterId.
  • Worklog.getJiraWorklog or All.getJiraWorklog.

Added support for the following Worklog.Search method:

Fixed following methods:

0.1.0

Added support for the following Worklog methods:

Added support for the following Worklog.Search methods:

Added support for the following Worklog.Work methods:

Copyright Adaptavist 2024 (c) All rights reserved

Readme

Keywords

none

Package Sidebar

Install

npm i @managed-api/tempo-cloud-v4-core

Weekly Downloads

0

Version

2.0.0

License

UNLICENSED

Unpacked Size

326 kB

Total Files

326

Last publish

Collaborators

  • mtapsi
  • jtrumm
  • theshumanator
  • ssarapov
  • adaptavist-horizon-dev
  • jsaks
  • eknoll