lykdat

Lykdat JavaScript SDK

Official JavaScript SDK for Lykdat API

NOTE: This library is suited for a Web Browser environment only and will not work in a Node JS environment.

Install

npm install lykdat

Usage

Two primary functionalities are offered by this SDK: Image Search and Product Alerts

Image Search

The Image Search function does all the UI related heavy-lifting for you, thereby relieving you of the stress. All you need to do is invoke the function and it renders a search button at the bottom right corner of your page. Once a search is completed, it also renders the search results UI for you.

The Image Search function can be used like so:

import * as lykdat from 'lykdat'

window.addEventListener('load', () => {
    lykdat.initImageSearchUI({
        apiKey: 'YOUR_API_KEY_HERE',
        catalogName: 'Another TS',
    })
})

If you'd like to use your own custom search button, just pass the css selector to your button so the appropriate event handler can be attached to it:

import * as lykdat from 'lykdat'

window.addEventListener('load', () => {
    lykdat.initImageSearchUI({
        apiKey: 'YOUR_API_KEY_HERE',
        catalogName: 'Another TS',
        triggerSelector: '#my-button-id'
    })
})

Product Alert

The Product Alert API offers both UI and non-UI functionality.

Price Alerts

With the Price Alerts function your users can subscribe to know when the price of a Product drops. The function can be used like so:

import * as lykdat from 'lykdat'

const config = {
    publishableApiKey: 'YOUR_API_KEY_HERE',
    websiteName: 'mywebsite'
}
const email = '[e-mail]'
const productUrl = 'https://mywebsite.url/product/url'

lykdat.subscribeToPriceAlert(config, email, productUrl).then(() => {
    console.log('success')
}).catch((err) => {
    // handle error
})

In-stock Alerts

With the In-stock Alerts function, your users can subscribe to know when a currently unavailable product is back in-stock. The function can be used like so:

import * as lykdat from 'lykdat'

const config = {
    publishableApiKey: 'YOUR_API_KEY_HERE',
    websiteName: 'mywebsite'
}
const email = '[e-mail]'
const productUrl = 'https://mywebsite.url/product/url'

lykdat.subscribeToInStockAlert(config, email, productUrl).then(() => {
    console.log('success')
}).catch((err) => {
    // handle error
})

In-stock Alerts UI

This Function Attaches a Form UI to the dom. With this Form, users of your website can subscribe to be notified when the related product is in-stock. This functionality removes the need for you to add any UI related code by doing it all for you.

The UI Finction can be used like so:

import * as lykdat from 'lykdat'

window.addEventListener('load', () => {
    lykdat.initInStockAlertUI({
        publishableApiKey: 'YOUR_API_KEY_HERE',
        websiteName: 'Another TS',
        targetSelector: '#back-in-stock-container'
    })
})

Examples

To see how the SDK is used in code examples, please the examples folder

• Image Search Example using the default UI button
• Image Search Example using a custom button
• Product Alerts Example using In-stock Alert UI