1.4

A middleware extension could override a built-in API method with arguments or a return type that didn't match the original, and it still compiled.

ApiClientExtension is now a type, not an interface, and its API parameter must extend ApiMethods instead of accepting any. A non-namespaced extension typed ApiClientExtension<Endpoints> must declare each built-in method it overrides with the integration's own signature.

To reach the current integration's client, you used context.api, which gave you no types, or called getApiClient() with the integration's name and typed the result by hand.

context.getApiClient() with no arguments returns the current integration's client, typed from that integration's API, CONFIG, and CLIENT types. To call another integration, you still pass its name first, and extension methods still need generics. Nested getApiClient() calls, which used to error, now work. context.api is deprecated and will be removed in the next major version.

The CMS and SmartEdit API clients call getApiClient() internally instead of the deprecated context.api. So do the unified API layers for BigCommerce, commercetools, Magento, SAP Commerce Cloud, and Salesforce Commerce Cloud.

The ContextualizedEndpoints type is deprecated in favour of Endpoints.

A custom method that reads from several integrations had to annotate every getApiClient() call site by hand to get types.

getTypedApiClient in apps/storefront-middleware/integrations/typedApiClient.ts gives getApiClient() full autocomplete and typechecking. You declare each integration's context and its namespaced extensions once, in a local IntegrationContextMap.

Every store template ships the file pre-configured with its own integrations and extensions. The CMS and search modules register themselves in it during add-module, from @vsf-enterprise/module-kit 4.1.0.

The middleware handles a streamed response from a third-party service, so it can process a large payload as it arrives instead of buffering it whole.

You set the body-parser limit per route with a function that receives the route's integration and function name: createServer(config, { bodyParser: ({ functionName, integrationName }) => ({ limit: '4000kb' }) }).

middlewareModule in @alokai/connect/sdk can compress POST bodies. Compression is opt-in per call, with prepareConfig({ compression: { algorithm: 'gzip' } }).

You can declare a global errorHandler once in middleware.config.ts, and it applies to every integration. A per-integration errorHandler still overrides it. The order is the integration's own handler, then the global one, then the built-in default.

Body-parser errors, such as invalid JSON in a request body, go to your custom error handlers instead of bypassing them.

Request latency and error-rate metrics are available for the middleware and for each integration, with no per-method setup. They come with @alokai/connect and @alokai/instrumentation 1.1.0.

A Nuxt production build with SDK payload compression failed to resolve pako, while dev worked.

@alokai/connect imports pako through its default export. pako ships CommonJS, and the named imports it used before don't survive Nuxt's production bundling.

A top-of-file import 'dotenv/config' loads a .env in every environment, production included, so a committed .env can reach a deployment.

A newly generated project loads environment variables through apps/storefront-middleware/src/config/env.ts. It imports dotenv only when NODE_ENV is development or test, and returns {} otherwise. src/index.ts calls await loadEnv() and then dynamically imports ../middleware.config.js, in place of the top-of-file import 'dotenv/config'.

Two settings get NODE_ENV to the loader under start:standalone, because turbo would otherwise strip it. turbo.json has "passThroughEnv": ["NODE_ENV"] on the start:standalone task. The middleware's own start:standalone script sets NODE_ENV=development.

store dev cleared the terminal on every recompilation, so earlier logs were lost.

A project generated at 1.4.0 sets the middleware dev script to tspc && concurrently --raw "tspc --preserveWatchOutput --watch" "NODE_ENV=development tsx watch --clear-screen=false src/index.ts". The two flags keep the log history. The leading tspc transpiles the app before the watchers start.

In the Next.js app, components/cms/page/banner.tsx renders an image-overlay CMS banner with fill and sizes="100vw". Before, it used a fixed height={300} width={300}. The other layout types keep the fixed dimensions.

