RequestKit

Installation

npm install @requestkit/node

Usage

import { RequestKit } from "@requestkit/node";
 
const requestKit = new RequestKit({
  apiKey: "your-api-key",
});

API Keys allow anyone with the key to create feature requests, upvote them or remove the upvotes. It is adviced to use API keys serverside with proper authorization in your application.

More Granular Access Control is planned for the future.

Methods

Create a feature request

const featureRequest = await requestKit.createRequest({
  title: "Feature Request Title",
  description: "Feature Request Description",
  requester:{ 
    identifier: "user-123",
    email: "[email protected]", // optional
    name: "John Doe", // optional
  } // optional
});

Upvote a feature request

const upvote = await requestKit.upvoteRequest(featureRequest.id,{
    user:{
        identifier: "user-123",
        email: "[email protected]",
        name: "John Doe",
    }
});

Remove an upvote from a feature request

const removedUpvote = await requestKit.removeUpvoteFromRequest(featureRequest.id,{
    userIdentifier:"user-123"
});

Get a feature request

const featureRequest = await requestKit.getRequest(featureRequest.id);

Get comments for a feature request

const comments = await requestKit.getComments(featureRequest.id, {
  // Optional query parameters for pagination
  page: 1,
  limit: 10
});

Create a comment

const comment = await requestKit.createComment(featureRequest.id, {
  content: "This is a comment",
  commentor: {
    identifier: "user-123",
    email: "[email protected]", // optional
    name: "John Doe" // optional
  }
});

Delete a comment

const deleted = await requestKit.deleteComment(featureRequest.id, commentId);

Node.js SDK