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

redmine-ts

v0.3.0

Published

Redmine REST API client written using TypeScript

Downloads

397

Readme

Redmine-ts

redmine-ts is Redmine REST API client written using TypeScript and using Axios for making requests.. It supports 100% of Redmine's API features.

Installation

npm install --save redmine-ts

Usage

const fs = require('fs');
import {Redmine, RedmineTS} from 'redmine-ts';

// RedmineTS namespace can be used! (version 0.3.0+)
const redmineConfig: RedmineTS.Config = {
    /**
     * apiKey (optional) Redmine API key
     */
    apiKey: 'abcdef0123456789abcdef0123456789',

    /**
     * username (optional) Redmine username (login)
     */
    username: 'api-user',

    /**
     * password (optional) Redmine password
     */
    password: 'mySuperSecretPassword&TwoZero21',

    /**
     * impersonateUser (optional) Impersonate user login
     * See more: https://www.redmine.org/projects/redmine/wiki/rest_api#User-Impersonation
     */
    impersonateUser: 'secondUser',
    
    /**
     * maxUploadSize (optional) Maximum size of sent files in bytes. Default value: 5242880 (5MB)
     * Note that it's only changes the maxBodyLength parameter of axios.
     * Max upload size accepted by Redmine needs to be setted by administrator in settings!
     */
    maxUploadSize: 5242880
};

// Initialization
const redmine = new Redmine('https://redmine-hostname.com:3000', redmineConfig);

// Example 1: List 5 issues
redmine.listIssues({
    limit: 5
})
.then(iObj => {
    console.log(`Showing ${iObj.issues.length} of ${iObj.total_count} total results:`, iObj.issues)
})
.catch(err) {
    console.log('List issues error:', err)
}

// Example 2: Add attachment to issue
const fileContent = fs.readFileSync('example-image.png');
redmine.uploadFile(fileContent).then(res => {
    const { token } = res.upload;

    redmine.updateIssue(1, {
        uploads: [
            token,
            filename: 'sweet-duckling.png',
            content_type: 'image/png',
            description: 'A photo of a yellow lovely duckling!'
        ]
    })
})

Authentication

redmine-ts supports authentication using an API key as well as login/password. However, providing an authentication is not required - this allows for sending inquiries about publicly available resources.

If three parameters are given: API key, login and password, the API key always takes precedence. Additionally, the library does not attempt to automatically log in with the login/password in case of an incorrect API key

Additional

Limitations:

  • The current version only supports JSON format (implementation of XML versions is not planned)

  • ~~apiKey is the only authentication method right now~~ Since version 0.3.0 both authentication methods are available 😊

Known problems:

  • ❗ Please use version 0.2.3 or above. Previous versions are broken by wrong pipeline configuration

  • The parameter cf_x in the listIssues method (API ref) was not included, so TypeScript reports an error. Currently, to work around this problem, please use @ts-ignore (Issue #20)

  • Search method - Since official documentation are not completed yet, only limit and offset parameters are available (Issue #19)

Planned improvements

  • ✔️ ~~Add support for username/password authentication~~ available from verion 0.3.0

  • ✔️ ~~Add support for User-Impersonation~~ available from verion 0.3.0

License

This software is distributed under the MIT License.