A generated apps/storefront-middleware/middleware.config.ts ends with } satisfies MiddlewareConfig, using the type imported from @alokai/connect/middleware. The middleware's build script runs tspc under NODE_OPTIONS="--max-old-space-size=8192".

version check and version upgrade abort when the installed @alokai/connect doesn't exactly match the version the compatibility matrix names. @alokai/connect 1.2.1 is published, so a caret range re-resolves past the version the matrix names.

In a project generated at this release, apps/storefront-middleware/package.json and apps/playwright/package.json declare "@alokai/connect": "1.2.0" instead of "^1.2.0". The Next.js and Nuxt manifests still carry "^1.2.0", even in a new project.

In apps/storefront-unified-nuxt/components/ui/Header.vue, the NuxtLazyHydrate/UiOverlay block that holds the search SfModal moves inside UiNavbarTop. The template now has a single root element instead of two.

The UiButton trigger in apps/storefront-unified-nuxt/components/ui/NavbarTop/AuthDropdown.vue drops its SfIconPerson icon and its square and variant="tertiary" props. An explicit class list styles it instead.

apps/storefront-unified-nuxt/components/ui/UserSettingsButton.vue wraps its {{ locale }} / {{ getCurrencyLabel(currency) }} content in an explicit <template #default>. Before, it passed that content as implicit slot content.

