Quick start

yarn add @vsf-enterprise/sfcc-api

yarn add @vue-storefront/middleware

// middleware.config.js

require("dotenv").config();

module.exports = {
  integrations: {
    sfcc: {
      location: "@vsf-enterprise/sfcc-api/server",
      configuration: {
        cache: process.env.SFCC_CACHE !== "false",
        timeout: process.env.SFCC_TIMEOUT || 10000,
        origin: process.env.SFCC_ORIGIN,
        siteId: process.env.SFCC_SITE_ID,
        scapiClientId: process.env.SFCC_SCAPI_CLIENT_ID,
        slasClientId: process.env.SFCC_SLAS_CLIENT_ID,
        slasClientSecret: process.env.SFCC_SLAS_CLIENT_SECRET,
        ocapiClientId: process.env.SFCC_OCAPI_CLIENT_ID,
        scapiClientSecret: process.env.SFCC_SCAPI_CLIENT_SECRET,
        ocapiClientSecret: process.env.SFCC_OCAPI_CLIENT_SECRET,
        ocapiVersion: process.env.SFCC_OCAPI_VERSION,
        commerceApiVersion: process.env.SFCC_SCAPI_VERSION || "v1",
        shortCode: process.env.SFCC_SHORT_CODE,
        organizationId: process.env.SFCC_ORGANIZATION_ID,
        viewType: process.env.SFCC_PRODUCT_IMAGE_VIEW_TYPE,

        ocapiEndpoints: {
          updatePaymentInstrumentInBasket: true, // The SCAPI method is broken
        },

        cookieNames: {
          siteId: process.env.SFCC_COOKIES_SITE_ID || "vsf-sfcc-site-id",
          amAuthToken: process.env.SFCC_COOKIES_AM_TOKEN || "vsf-sfcc-am-token",
          scapiAuthToken:
            process.env.SFCC_COOKIES_SCAPI_TOKEN || "vsf-sfcc-scapi-token",
          scapiRefreshToken:
            process.env.SFCC_COOKIES_SCAPI_REFRESH_TOKEN ||
            "vsf-sfcc-scapi-refresh-token",
          ocapiAuthToken:
            process.env.SFCC_COOKIES_OCAPI_TOKEN || "vsf-sfcc-ocapi-token",
          currency: process.env.SFCC_COOKIES_CURRENCY || "vsf-sfcc-currency",
          locale: process.env.SFCC_COOKIES_LOCALE || "vsf-sfcc-locale",
          usid: process.env.SFCC_COOKIES_USID || "vsf-sfcc-usid",
        },

        clientHeaders: {
          siteId:
            process.env.SFCC_CLIENT_HEADERS_SITE_ID || "x-vsf-sfcc-site-id",
          amAuthToken:
            process.env.SFCC_CLIENT_HEADERS_AM_TOKEN || "x-vsf-sfcc-am-token",
          scapiAuthToken:
            process.env.SFCC_CLIENT_HEADERS_SCAPI_TOKEN ||
            "x-vsf-sfcc-scapi-token",
          scapiRefreshToken:
            process.env.SFCC_CLIENT_HEADERS_SCAPI_REFRESH_TOKEN ||
            "x-vsf-sfcc-scapi-refresh-token",
          ocapiAuthToken:
            process.env.SFCC_CLIENT_HEADERS_OCAPI_TOKEN ||
            "x-vsf-sfcc-ocapi-token",
          currency:
            process.env.SFCC_CLIENT_HEADERS_CURRENCY || "x-vsf-sfcc-currency",
          locale: process.env.SFCC_CLIENT_HEADERS_LOCALE || "x-vsf-sfcc-locale",
          usid: process.env.SFCC_CLIENT_HEADERS_USID || "x-vsf-sfcc-usid",
        },

        callbacks: {
          auth: {
            onPasswordResetTokenGenerated({ token, email, login, phone, siteId, customerId, codeVerifier }) {
              // This is an example implementation for demo purposes.
              // In a real scenario, the token should be sent to the customer here (e.g. an email and phone are available in the payload),
              // and the token MUST NOT be exposed to the client
              return { token, email, login, phone, siteId, customerId, codeVerifier };
            },
          },
        },
      },
    },
  },
};

# .env

SFCC_OCAPI_CLIENT_ID=
SFCC_OCAPI_CLIENT_SECRET=
SFCC_OCAPI_VERSION=
SFCC_ORGANIZATION_ID=
SFCC_ORIGIN=
SFCC_SCAPI_CLIENT_ID=
SFCC_SCAPI_VERSION=
SFCC_SHORT_CODE=
SFCC_SITE_ID=
SFCC_SLAS_CLIENT_ID=
SFCC_SLAS_CLIENT_SECRET=

// middleware.js

const { createServer } = require("@vue-storefront/middleware");
const { integrations } = require("./middleware.config");
const cors = require("cors");

(async () => {
  const app = await createServer({ integrations });
  // By default it's running on the localhost.
  const host = process.argv[2] ?? "0.0.0.0";
  // By default it's running on the port 8181.
  const port = process.argv[3] ?? 8181;
  const CORS_MIDDLEWARE_NAME = "corsMiddleware";

  const corsMiddleware = app._router.stack.find(
    (middleware) => middleware.name === CORS_MIDDLEWARE_NAME
  );

  // You can overwrite the cors settings by defining allowed origins.
  corsMiddleware.handle = cors({
    origin: ["http://localhost:3000"],
    credentials: true,
  });

  app.listen(port, host, () => {
    console.log(`Middleware started: ${host}:${port}`);
  });
})();

yarn add @vue-storefront/sdk

yarn add @vsf-enterprise/sfcc-sdk

import { initSDK, buildModule } from "@vue-storefront/sdk";
import { sfccModule } from "@vsf-enterprise/sfcc-sdk";

const sdkConfig = {
  sfcc: buildModule(sfccModule, {
    apiUrl: "http://localhost:8181/sfcc"
  }),
};

export const sdk = initSDK(sdkConfig);