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

@vue-storefront/sdk

v3.3.0

Published

Alokai SDK is a framework-agnostic communication layer in Alokai Integrations. It communicates with Commerce Platforms and third-party services through the Server Middleware, which works as a proxy. Alokai SDK creates a contract between the storefront and

Downloads

13,573

Readme

Alokai SDK

Alokai SDK is a framework-agnostic communication layer in Alokai Integrations. It communicates with Commerce Platforms and third-party services through the Server Middleware, which works as a proxy. Alokai SDK creates a contract between the storefront and the Server Middleware.

Docs

To learn more about the SDK, visit the SDK documentation.

Installation

To install the SDK, run the following command:

yarn add @vue-storefront/sdk

Before initializing the SDK, ensure you have also installed the desired SDK modules for your project. For instance, to use the SAP Commerce Cloud module, you'll need to install it as well:

yarn add @vsf-enterprise/sapcc-sdk

Warning! The installation process for each module varies and may necessitate additional package installations. Be sure to consult the installation guide for the specific module you intend to use.

Initialization

The examples below use the SAP Commerce Cloud module. However, the same principles apply to all modules.

To initialize the SDK, begin by providing the sdkConfig, which is an object containing the complete SDK configuration.

const sdkConfig = {};

Now, let's incorporate a module into the configuration. To accomplish this, you should:

  1. Import the desired module. By default, it exports a function that returns a collection of module methods. Alokai modules also export a type for these methods.
// SAPCC Example

import { sapccModule, SAPCCModuleType } from '@vsf-enterprise/sapcc-sdk';
  1. Import the buildModule helper from the @vue-storefront/sdk package. This helper is used by the SDK core to properly type the module, enabling IDEs to display TSDocs when hovering over the module's methods.
// SAPCC Example

import { sapccModule, SAPCCModuleType } from '@vsf-enterprise/sapcc-sdk';
import { buildModule } from '@vue-storefront/sdk';
  1. Create a namespace for the module in the sdkConfig and use buildModule helper to build it.
// SAPCC Example

import { sapccModule, SAPCCModuleType } from '@vsf-enterprise/sapcc-sdk';
import { buildModule } from '@vue-storefront/sdk';

const sdkConfig = {
  sapcc:
    buildModule<SAPCCModuleType>(
      sapccModule,
      {
        apiUrl: 'http://localhost:8181/sapcc',
        ssrApiUrl: 'http://localhost:8181/sapcc'
      }
    )
};

Let's now learn about the buildModule in detail.

The buildModule function is a generic function that expects both the module's methods type and the module's extension type.

This helper accepts 3 arguments:

  • module init function (the default export of a module),
  • module options,
  • module extension.
  1. Now, when the sdkConfig is ready, you should import initSDK function from @vue-storefront/sdk package and export it, as shown below.
// SAPCC Example

import { sapccModule, SAPCCModuleType } from '@vsf-enterprise/sapcc-sdk';
import { initSDK, buildModule } from '@vue-storefront/sdk';

const sdkConfig = {
  sapcc:
    buildModule<SAPCCModuleType>(
      sapccModule,
      {
        apiUrl: 'http://localhost:8181/sapcc',
        ssrApiUrl: 'http://localhost:8181/sapcc'
      }
    )
};

export const sdk = initSDK<typeof sdkConfig>(sdkConfig);

The initSDK function is a generic function, that expects the type of the sdkConfig. It accepts the sdkConfig as an argument and returns the sdk client.