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

@realmjs/account-client

v1.4.8

Published

Client side scripts to authenticate with @realmjs/account-restapi

Downloads

6

Readme

@realmjs/account-client

A JavaScript library for handling authentication with a remote server compatible with @ralmjs/account-restapi

Introduction

AccountClient is a JavaScript class that provides methods for handling authentication operations, such as signing up, signing in, signing out, and more.

Installation

To use AccountClient in your project, you can install it via npm:

npm install @realmjs/account-client --save

Usage

import AccountClient from '@realmjs/account-client';

// Initialize AccountClient with required properties
const accountClient = new AccountClient({
  baseurl: 'https://your-auth-server.com',
  app: 'your-app-id',
  session: 'your-session-key',
});

// Event handling example
accountClient.on('authenticated', (session) => {
  console.log('User authenticated:', session);
});

// Sign up example
accountClient.signup()
  .then(() => {
    console.log('Sign up successful');
  })
  .catch((error) => {
    console.error('Sign up failed:', error);
  });

// Sign in example
accountClient.signin()
  .then((session) => {
    console.log('Sign in successful:', session);
  })
  .catch((error) => {
    console.error('Sign in failed:', error);
  });

// Sign out example
accountClient.signout()
  .then(() => {
    console.log('Sign out successful');
  })
  .catch((error) => {
    console.error('Sign out failed:', error);
  });

// Single Sign-On (SSO) example
accountClient.sso()
  .then((session) => {
    console.log('SSO successful:', session);
  })
  .catch((error) => {
    console.error('SSO failed:', error);
  });

// Other methods (changePassword, query) can be used similarly

API Reference

Constructor

const accountClient = new AccountClient({
  baseurl: 'https://your-auth-server.com',
  app: 'your-app-id',
  session: 'your-session-key',
});

Methods

  • signup(): Initiates the sign-up process.
  • signin(): Initiates the sign-in process.
  • signout(): Initiates the sign-out process.
  • sso(): Initiates the Single Sign-On (SSO) process.
  • changePassword(): Initiates the password change process.
  • query(uid): Queries an account by UID.

Events

  • on(eventName, eventHandler): Adds an event listener.
  • off(eventName, eventHandler): Removes an event listener.
  • emit(eventName, ...args): Emits an event.

Configuration

The AccountClient instance requires the following properties during initialization:

  • baseurl: The base URL of the authentication server.
  • app: The unique identifier for your application.
  • session: The key used for storing session information.

License

This library is licensed under the MIT License - see the LICENSE file for details.