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

@typhoslabs/shopify

v3.0.4

Published

Thin wrapper for specific handling of Shopify for TyphosLabs

Downloads

50

Readme

shopify

A wrapper around shopify-node-api for specific handling of Shopify for TyphosLabs lambdas.

Usage

###Typical usage:

'use strict';

var ShopifyAPI = require('@typhoslabs/shopify')(optional_settings);

module.exports = Shopify.lambda((event, context, callback, shopify) => {
    // do a typical shopify-node-api. Getting the token, filling in the shop, and setting up
    // the shopify-node-api instance is done for you.
    shopify.get("/admin/shop.json", function(err, data, headers){
        // do stuff etc.
        
        // when done
        callback(null);
    });
});

Note: your lambda must use the shopify-auth custom authorizer.

###Install usage:

'use strict';

var Shopify = require('@typhoslabs/shopify')();

module.exports = Shopify.install((event, context, callback, shopify) => {
    // think normal lambda but this function is called when we've
    // requested the permissions, got the token and saved it to the database, and
    // need to add things to the theme files etc. Additional values to be saved
    // to the store record for this app may be returned using the callback
    
    // do async stuff
    
    // success
    return callback();
});

// Will return { session: "averylongsessiontoken", shop: "typhoslabs" } when already installed
// Will return { session: "averylongsessiontoken", shop: "typhoslabs", "installed": true } when newly installed
// Will return { redirect: "... a redirect url ..." } if a redirect is needed

Note: the lambda event must look similar to this:

{
    "query": {
        "shop": "typhoslabs.myshopify.com",
        "...": "my querystring values..."
    },
    "shopify": {
        "api_key": "MY_API_KEY",
        "api_secret": "MY_API_SECRET",
        "redirect_url": "https://api.typhoslabs.com/apps/my-app",
        "scopes": "read_orders,write_orders",
    }
}

Optional Settings

Include optional setting overrides to be passed to shopify-node-api.