sfcc-sdk

2.0.0

Major Changes

3af8b92: CHANGED Replaced core dependencies with a new @alokai/connect package. @vue-storefront/middleware, @vue-storefront/sdk, vue-storefront/logger, vue-storefront/unified-data-model were replaced with @alokai/connect. The replacement preserves the same functionality and interface as the original packages. To read more about the @alokai/connect package, please refer to the documentation. You will also find a migration guide in the documentation.
3af8b92: CHANGED Updated the package for compatibility with Node.js 22.

Key Updates:
- Upgraded to the latest version of Node.js 22
- Updated CI pipelines to use Node.js 22 for consistency.
- Updated .nvmrc or .node-version files to specify Node.js version 22.14.
- Upgraded @types/node to version ^22.13.17 for compatibility with the latest Node.js features.
Recommendations:
- Use Node.js version 22.14.0 or higher for optimal performance, security, and compatibility.
- While Node.js 20 is technically supported, it is not recommended as it may cause compatibility issues with certain packages and has not been thoroughly tested.

2.0.0-rc.1

Major Changes

2916718: CHANGED Updated the package for compatibility with Node.js 22.

Key Updates:
- Upgraded to the latest version of Node.js 22
- Updated CI pipelines to use Node.js 22 for consistency.
- Updated .nvmrc or .node-version files to specify Node.js version 22.14.
- Upgraded @types/node to version ^22.13.17 for compatibility with the latest Node.js features.
Recommendations:
- Use Node.js version 22.14.0 or higher for optimal performance, security, and compatibility.
- While Node.js 20 is technically supported, it is not recommended as it may cause compatibility issues with certain packages and has not been thoroughly tested.

2.0.0-rc.0

Major Changes

2277a56: CHANGED Replaced core dependencies with a new @alokai/connect package. @vue-storefront/middleware, @vue-storefront/sdk, vue-storefront/logger, vue-storefront/unified-data-model were replaced with @alokai/connect. The replacement preserves the same functionality and interface as the original packages. To read more about the @alokai/connect package, please refer to the documentation. You will also find a migration guide in the documentation.

1.5.0

Minor Changes

3ab14a3: Integrate with the getUrlMapping SCAPI endpoint

Patch Changes

Updated dependencies [3ab14a3]
Updated dependencies [cf3a63d]
- @vsf-enterprise/sfcc-types@1.5.0

1.4.0

Minor Changes

b04ab3e: Integrates the Omnichannel Inventory endpoints that can be used on the storefront to check a product's availability, reserve stock, update, transfer or release reservations

Patch Changes

Updated dependencies [b04ab3e]
- @vsf-enterprise/sfcc-types@1.4.0

1.3.0

Minor Changes

fecf119: CHANGED Installed Alokai Logger. To learn more about logger, visit Alokai Logger.

1.2.0

Minor Changes

7446123: Exposes SDK methods and API endpoints for the shopper context functionality

Patch Changes

Updated dependencies [7446123]
- @vsf-enterprise/sfcc-types@1.3.0

1.1.0

Minor Changes

6fd908e: - Expose an SDK method and API endpoint ensureAccessTokenValidity. It accepts no parameter and has no response body, its purpose is to be the first called method in the consumer app's lifecycle. If there are no JWTs in the request headers (either in cookies or custom headers), guest JWTs will be generated and returned as cookies; if there are preexisting tokens, they will go through validation and will be refreshed if needed. This will allow any following requests that happen in parallel during the first page request to reuse the same token instead of each one generating its own.
- Enable long-lived logins using refresh tokens. Controlled by the optional opt-out disableLongLivedLogin setting in the middleware configuration. When enabled, guest tokens will always be refreshed when a refresh token is available. This mirrors the default functionality of the official SLAS plugin for SFCC.
- Removes the USID parameter from refresh token calls, per instructions from the SFCC SLAS team
- Completely disables OCAPI authentication when the SLAS token will be used for OCAPI calls. Until now we were generating both tokens even if only one of them would be used.

