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

exoplatform-api-wrapper

v0.1.8

Published

An eXo Platform Social REST API wrapper 🧐

Downloads

1

Readme

exoplatform-api-wrapper

npm badge Build Status

A wrapper for the API of the Open source Enterprise Social Network of eXo Platform. It covers the Social REST API, which is badly documented.

It is entirely built from TypeScript and fully tested. API responses are typed, so you can get full auto-completion in your code editor.

This project is dependency-free.

Install

yarn add exoplatform-api-wrapper
# or
npm i exoplatform-api-wrapper

Usage

The example below shows how to get activities available in a user's feed.

import ExoPlatformWrapper from 'exoplatform-api-wrapper'

const setup = async () => {
  const exoWrapper = new ExoPlatformWrapper('www.example.com')
  await exoWrapper.login('myUsername', 'myPassword')
  const { activities } = await exoWrapper.user.readStream()
  console.log(activities)
}

setup()

Documentation

See rigwild.github.io/exoplatform-api-wrapper.

Full API coverage/example is available in the automated tests: ./test/tests.ts.

Running tests

You must configure the tests by setting the following environment variables.

| Environment variable | Description | Required | Default | Example | | -------------------- | ----------- | :------: | ------- | ------- | | EXO_HOSTNAME | eXo Platform social network hostname (no protocol://) | ✅ ||www.example.com | | EXO_PATH | eXo Platform API path | ❌ | /rest | /exo/platform/rest | | EXO_USERNAME | eXo Platform account username | ✅ || myUser | | EXO_PASSWORD | eXo Platform account password | ✅ || myPassword | | EXO_SECURE_PROTOCOL | SSL protocol to use (do not touch if you don't know what it is!!) | ❌ | undefined | TLSv1_method | | EXO_CIPHERS | SSL ciphers to use (do not touch if you don't know what it is!!) | ❌ | undefined | AES128-SHA |

Then, you can run the tests:

yarn test
# or
npm run test

Notice

The author of this library is not affiliated in any way with eXo Platform.

Contributing

If you found a bug or want any features not available yet, feel free to open an issue documentating the problem.

You may also contribute to the project by opening a Pull Request.

License

The MIT license