Installation

By default, Alokai integration for SmartEdit is meant to be used as a Storefront module. However, it can also be installed in any Next or Nuxt application.

Requirements

Next or Nuxt frontend with Alokai SDK installed (latest version),
Server Middleware application (latest version),
SmartEdit included in your SAP Commerce Cloud project,
Node.js version 18.x,
@vsf-enterprise NPM registry access.

Installing dependencies

In your Server Middleware application, install the following dependencies:

yarn

yarn add @vsf-enterprise/smartedit-api

Configuring Server Middleware

The next step is configuring the SmartEdit integration in the Server Middleware.

Key concept - Server Middleware

Middleware concept is described in detail in our Key concepts: Server Middleware docs.

Add the following configuration to your Server Middleware configuration file. Replace the placeholders with your SAP Commerce Cloud API data.

middleware.config.ts

import type { Integration } from "@vue-storefront/middleware";
import type { MiddlewareConfig as SmarteditMiddlewareConfig } from "@vsf-enterprise/smartedit-api";

export default {
  integrations: {
    smartedit: {
      location: "@vsf-enterprise/smartedit-api/server",
      configuration: {
        api: {
          uri: "<your_sapcc_api_uri>",
          baseSiteId: "<your_base_site_id>",
          catalogId: "<your_catalog_id>",
          catalogVersion: "<your_catalog_version>",
          defaultLanguage: "<your_default_language>",
          defaultCurrency: "<your_default_currency>",
        },
      } satisfies Integration<SmarteditMiddlewareConfig>,
    }
  }
};

Configuring Alokai SDK

The last step in the process is configuring Alokai SDK for SmartEdit in your frontend application.

Key concept - SDK

SDK core is described in detail in our SDK docs.

Add the following configuration to your Alokai SDK configuration file:

sdk.config.ts

import { smartEditModule } from '@vsf-enterprise/smartedit-sdk';

export function getSdkConfig() {
  return defineSdkConfig(({ buildModule, config }) => ({
    smartedit: buildModule(smartEditModule, {
      apiUrl: `${config.middlewareUrl}/smartedit`
    }),
  }));
}