bitbucket-repository-provider/README.md

repository provider for bitbucket

[![npm](https://img.shields.io/npm/v/bitbucket-repository-provider.svg)](https://www.npmjs.com/package/bitbucket-repository-provider)
[![License](https://img.shields.io/badge/License-0BSD-blue.svg)](https://spdx.org/licenses/0BSD.html)
[![bundlejs](https://deno.bundlejs.com/?q=bitbucket-repository-provider\&badge=detailed)](https://bundlejs.com/?q=bitbucket-repository-provider)
[![downloads](http://img.shields.io/npm/dm/bitbucket-repository-provider.svg?style=flat-square)](https://npmjs.org/package/bitbucket-repository-provider)
[![GitHub Issues](https://img.shields.io/github/issues/arlac77/bitbucket-repository-provider.svg?style=flat-square)](https://github.com/arlac77/bitbucket-repository-provider/issues)
[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Farlac77%2Fbitbucket-repository-provider%2Fbadge\&style=flat)](https://actions-badge.atrox.dev/arlac77/bitbucket-repository-provider/goto)
[![Styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
[![Known Vulnerabilities](https://snyk.io/test/github/arlac77/bitbucket-repository-provider/badge.svg)](https://snyk.io/test/github/arlac77/bitbucket-repository-provider)

# bitbucket-repository-provider

repository provider for bitbucket

# API

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

### Table of Contents

*   [BitbucketBranch](#bitbucketbranch)
    *   [entry](#entry)
        *   [Parameters](#parameters)
    *   [entries](#entries)
        *   [Parameters](#parameters-1)
    *   [commit](#commit)
        *   [Parameters](#parameters-2)
    *   [attributes](#attributes)
*   [hash](#hash)
*   [BitbucketHook](#bitbuckethook)
*   [BitbucketProvider](#bitbucketprovider)
    *   [Parameters](#parameters-3)
    *   [repositoryBases](#repositorybases)
    *   [initializeRepositories](#initializerepositories)
    *   [name](#name)
    *   [instanceIdentifier](#instanceidentifier)
    *   [attributes](#attributes-1)
*   [BitbucketPullRequest](#bitbucketpullrequest)
    *   [\_merge](#_merge)
        *   [Parameters](#parameters-4)
    *   [list](#list)
        *   [Parameters](#parameters-5)
    *   [open](#open)
        *   [Parameters](#parameters-6)
*   [BitbucketRepositoryGroup](#bitbucketrepositorygroup)
    *   [createRepository](#createrepository)
        *   [Parameters](#parameters-7)
*   [BitbucketRepository](#bitbucketrepository)
    *   [Parameters](#parameters-8)
    *   [Properties](#properties)
    *   [homePageURL](#homepageurl)
    *   [issuesURL](#issuesurl)
    *   [update](#update)
    *   [initializeHooks](#initializehooks)
    *   [initializeBranches](#initializebranches)
    *   [createBranch](#createbranch)
        *   [Parameters](#parameters-9)
    *   [deleteBranch](#deletebranch)
        *   [Parameters](#parameters-10)

## BitbucketBranch

**Extends Branch**

Branch of a bitbucket repository.

### entry

<https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/src/%7Bnode%7D/%7Bpath%7D>

#### Parameters

*   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<ContentEntry>**&#x20;

### entries

#### Parameters

*   `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))**&#x20;

### commit

Commit entries

#### Parameters

*   `message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** commit message
*   `updates` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<ContentEntry>** content to be commited
*   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**&#x20;

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)**&#x20;

### attributes

options

## hash

Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;

## BitbucketHook

**Extends Hook**

## BitbucketProvider

**Extends MultiGroupProvider**

Provider for bitbucket repositories.

Supported name schemes are

*   <https://user:aSecret@bitbucket.org/owner/repo-name.git>
*   git+<https://user:aSecret@bitbucket.org/owner/repo-name.git>
*   <git@bitbucket.org>:owner/repo-name.git
*   owner/repo-name
    Known environment variables
*   BITBUCKET\_API api
*   BITBUCKET\_TOKEN api token
*   BITBUCKET\_USERNAME username
*   BITBUCKET\_APP\_PASSWORD password
*   BITBUCKET\_PASSWORD password

### Parameters

*   `config` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;

    *   `config.url` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** provider scm base
    *   `config.api` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** provider api base
    *   `config.authentication` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** authentication

        *   `config.authentication.type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
        *   `config.authentication.username` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
        *   `config.authentication.password` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;

### repositoryBases

All possible base urls.

Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** common base urls of all repositories

### initializeRepositories

<https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories>

### name

We are called bitbucket.

Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** bitbucket

### instanceIdentifier

Default instance env name prefix.

### attributes

Default configuration as given for the cloud privider.

Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;

## BitbucketPullRequest

**Extends PullRequest**

Pull request inside bitbucket

### \_merge

<https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/pullrequests/%7Bpull_request_id%7D/merge>

#### Parameters

*   `merge_strategy`   (optional, default `"merge_commit"`)

### list

List all pull request for a given repo.
Result will be filtered by source branch, destination branch and states

#### Parameters

*   `repository` **Repository**&#x20;
*   `filter` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**&#x20;

    *   `filter.source` **Branch?**&#x20;
    *   `filter.destination` **Branch?**&#x20;
    *   `filter.states` **[Set](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>?**&#x20;

Returns **AsyncIterable\<PullRequest>**&#x20;

### open

<https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/pullrequests#post>

#### Parameters

*   `source` &#x20;
*   `destination` &#x20;
*   `options` &#x20;

## BitbucketRepositoryGroup

**Extends RepositoryGroup**

### createRepository

<https://community.atlassian.com/t5/Bitbucket-articles/Create-and-configure-a-Bitbucket-Server-repository-using-the/ba-p/828364>

#### Parameters

*   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
*   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**&#x20;

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<Repository>** newly created repository

## BitbucketRepository

**Extends Repository**

a repository hosted on bitbucket

### Parameters

*   `owner` **RepositoryOwner**&#x20;
*   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
*   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;

    *   `options.api` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?**&#x20;
    *   `options.group` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?**&#x20;

### Properties

*   `api` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
*   `group` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
*   `user` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;

### homePageURL

Deliver the url of home page.

Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** '.../overwiew'

### issuesURL

Deliver the url of issue tracking system.

Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** '.../issues'

### update

*   **See**: <https://developer.atlassian.com/cloud/bitbucket/rest/api-group-repositories/#api-repositories-workspace-repo-slug-put>

### initializeHooks

*   **See**: <https://developer.atlassian.com/cloud/bitbucket/rest/api-group-repositories/#api-repositories-workspace-repo-slug-hooks-get>

### initializeBranches

<https://developer.atlassian.com/cloud/bitbucket/rest/api-group-refs/#api-group-refs>

### createBranch

Create a new branch
<https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/refs/branches?_ga=2.65542446.1034690805.1541022941-164225451.1541022941#post>

#### Parameters

*   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the new branch to create
*   `from` **[BitbucketBranch](#bitbucketbranch)**  (optional, default `this.defaultBranch`)
*   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;

    *   `options.message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?**&#x20;

### deleteBranch

<https://docs.atlassian.com/bitbucket-server/rest/5.8.0/bitbucket-branch-rest.html#idm45555984542992>
<https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/refs/branches/%7Bname%7D#delete>

#### Parameters

*   `name` &#x20;

# install

With [npm](http://npmjs.org) do:

```shell
npm install bitbucket-repository-provider
```

# license

BSD-2-Clause