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

@interopio/manager-api

v3.1.5

Published

Provides a minimal higher-level wrapper around io.Manager Server API

Downloads

1,388

Readme

Overview

Provides a minimal wrapper around io.Manager REST APIs to simplify the process of fetching and modifying data stored in io.Manager Server by JavaScript applications.

Usage

There are two types of APIs exposed by the package:

  • AdminAPI - used to fetch or modify any type of data stored in io.Manager Server
  • ClientAPI - used to fetch data specific to a single user (e.g. user's applications and layouts); allows updating entities that are owned by the user.

Initialization

Initialization is similar for both APIs. You should provide an options object that has two required properties:

  • baseUrl which is the Server API endpoint. \The
  • auth contains the authentication on the specific authentication.
    import { AdminAPI, ClientAPI } from "@interopio/manager-api");

    const admin = new AdminAPI({
        baseUrl: `http://localhost:3465/`,
        auth: {
            token: {
                bearer: this.auth?.token
            }
        }
    });

    const client = new ClientAPI({
        baseUrl: `http://localhost:3465/`,
        auth: {
            token: {
                bearer: this.auth?.token
            }
        }
    });

Adding Extra Headers

You can add extra headers to be sent with each request by using the headers property of the options object.

    const admin = new AdminAPI({
        baseUrl: `http://localhost:3465/`,
        auth: {
            token: {
                bearer: this.auth?.token
            }
        },
        headers: {
            "X-Extra-Header": "value"
        }
    });

Transforming responses

You can transform incoming responses using the transformResponse method. This method is called with the response object and should return the transformed response.

const admin = new AdminAPI({
    baseUrl: `http://localhost:3465/`,
    auth: {
        token: {
            bearer: this.auth?.token
        }
    },
    transformResponse: (data, headers, status) => {
        const responseType = header["content-type"];
        if (responseType && responseType.includes("application/json") && typeof (data) === "string") {
            return this.parse(data);
        } else {
            return data;
        }
    }
});

AdminAPI

The AdminAPI allows you to manage any type of entity stored by the server. Operations are exposed as methods attached to sub-properties of the API object. For example, to fetch all applications, you would call the admin.apps.getAll() method.

  • apps - Manage Applications;
  • groups - Manage Groups;
  • users - Manage Users;
  • layouts - Manage Layouts;
  • commands - Manage Commands;
  • sessions - Manage Sessions;
  • machines - Manage Machines;
  • crashes - Manage Crashes;
  • feedbacks - Manage Feedbacks;
  • prefs - Manage Prefs;
  • audit - Manage AuditAPI;
  • server - Manage ServerAPI;
  • systemConfig - Manage SystemConfigAPI;
  • schemas - Manage SchemaAPI;

ClientAPI

The operations in the ClientAPI work in the context of a single user.

Changelog

Check the changelog