README

NodeJS client for Atlassian Stash

Provides access to some of the Stash's API which is not available with official REST API and was only accessible throw the Web interface.

Tested with Atlassian Stash v3.5.1

Usage

var Client = require('stash-web-api').Client;

var stashApi = new Client({
  username: 'username',
  password: 'password',
  baseUrl: 'https://stash.yourcompany.com'
});

API

Repository branch permissions

#getAll

Get all branch permissions for a repository:

// Returns Promise resolved to an Array of repository branch permissions on success
stashApi.branchPermissions.getAll(projectKey, repositorySlug);

#add

Add new branch permission for a repository:

var permission = {
  branch: 'branch_name',
  users: 'super_user',
  groups: ['development', 'admins']  
};

// Returns Promise resolved to the new permission's object on success
stashApi.branchPermissions.add(projectKey, repositorySlug, permission);

Permission object should be defined and should contain:

branch property (if pattern is not defined), which should contain branch name to apply permission to.
pattern property (if branch is not defined), which should contain pattern to match multiple branches.
users property (optional). Should be a name or an array of user names to aply permission to.
groups property (optional). Should be a group name or an array of user groups to aply permission to.

#update

Update existing branch permission on a repository:

var permission = {
  branch: 'branch_name',
  users: 'super_user',
  groups: ['development', 'admins']  
};

// Returns Promise resolved to the updated permission's object
stashApi.branchPermissions.update(projectKey, repositorySlug, permissionId, permission);

Permission object should be defined and should contain:

branch property (if pattern is not defined), which should contain branch name to apply permission to.
pattern property (if branch is not defined), which should contain pattern to match multiple branches.
users property (optional). Should be a name or an array of user names to aply permission to.
groups property (optional). Should be a group name or an array of user groups to aply permission to.

Note that permission type (replace branch property with pattern, and vise versa) of the initial permission shouldn't be done. Otherwise it might lead to unexpected results.

#remove

Delete existing branch permision on a repository:

// Returns Promise resolved to undefined on success
stashApi.branchPermissions.remove(projectKey, repositorySlug, permissionId);

Repository branching model

#get

Get current branching model for a repository:

// Returns Promise resolved to the current branching model on success, or rejected with an error if branching model is disabled
stashApi.branchingModel.get(projectKey, repositorySlug);

#enable

Enable branching model for a repository:

// Returns Promise resolved to the branching model on success
stashApi.branchingModel.enable(projectKey, repositorySlug);

#disable

Disable branching model for a repository:

// Returns Promise resolved to an undefined on success
stashApi.branchingModel.disable(projectKey, repositorySlug);

License

MIT

Usage no npm install needed!