Your Nuxt dev server printed duplicate-import warnings. Nuxt already auto-imports everything under composables/**, so a barrel that re-exports the same symbol registers it a second time.

47 barrel index.ts files are deleted from apps/storefront-unified-nuxt/composables/** and from the Nuxt source of the CMS, Coveo, quick-order, re-order, register-b2b and SAP ASM modules. apps/storefront-unified-nuxt/nuxt.config.ts adds sf-modules/**/composables/** and sf-modules/**/utils/** to its imports.dirs.

The Notification type in composables/useNotification/types.ts is renamed to UiNotification. components/Notifications/types.ts and NotificationFactory.vue take it from the auto-import instead of an import type.

Nuxt module source from this release onward expects Nuxt to supply its composables through sf-modules/**/composables/** in imports.dirs. The CLI writes that entry only when it creates a project or a store, and no module's install.js adds it.

The Nuxt source of the storefront modules drops its explicit composable imports. The SAP ASM module's Nuxt entry point no longer has export * from './composables', so @sf-modules/sap-asm no longer re-exports useAsmAgent, useAsmUi, useSessionTimer, useCustomer360, useBindCart, useCustomerSuggestions or useEmulation. Its own components stop importing them.

Quick Order's accordions, Re-order's confirmation modal, B2B registration's useRegisterCustomer, Coveo's ten composables and the seven CMS modules' [...slug].vue pages lose their explicit imports the same way.

The boilerplate pointed a generated integration at its TypeScript source. That path resolves in development mode, but in production mode the middleware fails to load the integration.

Every boilerplate template variant - graphql, openapi, rest-api, sdk-proxy - now emits location: './lib/integrations/<name>/index.server.js', the transpiled output, instead of a path to the TypeScript source.

@alokai/cli 2.3.0 depends on @oclif/plugin-plugins. It adds the plugins command family - plugins install, plugins uninstall, plugins update, and the rest.

integration generate and extension generate abort with Command aborted due to Alokai version mismatch. when the project's version can't be matched against the Console compatibility matrix.

A version mismatch in version check prints a warning and lets the command finish. Before, the command failed. The CLI also handles errors more gracefully when it fetches the compatibility matrix from the Console API.

The kebab-case check on integration names accepts lowercase letters and digits. Before, a digit anywhere in the name failed the check.

./node_modules/.bin/alokai-cli version upgrade no longer fails with There are more than one workspace with name "playwright". The duplicate workspace came from the .out directory, and the upgrade now cleans it.

@vsf-enterprise/storefront-cli 3.1.2 copies the AI agent context files into a new project as they are, instead of generating them at creation time. A project generated at 1.4.0 gets three editor rules files it didn't get before: .cursorrules, .windsurfrules, and .github/copilot-instructions.md.

It also gets an ai/ directory of nine topic guides: project-context.md, code-style.md, development-guide.md, frontend-guide.md, middleware-guide.md, multistore-guide.md, testing-guide.md, git-conventions.md, and README.md. This set replaces the old ai/README.md, ai/general-rules.md, ai/frontend/{nextjs,nuxt}/index.md, and ai/integrations/<platform>/index.md layout. It doesn't extend it.

@vsf-enterprise/module-kit 4.1.0 adds createAddExtensionToTypedApiClientVisitor and createAddIntegrationToTypedApiClientVisitor. With them, a module's install.js can register the module in a project's typedApiClient.ts.

The composed script was cross-env API_PORT=<port> <your dev script>, so a dev script beginning tspc && split at the &&. The tsx watch process that serves the middleware never saw API_PORT.

@alokai/cli 2.3.1 wraps your middleware dev script in sh -c "..." when it composes .out/<store>/storefront-middleware/package.json. It also moves NODE_ENV=development up beside API_PORT, so cross-env sets both for the whole command. The wrapper doesn't escape the double quotes your dev script already contains.

On 1.4.1, the composed dev script was cut off at the first double quote in your own script, so store dev exited 0 with no middleware listening.

@alokai/cli 2.3.2 no longer inlines your dev script into sh -c "<your dev script>". It writes your original command to a new dev:original script and composes dev as cross-env API_PORT=<port> NODE_ENV=development yarn dev:original. The Next.js and Nuxt apps get the same shape.

The environment loader 1.4.0 introduced reads .env only when NODE_ENV is development or test. This release drops that variable from the composed start script, so a middleware on that loader comes up with no environment at all.

The composed middleware start:standalone is now cross-env API_PORT=<port> yarn start, without NODE_ENV=development. It carried the variable at 1.4.0 and 1.4.1.

On 1.4.2, the composed middleware start:standalone lacked NODE_ENV=development, so every project on 1.4.0's loader started with an empty environment.

The composed middleware start:standalone is cross-env API_PORT=<port> NODE_ENV=development yarn start again.

The built Nitro server never read .env on its own. Anything that started the built server ran without the values you declared only in that file.

The composed Nuxt start:standalone is now cross-env <urls and port> node -r dotenv/config .deploy/server/index.mjs. The Nuxt server factory the Playwright harness uses, apps/playwright/setup/framework/nuxt/server.ts, gets the same -r dotenv/config. The composed dev script doesn't change in this release.

A project generated at 1.4.4 installed three copies of TypeScript side by side - 5.4.5, 5.6.2 and 5.9.3.

@alokai/cli, @alokai/cli-plugin-compass and @vsf-enterprise/storefront-cli depend on typescript ^5.4.5 instead of the exact 5.4.5. The generated project adds a "typescript" entry to the resolutions block of its root package.json, and its app manifests move to 5.9.3. A project generated at 1.4.5 resolves exactly one TypeScript, 5.9.3.

When create strips the frontend framework you didn't pick, it now also removes that framework's resolutions entry from the root package.json. Before, it logged the removal but never saved the file.

Compass had no published packages, so you couldn't install it into your project as a module.

@alokai/compass 1.0.0 and @alokai/cli-plugin-compass 1.0.0 are the first published releases of both packages, and the compass module is installable from this release. You install the plugin through the CLI's plugin mechanism, not as a dependency in a manifest. The new @oclif/plugin-plugins dependency in @alokai/cli 2.3.0 adds that mechanism.

@vsf-enterprise/redis-sdk 2.1.0 adds createClient, which connects to a Redis server from inside the storefront-middleware app. An option replaces the real server with a mock.

When any requested ID or SKU is missing, getProducts returns every product it fetched successfully. Before, it returned an empty array. It logs each failed lookup as a warning.

@vsf-enterprise/sapcc-api 10.1.0 exports the ApiMethods type.

To add a range facet, declare type: 'range' with a ranges array on an entry in configuration.faceting.availableFacets in your middleware config. Then filter with searchProducts({ facets: { price: ['5000-10000', '15000-*'] } }).

Values come back in "from-to" form with "from - to" labels, and an open-ended range as "from - ". The RangeFacetResult type added to FacetResultValue ships in @vsf-enterprise/commercetools-types 3.0.1.

config.customOptions is now typed Partial<ApolloClientOptions<any>> instead of ApolloClientOptions<any>.

@vsf-enterprise/unified-api-magento now exports the ProductWithTypeName, ProductTypeName, CartItemWithTypeName and CartItemTypeName types from its entry point.

The Contentstack SDK didn't support Contentstack Visual Builder, and it used v2 of @contentstack/live-preview-utils.

@vsf-enterprise/contentstack-sdk 6.0.0 supports Contentstack Visual Builder. The new mode: 'builder' and editButton: { enable: true } options drive the "Start editing" button. You can set stackSdk, stackDetails, and clientUrlParams once in contentstackModule({ ... }), and a value you pass to an initLivePreview call overrides them.

The same release moves @contentstack/live-preview-utils from v2 to v4. initLivePreview now does nothing until you pass enable: true. Before, it detected the live-preview iframe and initialized itself.

extractComponents was deprecated. It turned raw Contentstack entries into { componentName, props } pairs, and the unified page that sdk.contentstack.unified.getPage(...) returns already carries that shape.

@vsf-enterprise/contentstack-sdk 6.0.0 no longer exposes extractComponents. The module's utils object now carries only getImageObject and initLivePreview. The util's own deprecation comment said it would be removed in August 2028.

@vsf-enterprise/contentstack-api 6.0.3 keeps Contentstack's $ live-edit-tags field on normalized entries and their children. Before, normalization stripped it. getContent and unified.getPage attach these fields whenever livePreview.enable is true in your config, not only when the request carries a live-preview query.

The normalizer also checks that styles is an array before it maps it.

@vsf-enterprise/smartedit-api 5.1.0 exports the ApiMethods type. It also restores the legacy getComponentById and getPageById endpoints, which had gone missing.

getPage fetches nested components in batches of 20 instead of asking for all of them in one request.

For an object reference with a dotted path, the resolver replaced the whole array item instead of the property that path points at.

For a { type: "object" } entry that getReferenceFieldsForComponent returns, path says where to replace, and idField says where to read the component ID. idField supports dot notation. So { path: "items.properties", idField: "componentId" } used to replace items[i], and now replaces items[i].properties.

SmartEdit-authored links that carry a native SAP Commerce Cloud category URL, such as /Open-Catalogue/Hand-Tools/Angle-Grinders/c/1595, rendered as dead links. An empty CMS slot threw Cannot use 'in' operator to search for 'slotId' in undefined and took the page down.

resolveHref in sf-modules/cms-smartedit/components/native/shared/link-wrapper.tsx is now exported. It rewrites a url that contains /c/ into /category/<id>. SeLink in sf-modules/cms-smartedit/components/native/se-link.tsx calls it, instead of rewriting only when SmartEdit supplies a separate categoryCode.

RenderCmsContent in sf-modules/cms-smartedit/components/render-cms-content.tsx returns null for an empty item instead of throwing.

@vsf-enterprise/algolia-api 6.0.1 exports the Endpoints type.

On a GitHub-hosted runner, the deploy job ran out of disk and V8 heap, and failed with ENOSPC or JavaScript heap out of memory.

The project template gains a .github/actions/free-up-space/action.yml action that deletes the runner's preinstalled Android SDK before the build. The deploy job in .github/workflows/continuous-delivery.yml calls it and sets NODE_OPTIONS: "--max-old-space-size=4096" on the 🚀 Deploy store step.