❤
npm
Sign UpSign In

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

2.1.0 • Public • Published

Managed API for GitHub

Managed API for GitHub is an API Client for GitHub 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 { GitHubApiCore } from "@managed-api/github-core";
import { PlatformImplementation, Request, Response, Headers } from "@managed-api/commons-core";
import fetch from "node-fetch";

export class GitHubApi extends GitHubApiCore {
    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.1.0

  • Removed non-empty body from HEAD requests.

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.11.0

    • Updated OpenApi Specification.
    • Fields sort and order are deprecated in Search.searchCode.

0.9.0

Added support for the following Organization.Member methods:

Added support for the following Organization methods:

Added support for the following Search methods:

  • Search code that can be used as Search.searchCode or All.searchCode.

  • Search commits that can be used as Search.searchCommits or All.searchCommits.

  • Search issues and pull requests that can be used as Search.searchIssuesAndPullRequests or All.searchIssuesAndPullRequests.

  • Search labels that can be used as Search.searchLabels or All.searchLabels.

  • Search repositories that can be used as Search.searchRepositories or All.searchRepositories.

  • Search topics that can be used as Search.searchTopics or All.searchTopics.

  • Search users that can be used as Search.searchUsers or All.searchUsers.

Added support for the following Release methods:

Added support for the following User.Block methods:

Added support for the following User methods:

Added support for the following Repository.Content methods:

Added support for the following Branch.Protection methods:

Added support for the following Branch.Protection.Admin methods:

Added support for the following Branch.Protection.Pull.Review methods:

Added support for the following Branch.Protection.Commit.Signature methods:

Added support for the following Branch.Protection.Status.Check methods:

Added support for the following Project methods:

Added support for the following Search methods:

  • Search code that can be used as Search.searchCode or All.searchCode.

  • Search commits that can be used as Search.searchCommits or All.searchCommits.

  • Search issues and pull requests that can be used as Search.searchIssuesAndPullRequests or All.searchIssuesAndPullRequests.

  • Search labels that can be used as Search.searchLabels or All.searchLabels.

  • Search repositories that can be used as Search.searchRepositories or All.searchRepositories.

  • Search topics that can be used as Search.searchTopics or All.searchTopics.

  • Search users that can be used as Search.searchUsers or All.searchUsers.

Copyright Adaptavist 2025 (c) All rights reserved

Readme

Keywords

none

Package Sidebar

Install

npm i @managed-api/github-core

Weekly Downloads

100

Version

2.1.0

License

UNLICENSED

Unpacked Size

1.74 MB

Total Files

666

Last publish

Collaborators

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