@managed-api/bitbucket-cloud-v2-core

Managed API for Bitbucket Cloud

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.

Platform specific ports

• ScriptRunner Connect

Supported API calls

• fetch
• Repository
  • createRepository
  • deleteRepository
  • getBranchesAndTags
  • getRepositories
  • getRepositoriesByWorkspace
  • getRepository
  • updateRepository
  • Branch
    • createBranch
    • deleteBranch
    • getBranch
    • getOpenBranches
    • Restriction
      • createRestriction
      • deleteRestriction
      • getRestriction
      • getRestrictions
      • updateRestriction
  • Commit
    • getCommit
    • getCommits
    • getCommitsByFile
    • Approval
      • approveCommit
      • redactApproval
    • Comment
      • getComment
      • getComments
    • Status
      • createStatus
      • getStatus
      • getStatuses
  • Deployment
    • getDeployment
    • getDeployments
  • Environment
    • createEnvironment
    • deleteEnvironment
    • getEnvironment
    • getEnvironments
    • Variable
      • createVariable
      • deleteVariable
      • getVariables
      • updateVariable
  • Fork
    • createFork
    • getForks
  • Pipeline
    • createAndInitiatePipeline
    • findPipelines
    • retrievePipeline
    • stopPipeline
    • Configuration
      • retrieveConfiguration
      • updateConfiguration
      • Build
        • updateBuildNumber
      • Schedule
        • createSchedule
        • deleteSchedule
        • retrieveSchedule
        • retrieveSchedules
        • updateSchedule
      • Variable
        • createVariable
        • deleteVariable
        • getVariable
        • getVariables
        • updateVariable
    • Step
      • findSteps
      • retrieveStep
  • Pullrequest
    • approvePullrequest
    • createPullrequest
    • declinePullrequest
    • getActivityLog
    • getPullrequest
    • getPullrequests
    • getPullrequestStatuses
    • mergePullrequest
    • mutatePullrequest
    • Comment
      • createComment
      • deleteComment
      • getComment
      • getComments
      • updateComment
    • Commit
      • getCommits
  • Reviewer
    • Default
      • addReviewer
      • getReviewer
      • getReviewers
      • removeReviewer
  • Tag
    • createTag
    • deleteTag
    • getTag
    • getTags
• User
  • getCurrentUser
  • getCurrentUserEmail
  • getCurrentUserEmails
  • getUser
  • Permission
    • getCurrentUserRepositoryPermissions
    • getCurrentUserWorkspaceMemberships
  • SSH
    • addKey
    • deleteKey
    • getKey
    • getKeys
    • updateKey
• Workspace
  • getWorkspace
  • getWorkspaces
  • Project
    • createProject
    • deleteProject
    • getProject
    • getProjects
    • Search
      • searchCodeInProjects
  • Variable
    • createVariable
    • deleteVariable
    • getVariable
    • getVariables
    • updateVariable

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

Contact

At this time Managed APIs are unlicensed and close sourced, but feel free to drop an email to [e-mail] for ideas, suggestions and improvements.

Changelog

2.1.0

• Changed response type for the following methods:

  • List commits on a pull request that can be used as Repository.Pullrequest.Commit.getCommits or All.getRepositoryPullrequestCommits.
  • List commits with include/exclude that can be used as Repository.Commit.getCommits or All.getRepositoryCommits.

2.0.1

• Fixed the following method to use the appropriate header:

  • List commits with include/exclude that can be used as Repository.Commit.getCommits or All.getRepositoryCommits.

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

• Changed response type for following Repository methods:

  • List public repositories that can be used as Repository.getRepositories or All.getRepositories.

0.11.0

• Changed the name for following methods:

  • Repository.Branch.createRepositoryBranch to Repository.Branch.createBranch.
  • Repository.Commit.getRepositoryCommits to Repository.Commit.getCommits.

• Fixed the following methods:

  • Update variable for a workspace that can be used as Workspace.Variable.updateVariable or All.updateWorkspaceVariable.
  • Get a branch restriction rule that can be used as Repository.Branch.Restriction.getRestriction or All.getRepositoryBranchRestriction.
  • Delete a branch restriction rule that can be used as Repository.Branch.Restriction.deleteRestriction or All.deleteRepositoryBranchRestriction.
  • Get an email address for current user that can be used as User.getCurrentUserEmail or All.getCurrentUserEmail.
  • List email addresses for current user that can be used as User.getCurrentUserEmails or All.getCurrentUserEmails.
  • Get a default reviewer that can be used as Repository.Reviewer.Default.getReviewer or All.getRepositoryDefaultReviewer.
  • Add a user to the default reviewers that can be used as Repository.Reviewer.Default.addReviewer or All.addRepositoryDefaultReviewer.
  • List default reviewers that can be used as Repository.Reviewer.Default.getReviewers or All.getRepositoryDefaultReviewers.
  • List commits with include/exclude that can be used as Repository.Commit.getCommits or All.getRepositoryCommits.

Copyright Adaptavist 2024 (c) All rights reserved