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

magento2-api-wrapper

v2.0.0-alpha.1

Published

Minimal Magento 2 API library. Both node and browser compatible

Downloads

2,105

Readme

Magento 2 API

License: MIT NPM Dependencies Builds Coverage

Small Magento 2 API client that's ready to use. Works in browsers, node and Deno.

  • Dependency free
  • Works in Browser, node, Deno
  • As minimal as it can get

Node.js

Install

npm install magento2-api-wrapper

or

npm jsr install @lumnn/magento2-api

Usage

As a guest

import { Magento2Api } from "magento2-api-wrapper"
// or
// const Magento2Api = require('magento2-api-wrapper')

var consumer = new Magento2Api({ baseUrl: "https://localhost" })

consumer.$get("directory/countries")
  .then((data) => console.log)

// or in async functions
var countries = await customer.$get("directory/countries")

As a admin/customer

// Api Keys: Magento Admin > System > Extensions > Integration
var admin = new Magento2Api({
  baseUrl: "https://localhost",
  consumerKey: "xxx",
  consumerSecret: "xxx",
  accessToken: "xxx",
  tokenSecret: "xxx",
})

admin.$get("products", {
  params: {
    searchCriteria: {
      currentPage: 1,
      pageSize: 1,
    },
  },
})
  .then((data) => console.log)

Responses: Successfull response returns plain Magento data. Not wrapped as in Axios.

Deno

Above examples should be pretty much similar only difference is in how module is imported

import { Magento2Api } from "@lumnn/magento2-api"

Methods / Properties

Basic request method to trigger any kind of request

  • .request(method: string, path: string, data: any, options?: RequestOptions): Promise

Additionally following helper methods are available that simplify the process of getting JSON data and adding types to responses (supports generics)

  • .$get(url: string, options?: RequestOptions): Promise
  • .$delete(url: string, options?: RequestOptions): Promise
  • .$post(url: string, data: any, options?: RequestOptions): Promise
  • .$put(url: string, data: any, options?: RequestOptions): Promise
  • .$patch(url: string, data: any, options?: RequestOptions): Promise

Options

Constructor Options

  • api.url: string - required - a baseUrl for magento instace
  • api.consumerKey: string - (optional) - for authentication
  • api.consumerSecret: string - (optional) - for authentication
  • api.accessToken: string - (optional) - for authentication
  • api.tokenSecret: string - (optional) - for authentication

Method options

When executing any of the methods like .get, .post you may use extra config options on top of regular Request config:

  • params: object - an object for easier GET parameter building
  • storeCode: string - setting storeCode will change base url so it's like https://example.org/rest/{storeCode}/V1/

Useful Examples

Allowing self-signed certificate

Deno: --unsafely-ignore-certificate-errors=localhost. Node: NODE_TLS_REJECT_UNAUTHORIZED=0

Run tests

deno test