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

@e2y/occ-client

v3.0.2

Published

OCC client for SAP Commerce Cloud

Downloads

7,979

Readme

occ-client v3

This package acts as a client for the SAP Commerce OCC that expose the API docs as an OpenAPI3.0 specification.

Creation of the client

Without client credentials

In case you don't need access token to be able to operate with the API, you can create the client directly.

import {OccClient} from '@e2y/occ-client';
import {paths} from '../../types/occ/schema';

const occClient = await new OccClient(
  new URL('https://localhost:9002/occ/v2/')
).create<paths>();

With client credentials

import {OccClient} from '@e2y/occ-client';
import {paths} from '../../types/occ/schema';

const occClient = await new OccClient(
  new URL('https://localhost:9002/occ/v2/'),
  {
    oauthTokenUrl: new URL(
      'https://localhost:9002/authorizationserver/oauth/token'
    ),
    clientId,
    clientSecret
  }
).create<paths>();

With password credentials

Depending on the actions you want to make, you may need to use the password grant type. To do so, you can use the password method.

import {OccClient} from '@e2y/occ-client';
import {paths} from '../../types/occ/schema';

const occClient = await new OccClient(
  new URL('https://localhost:9002/occ/v2/'),
  {
    oauthTokenUrl: new URL(
      'https://localhost:9002/authorizationserver/oauth/token'
    ),
    clientId,
    clientSecret,
    username,
    password
  }
).create<paths>();

Using the client

First, you need to specify the paths of the resources you want to use (refer to [Creating schema from OpenAPI3.0]( #creating- schema-from-openapi30)). In case of the OCC-Client, you do this once you instantiate the client.

import {OccClient} from '@e2y/occ-client';
// This are the paths you need to import
import {paths} from '../../types/occ/schema';

const occClient = await new OccClient(...).create<paths>()

Then, you create the endpoint you want to use.

const getCurrencies = fetcher
  .path('/{baseSiteId}/currencies')
  .method('get')
  .create();

Finally, you can use the endpoint to get the data you want.

const currenciesResponse = await getCurrencies({baseSiteId: 'wololo'});

Creating schema from OpenAPI3.0

You can create the schema of any API that meets the OpenAPI3.0 specification. To do so, you can use the schema package.

npx openapi-typescript https://myapi.dev/api/v1/openapi.yaml -o ./path/to/my/schema.d.ts

You can find more information about this here.

Using the OAuth2 Client

The OccClient uses the OAuth2Client class to handle the authentication. You can use it directly if you need to perform actions that are not covered by the OccClient.

import {OAuth2Client} from '@e2y/occ-client';

const oauth2Client = new OAuth2Client({
  oauthTokenUrl: new URL(
    'https://localhost:9002/authorizationserver/oauth/token'
  ),
  clientId,
  clientSecret,
  username,
  password
});

const {accessToken} = await oauth2Client.getToken();