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

@xdabuss/vendure-plugin-ninja-tax

v1.0.8

Published

Vendure plugin for sales tax in US using NinjaAPI

Downloads

342

Readme

NinjaAPI US Tax Plugin

This plugin provides a simple way to add in US sales tax to Vendure orders. The plugin adds TaxLines to an order based on the customer's zipcode. Tax data is retrieved from https://api-ninjas.com/api/salestax. State, city, county, and misc. tax rates for a given zip code are retrieved from this endpoint and added as separate TaxLines.

Usage

  1. yarn add @xdabuss/vendure-plugin-ninja-tax
  2. Add plugin to vendure config:
export const config: VendureConfig = {
  // .. the rest of your vendure config
  plugins: [
    NinjaTaxPlugin.init({fallbackTaxRate: 15}),
    )},
};

fallbackTaxRate is an optional value that will be used for a US customer if the call to NinjaAPI fails. If unset, its default is 15%, since that should cover even the highest US sales tax locations. My thinking is you'd rather let the order continue (and possible refund the extra tax later) with a default rate than have the order fail if NinjaAPI is unresponsive.

  1. Create Ninja API account, create API key, add NINJA_KEY=<example_key> to root level .env file

Relevant Docs

  • https://api-ninjas.com/api/salestax
  • https://docs.vendure.io/guides/core-concepts/taxes/
  • https://docs.vendure.io/reference/typescript-api/tax/tax-line-calculation-strategy
  • https://docs.vendure.io/reference/typescript-api/orders/order-item-price-calculation-strategy/

Notes

  • If the shiping address is not from the US (order.shippingAddress.countryCode !== "US"), the tax lines will be calculated using Vendure's DefaultTaxLineCalculationStrategy

Possible improvements

  • Use caching for the tax rates so that NinjaAPI doesn't need to be called if customer's zipcode is already in cache

Development

Run yarn dev to start Vendure on http://localhost:3050/admin

License

MIT