Patch Changes

Updated dependencies [6fd908e]
- @vsf-enterprise/sfcc-types@1.1.0

1.0.0

Major Changes

e747f29: Stable release of SalesForce integration

Minor Changes

f621a97: Add an option to always get a basket by ID rather than using the customer baskets endpoint
d75751b: Adds a sign out SDK method to invalidate authenticated JWTs
411b1d5: Adds support for placing orders in the updateOrder method
b2c76da: Add a method to update an order

Patch Changes

1be2f39: - CHANGED Deprecated the SfccModuleType interface. It is no longer necessary to use this type. It's going to be removed in the next major version after Oct 1, 2024.

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

const sdkConfig = {
-  sfcc: buildModule<SFCCModuleType>(sfccModule, {
+  sfcc: buildModule(sfccModule, {
    apiUrl: "http://localhost:8181/sfcc",
  }),
};

export const sdk = initSDK(sdkConfig);

CHANGED sfccModule has been deprecated. Use middlewareModule from @vue-storefront/sdk package instead.

- import { initSDK, buildModule } from '@vue-storefront/sdk';
- import { sfccModule, SFCCModuleType } from '@vsf-enterprise/sfcc-sdk'
+ import { initSDK, buildModule, middlewareModule } from '@vue-storefront/sdk';
+ import { Endpoints as SfccEndpoints } from '@vsf-enterprise/sfcc-api'; // In Alokai Storefront you should import it from `storefront-middleware/types.ts`

const sdkConfig = {
  sfcc:
    buildModule(
-      sfccModule,
+      middlewareModule<SfccEndpoints>,
      { apiUrl: 'http://localhost:8181/sfcc' }
    )
};

7cb9f9f: Refactor API endpoints to follow the standartized universal module exports interface
Updated dependencies [9ca0a56]
Updated dependencies [e747f29]
Updated dependencies [f621a97]
Updated dependencies [d75751b]
Updated dependencies [0bdc007]
Updated dependencies [e823b4e]
Updated dependencies [411b1d5]
Updated dependencies [b2c76da]
- @vsf-enterprise/sfcc-types@1.0.0

1.0.0-rc.5

Minor Changes

411b1d5: Adds support for placing orders in the updateOrder method

Patch Changes

Updated dependencies [411b1d5]
- @vsf-enterprise/sfcc-types@1.0.0-rc.6

1.0.0-rc.4

Minor Changes

f621a97: Add an option to always get a basket by ID rather than using the customer baskets endpoint

Patch Changes

Updated dependencies [f621a97]
- @vsf-enterprise/sfcc-types@1.0.0-rc.5

1.0.0-rc.3

Patch Changes

1be2f39: - CHANGED Deprecated the SfccModuleType interface. It is no longer necessary to use this type. It's going to be removed in the next major version after Oct 1, 2024.

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

const sdkConfig = {
-  sfcc: buildModule<SFCCModuleType>(sfccModule, {
+  sfcc: buildModule(sfccModule, {
    apiUrl: "http://localhost:8181/sfcc",
  }),
};

export const sdk = initSDK(sdkConfig);

CHANGED sfccModule has been deprecated. Use middlewareModule from @vue-storefront/sdk package instead.

- import { initSDK, buildModule } from '@vue-storefront/sdk';
- import { sfccModule, SFCCModuleType } from '@vsf-enterprise/sfcc-sdk'
+ import { initSDK, buildModule, middlewareModule } from '@vue-storefront/sdk';
+ import { Endpoints as SfccEndpoints } from '@vsf-enterprise/sfcc-api'; // In Alokai Storefront you should import it from `storefront-middleware/types.ts`

const sdkConfig = {
  sfcc:
    buildModule(
-      sfccModule,
+      middlewareModule<SfccEndpoints>,
      { apiUrl: 'http://localhost:8181/sfcc' }
    )
};

On this page