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

shopabase

v1.1.2

Published

Shopabase is a wrapper of Shopify admin RESTapi. It is heavily inspired by **firebase/firestore** which allows the apis to be written in queries. Installation:

Downloads

10

Readme

Introduction

Shopabase is a wrapper of Shopify admin RESTapi. It is heavily inspired by firebase/firestore which allows the apis to be written in queries.
Installation:

npm install shopabase or yarn add shopabase  

Migrate from axios or fetch to shopabase

axios.post(`https://${apiKey}:${accessToken}@${shop}/admin/api/${apiVersion}/products.json`,{
	"product":{
	   "title":"product1"
	}
})


// => with shopabase syntax
shopifyAdminApp.collection("product").add({"title":"product1"});

Setup

const { initializeApp } = require("shopabase");

let shopifyAdminApp = initializeApp({
  shop: process.env.SHOPIFY_STORE_NAME,
  apiKey: process.env.SHOPIFY_ADMIN_API_KEY,
  apiVersion: process.env.SHOPIFY_ADMIN_API_VERSION,
  accessToken: process.env.SHOPIFY_ADMIN_API_ACCESS_TOKEN
});

With NodeJs

require("dotenv").config();
const express = require("express");
const cors = require("cors");
const app = express();
const { initializeApp } = require("shopabase");

let shopifyAdminApp = initializeApp({
  shop: process.env.SHOPIFY_STORE_NAME,
  apiKey: process.env.SHOPIFY_ADMIN_API_KEY,
  apiVersion: process.env.SHOPIFY_ADMIN_API_VERSION,
  accessToken: process.env.SHOPIFY_ADMIN_API_ACCESS_TOKEN
});

app.use(cors({ origin: true }));

app.post("/customers/create", async (req, res, next) => {
  try {
    const { data } = await shopifyAdminApp.collection("customer").add(req.body);

    res.status(200).send(data);
  } catch (error) {
    res.status(404).send("Customer info is not valid");
  }
  return next();
});

app.get("/customers/:id", async (req, res, next) => {
  const { id } = req.params;

  try {
    const { data } = await shopifyAdminApp.collection("customer").doc(id).get();
    res.status(200).send(data);
  } catch (error) {
    res.status(404).send("Item does not exist!");
  }

  return next();
});

app.put("/customers/:id", async (req, res, next) => {
  const { id } = req.params;

  try {
    const { data } = await shopifyAdminApp.collection("customer").doc(id).update(req.body);
    res.status(200).send(data);
  } catch (error) {
    res.status(404).send("Item does not exist!");
  }

  return next();
});

app.get("/customers", async (_req, res, next) => {
  const { data } = await shopifyAdminApp.collection("customer").get();

  res.status(200).send(data);
  return next();
});

app.delete("/customers/:id", async (req, res, next) => {
  const { id } = req.params;

  try {
    const { data } = await shopifyAdminApp.collection("customer").doc(id).delete();
    res.status(200).send(data);
  } catch (error) {
    res.status(404).send("Item does not exist!");
  }

  return next();
});

app.listen(port, () => {
  console.log(`Example app listening at http://localhost:${port}`);
});

Queries


  // GET
  // Get by id
  const { data } = await shopifyAdminApp.collection("custom_collection").where("product_id", "==", id).get();
  // Get a list
  const { data } = await shopifyAdminApp.collection("product").get();
  // Get using query params
  const collectsRes = await shopifyAdminApp
    .collection("collect")
    .where("product_id", "=", productId)
    .where("fields", "=", "id")
    .get();
  
  // POST
  // ex. productData = {title:"product1", }
  const { data } = await shopifyAdminApp.collection("product").add(productData);
  
  // PUT
  const { data } = await shopifyAdminApp.collection("product").doc(id).update(productData);
  
  // DELETE
  const { data } = await shopifyAdminApp.collection("customer").doc(id).delete();
  
  // Custom actions:
  // Generated url: https://123456789:at99999@nike/admin/api/2021-10/customers/207119551/addresses/1053317290/default.json
  cost {initializeApp, getMethodName} = require("shopabase");
  
  let shopifyAdminApp = initializeApp({
    shop: "nike",
    apiKey: "123456789",
    apiVersion: "2021-10",
    accessToken: "at99999"
  });
  
  const actual = await shopifyAdminApp
      .collection("customers/207119551/address)
      .doc(docId)
      .execAction(getMethodName().PUT, "default");

github source