README.md

connect

connect is a library that makes it easier to generate valid Connect URLs that lets your users to link their accounts to Gandalf.

Features

• Generate valid Connect URLs
• Generate valid Connect QRCodes on web
• Parameter validation

Getting Started

This section provides a quick overview of how to integrate the library into your project.

Prerequisites

NodeJS - version 18.x or higher

Installation

npm install @gandalf-network/connect --save

Usage

Import the library

// Typescript && ESModules

import Connect, { Platform } from "@gandalf-network/connect";

// CommonJS

const Connect, { Platform } = require("@gandalf-network/connect");

Initialize Connect

const connect = new Connect({
    publicKey: process.env.PUBLIC_KEY, 
    redirectURL: "YOUR_REDIRECT_URL",
    // The platform defaults to IOS but could be ANDROID or UNIVERSAL
    platform: Platform.ANDROID,
    services: 
    {
        uber: {
            traits: ["rating"], // At least one trait or activity is required
            activities: ["trip"],
        },
        netflix: {
            activities: ["watch"],
            required: false // To make a service optional to the user
        },
    },
    // Optional paramter to modify the Connect UI
    options: {
        style: {
            primaryColor: "#7949D1", 
            backgroundColor: "#fff", 
            foregroundColor: "#562BA6", 
            accentColor: "#F4F0FB"
        }
    }
})

Generate a Connect URL

const url = await connect.generateURL()
console.log(url)

Generate a Connect QRCode

Note: This function will only work within a browser context and will fail otherwise.

const qrCodeURL = await connect.generateQRCode()
console.log(qrCodeURL)

Extract the dataKey from the redirectURL

const datakey = Connect.getDataKeyFromURL("REDIRECT_URL")
console.log(datakey)

Contributing

Contributions are welcome, whether they're feature requests, bug fixes, or documentation improvements.