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

@awhere/api

v0.5.5

Published

The awesome aWhere API for JavaScript.

Downloads

1,033

Readme

@awhere/api

1. Register the API with your credentials

- Register with API Key

import { APIKey, CredentialType, identityManager } from '@awhere/api/identity';
const credential = new APIKey({
    aWhereUrl: '<Your aWhere URL>',
    key: '<Your aWhere API Key>',
});
identityManager.registers([credential]);
identityManager.setDefaultCredential(credential);

- Register with OAuth2.0 flow

ES6

// signin.js

import { OAuth, CredentialType, identityManager } from '@awhere/api/identity';
const credential = new OAuth({
    aWhereUrl: '<Your aWhere URL>',
    appId: '<Your App Id>',
    callbackUrl: '/oauth-callback',
});
identityManager.registers([credential]);
identityManager.setDefaultCredential(credential);
credential.syncWithStorage().then(() => {
    if (!identityManager.defaultOAuth.signedIn) {
        return identityManager.defaultOAuth.signIn();
    }
    // go to the signed-in page
});
// oauth-callback.js

import { fetchToken } from '@awhere/api/identity';

fetchToken(location)
    .then(() => {
        // authorized page
        location.href = '/';
    })
    .catch((err) => {
        // oauth flow authorized page
        location.href = '/sigin?' + err;
    });

HTML

<script src="<Your aWhere JavaScript API URL>"></script>
<script>
    const credential = new awhere.identity.OAuth({
        aWhereUrl: '<Your aWhere URL>',
        appId: '<Your App Id>',
        callbackUrl: '/oauth-callback.html',
    });
    awhere.identity.identityManager.registers([credential]);
    awhere.identity.identityManager.setDefaultCredential(credential);
    credential.syncWithStorage().then(() => {
        if (!awhere.identity.identityManager.defaultOAuth.signedIn) {
            return awhere.identity.identityManager.defaultOAuth.signIn();
        }
        // go to the signed-in page
    });
</script>
<!-- oauth-callback.html -->

<script src="<Your aWhere JavaScript API URL>"></script>
<script>
    awhere.identity
        .fetchToken(location)
        .then(() => {
            // authorized page
            location.href = '/';
        })
        .catch((err) => {
            // oauth flow authorized page
            location.href = '/sigin?' + err;
        });
</script>

2. Use the API

import { Item, User } from '@awhere/api/core';
// Load item
Item.fromId('xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx').then((items) => {
    console.log('items', items);
});

// List users (admin only)
User.find().then((users) => {
    console.log('users', users);
});

HTML Page

<script src="<Your aWhere JavaScript API URL>"></script>
<script>
    // List your content
    awhere.core.Item.fromId('xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx').then((item) => {
        console.log('item', item);
    });

    // List users (admin only)
    awhere.core.User.find().then((users) => {
        console.log('users', users);
    });
</script>