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

@labdigital/bluestonepim-sdk

v0.0.4

Published

Bluestone PIM SDK

Downloads

336

Readme

BluestonePIM SDK

This SDK provides methods to interact with the BluestonePIM API. It includes methods to retrieve differences in products and relations during synchronization operations.

Installation

To install the SDK, use npm:

# Using npm
npm install @labdigital/bluestonepim-sdk

# Using yarn
yarn add @labdigital/bluestonepim-sdk

# Using pnpm
pnpm add @labdigital/bluestonepim-sdk

Usage

import { DifferencesApi, Configuration } from "@labdigital/bluestonepim-sdk";

const config = new Configuration({
  apiKey: "your-api-key-here",
  basePath: "https://api.test.bluestonepim.com/v1",
});

const differencesApi = new DifferencesApi(config);

const requestParameters = {
  id: "sync-id",
  diffType: "type",
  itemsOnPage: 10,
  pageNo: 1,
};

const productDifferences =
  await differencesApi.getProductDifferencesOnSyncDeletes(requestParameters);
console.log(productDifferences);

Retrying requests

The Bluestone PIM API may return a 429 status code when the rate limit is exceeded. To handle this, you can use the retry function from the fetch-retry package. This function will retry the request a number of times with a delay between each attempt.

# Using npm
npm install fetch-retry isomorphic-fetch

# Using yarn
yarn add fetch-retry isomorphic-fetch

# Using pnpm
pnpm add fetch-retry isomorphic-fetch
const config = new Configuration({
  fetchApi: retry(fetch, {
    retries: 5, //Retry 5 times
    retryDelay: 1000, //Retry after 1 second
    retryOn: (attempt: number, error, response: Response | null): boolean => {
      // Only retry when 429 is hit, otherwise we continue
      if (response != null && response.status === 429) {
        logger.debug({
          msg: "Retrying Bluestone PIM request",
          attempt: attempt,
          responseStatus: response.status,
        });
        return true;
      }
      return false;
    },
  }),
  // Your other configuration options
});

Development

To regenerate the SDK, run the following command:

pnpm run sdk:generate

This will generate the SDK in the src directory.