@managed-api/bitbucket-cloud-v2-core
Advanced tools
Managed API for Bitbucket Cloud is an API Client for Bitbucket 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.
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 { BitbucketCloudApiCore } from "@managed-api/bitbucket-cloud-v2-core";
import { PlatformImplementation, Request, Response, Headers } from "@managed-api/commons-core";
import fetch from "node-fetch";
export class BitbucketCloudApi extends BitbucketCloudApiCore {
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.
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.
Repository.Pullrequest.Commit.getCommits or All.getRepositoryPullrequestCommits.Repository.Commit.getCommits or All.getRepositoryCommits.Repository.Commit.getCommits or All.getRepositoryCommits.Repository.getRepositories or All.getRepositories.Repository.Branch.createRepositoryBranch to Repository.Branch.createBranch.Repository.Commit.getRepositoryCommits to Repository.Commit.getCommits.Workspace.Variable.updateVariable or All.updateWorkspaceVariable.Repository.Branch.Restriction.getRestriction or All.getRepositoryBranchRestriction.Repository.Branch.Restriction.deleteRestriction or All.deleteRepositoryBranchRestriction.User.getCurrentUserEmail or All.getCurrentUserEmail.User.getCurrentUserEmails or All.getCurrentUserEmails.Repository.Reviewer.Default.getReviewer or All.getRepositoryDefaultReviewer.Repository.Reviewer.Default.addReviewer or All.addRepositoryDefaultReviewer.Repository.Reviewer.Default.getReviewers or All.getRepositoryDefaultReviewers.Repository.Commit.getCommits or All.getRepositoryCommits.Copyright Adaptavist 2024 (c) All rights reserved
FAQs
Adaptavist Managed API for Bitbucket Cloud
The npm package @managed-api/bitbucket-cloud-v2-core receives a total of 1 weekly downloads. As such, @managed-api/bitbucket-cloud-v2-core popularity was classified as not popular.
We found that @managed-api/bitbucket-cloud-v2-core demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 7 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.