Nodeschool Public Materials

    simple-social-signin
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.2 • Public • Published

    Build Status

    Simple Social Signin

    Simple social sign in for Node.js

    Setup

    npm install simple-social-signin

    or

    yarn add simple-social-signin

    Usage

    Google

    1. Import
    import { getGoogleAuthUri, getGoogleUserInfo } from 'simple-social-signin';
    1. Get auth URI
    const authUri = getGoogleAuthUri({
        clientId: 'a client ID',
        redirectUri: 'https://example.com/my-google-callback',
    });  // Send this to the browser for the user to open
    1. Get user info
    console.log(await getGoogleUserInfo({
        code: 'code URL query you get at /my-google-callback',
        clientId: 'a client ID',
        clientSecret: 'a client secret',
        redirectUri: 'https://example.com/my-google-callback'
    }));
    {
      email: '...',
      family_name: '...',
      gender: '...',
      given_name: '...',
      hd: '...',
      id: '...',
      link: '...',
      locale: '...',
      name: '...',
      picture: '...',
      verified_email: boolean,
      token: {
          access_token: '...',
          refresh_token: '...',
          scope: '...',
          token_type: '...',
          id_token: '...',
          expires_in: '...',
          created_at: '...',
      }
    }
    

    Facebook

    1. Import
    import { getFacebookAuthUri, getFacebookUserInfo } from 'simple-social-signin';
    1. Get auth URI
    const authUri = getFacebookAuthUri({
        clientId: 'a client ID',
        redirectUri: 'https://example.com/my-facebook-callback',
        state: 'a random string'
    });
    1. Get user info
    console.log(await getFacebookUserInfo({
        code: 'code URL query you get at /my-facebook-callback',
        clientId: 'a client ID',
        clientSecret: 'a client secret',
        redirectUri: 'https://example.com/my-facebook-callback'
    }));
    {
        email: '...',
        id: '...',
        first_name: '...',
        middle_name: '...',
        last_name: '...',
        short_name: '...',
        name: '...',
        name_format: '...',
        picture: {
            data: {
                height: 123,
                is_silhouette: boolean,
                url: '...',
                width: 321
            }
        }
    }
    

    Dependencies

    • Superagent HTTP lib

    Development

    Easiest way is to use yarn to install this package locally

    In your app:

    yarn add file:./../../simple-social-signin

    Keywords

    none

    Install

    npm i simple-social-signin

    DownloadsWeekly Downloads

    1

    Version

    2.0.2

    License

    MIT

    Unpacked Size

    32.8 kB

    Total Files

    9

    Last publish

    Collaborators

    • omarryhan