npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@managed-api/github-core

v2.0.0

Published

Adaptavist Managed API for GitHub

Downloads

243

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Maintainers

ratwalratwalskitsonskitsonmtapsimtapsijtrummjtrummtheshumanatortheshumanatorssarapovssarapovadaptavist-horizon-devadaptavist-horizon-devjsaksjsakseknolleknoll

Keywords

Readme

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 [email protected] 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.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 2024 (c) All rights reserved