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

@kweli/cs-rest

v3.1.4

Published

Simple authentication and REST calls for OpenText Content Server.

Downloads

207

Readme

@kweli/cs-rest

Simple authentication and REST calls for OpenText Content Server.

Features

  • Provides a simplified interface for managing authentication with the OpenText Content Server REST API
  • Refreshes the OTCSTicket token automatically (minimising token expiration errors)
  • Simplifies POST, PUT, & PATCH requests (since Content Server doesn't support the application/json content type)
  • Based on the axios HTTP client
  • Works with Node.js and the browser

Breaking Changes v2

  • The baseURL parameter was renamed baseUrl.

Installing

Using npm:

npm install @kweli/cs-rest

Using yarn:

yarn add @kweli/cs-rest

Example

Authenticate with a username and password and get the details of a node:

import { Session } from "@kweli/cs-rest";

// session wraps an axios instance
const session = new Session({
  baseUrl: "https://.../cs.exe",
  username: "Admin",
  password: "******",
});

// a Session instance can issue authenticated requests to Content Server
const response = await session.get("/api/v1/nodes/2000");

Authenticate with an OTCSTicket:

const session = new Session({
  baseUrl: "https://.../cs.exe",
  otcsticket: "<token>",
});

cs-rest API

Requests can be made with the get, post, put, patch, delete, and options methods on the Session instance. These have the same interface as the respective methods in axios.

Content Server returns a fresh OTCSTicket with each successful API call. The Session instance automatically retains it for the subsequent request.

POST, PUT, & PATCH

The OpenText Content Server REST API doesn't accept requests that use the application/json content type. This means POST, PUT, & PATCH requests need to use a content type of multipart/form-data, which makes writing a request a little more verbose. For example, to create a new folder:

const formData = new FormData();
formData.append("type", 0);
formData.append("parent_id", 2000);
formDAta.append("name", "My New Folder");

const response = await session.post("api/v2/nodes", formData);

The Session class provides a postForm (also putForm and patchForm) method to simplify this:

const response = await session.postForm("api/v2/nodes", {
  type: 0,
  parent_id: 2000,
  name: "My New Folder",
});

axios instance

The underlying axios instance is available if these methods don't suffice:

const axios = session.axios;

Wrapper

The Session class provides a few convenience methods for performing commonly used REST requests. By no means is this complete, and it's possible the API will change in the future.

For example, there is a method for creating a new folder:

const response = await session.nodes.addFolder(2000, "My New Folder");

A method also exists for uploading a document, where file is either:

  • a browser File object (e.g,. from drag and drop); or
  • a local file path, when using Node.js (e.g., c:/temp/file.pdf.
const response = await session.nodes.addDocument(2000, file);

Credits

License

MIT