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

marketing-k

v0.0.2

Published

Package abstracting away integration with Sagiton Opportunity Service

Downloads

2

Readme

Installation

To run service locally you have to perform following steps:

  1. Install NodeJS 16.x or later in you operating system
  2. Run npm install in terminal in project root
  3. Run npm run sandbox in terminal in project root

Sandbox

Sandbox is examplary react implementation of package which allows for quick debugging and testing how it behaves in real browser environment.

To open sandbox environment, please follow installation steps above.

Implementation

To implement package into your application, please install it through npm command:

npm install @sagiton/opportunity-js

and then import package functions or hooks (in case you have React application) to request opportunity service:

import {getConsents, getConsentsByType, sendOpportunity, healthCheck} from '@sagiton/opportunity-js'

import {useHealthCheck, useGetConsents, useGetConsentsByType, useSendOpportunity} from '@sagiton/opportunity-js'

Please inspect sandbox file src/index.tsx to see exemplary implementation.

Package is built with typescript, so it's fully typed and your IDE should hint you all required parameters and returned types of all exposed functions.

All functions requesting Opportunity are promised based and all hooks returns flags like isSubmitting, isSubmitted, isError and error for your convenience.

Deployment to NPM and CDN

To deploy new package version to sagiton npm, you have to:

  1. Run npm login command in terminal to login to sagiton npm account using credentials in bitwarden
  2. Upgrade package version in package.json file
  3. Run npm run build to rebuild lib folder which will be uploaded to npm
  4. Run npm run build-cdn to rebuild cdn folder with cdn file which will be uploaded to npm
  5. Run npm publish to publish latest changes to npm
  6. Your CDN file will be available under url: https://cdn.jsdelivr.net/npm/@sagiton/opportunity-js@{{PACKAGE_VERSION}}/cdn/opportunity-js.min.js