Sync from monorepo

Template version: 0.4.0-alpha.2

Uses NPM packages @salesforce/storefront-next-* v0.4.0-alpha.2

Synced by: vmarta_sfemu

Monorepo SHA: d8913956ac58de3b49f0473f09e813f2e8af7b25

Latest change: f8c681cc3 - chore: bump version to 0.4.0-alpha.2

Author: vmarta_sfemu

CHANGELOG.md

@@ -13,6 +13,7 @@
 - Remove manual `contentLinkUuid` type extensions in favor of SCAPI types (@W-21280780)
     - `ComponentType` now uses `contentLinkUuid`, `fragment`, `localized`, `visible` from Shopper Experience API v1.3.0
 - Document the use of dynamic images ([#1519](https://github.com/commerce-emu/storefront-next/pull/1519))
+- Update Page Designer middleware and `vite.config.ts` to align with upstream `@salesforce/mrt-utilities` conditional export flow (no local Vite alias requirement) ([#1533](https://github.com/commerce-emu/storefront-next/pull/1533))
 - Standardize behaviors of API errors in Checkout (@W-22199926) ([#1521](https://github.com/commerce-emu/storefront-next/pull/1521))
 - Migrate i18n infrastructure to SDK: replace `src/lib/i18next.ts`, `src/lib/i18next.client.ts`, and `scripts/aggregate-extension-locales.js` with imports from `@salesforce/storefront-next-runtime/i18n` and `sfnext locales aggregate-extensions`
 

e2e/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/storefront-next-e2e",
-    "version": "0.4.0-alpha.1",
+    "version": "0.4.0-alpha.2",
     "private": true,
     "scripts": {
         "typecheck": "pnpm def && tsc --noEmit",

lighthouserc.cjs

@@ -17,7 +17,7 @@ module.exports = {
     ci: {
         collect: {
             numberOfRuns: 5,
-            startServerCommand: 'pnpm start --port 3001',
+            startServerCommand: 'cross-env NODE_OPTIONS=--conditions=dev-data-store pnpm start --port 3001',
             startServerReadyPattern: 'SFCC Storefront Next',
             startServerReadyTimeout: 30000,
             url: [

package.json

@@ -1,16 +1,16 @@
 {
     "name": "template-retail-rsc-app",
-    "version": "0.4.0-alpha.1",
+    "version": "0.4.0-alpha.2",
     "description": "Production-ready React storefront template for Salesforce Commerce Cloud.",
     "private": true,
     "type": "module",
     "scripts": {
         "build": "pnpm locales:aggregate-extensions && pnpm generate:cartridge && react-router build",
         "bundlesize:test": "cross-env BUNDLES_SIZE_CHECK=true pnpm build",
         "bundlesize:analyze": "cross-env BUNDLES_SIZE_ANALYZE=true pnpm build",
-        "dev": "pnpm locales:aggregate-extensions && sfnext dev",
-        "dev:debug": "cross-env NODE_OPTIONS=--inspect sfnext dev",
-        "dev:log": "cross-env SFCC_LOG_LEVEL=debug sfnext dev",
+        "dev": "pnpm locales:aggregate-extensions && cross-env NODE_OPTIONS=--conditions=dev-data-store sfnext dev",
+        "dev:debug": "cross-env NODE_OPTIONS=\"--inspect --conditions=dev-data-store\" sfnext dev",
+        "dev:log": "cross-env NODE_OPTIONS=--conditions=dev-data-store SFCC_LOG_LEVEL=debug sfnext dev",
         "dev:ui-targets": "cross-env VITE_UI_TARGET_DEV_MODE=true pnpm dev",
         "smoke-test:generate": "node src/lib/ui-target-dev-mode/smoke-test/generate-config.cjs",
         "deploy:cartridge": "sfnext deploy-cartridge",
@@ -19,7 +19,7 @@
         "validate:cartridge": "sfnext validate-cartridge",
         "generate:eslint": "node scripts/generate-eslint-config.js",
         "locales:aggregate-extensions": "sfnext locales aggregate-extensions",
-        "start": "cross-env SFNEXT_DATA_STORE_ALLOW_LOCAL=true sfnext preview",
+        "start": "cross-env SFNEXT_DATA_STORE_UNAVAILABLE_MODE=fallback sfnext preview",
         "preview": "pnpm start",
         "push": "sfnext push --project-directory .",
         "typecheck": "react-router typegen && cross-env NODE_OPTIONS=--max-old-space-size=8192 tsc --noEmit",
@@ -82,8 +82,8 @@
         "@radix-ui/react-switch": "1.2.2",
         "@radix-ui/react-tooltip": "1.2.8",
         "@react-router/node": "7.12.0",
-        "@salesforce/storefront-next-dev": "0.4.0-alpha.1",
-        "@salesforce/storefront-next-runtime": "0.4.0-alpha.1",
+        "@salesforce/storefront-next-dev": "0.4.0-alpha.2",
+        "@salesforce/storefront-next-runtime": "0.4.0-alpha.2",
         "@vis.gl/react-google-maps": "1.7.1",
         "class-variance-authority": "0.7.1",
         "clsx": "2.1.1",

pnpm-workspace.yaml.hbs

@@ -20,8 +20,8 @@ minimumReleaseAge: 2880
 # Storefront Next SDK packages are exempt.
 # (https://pnpm.io/settings#minimumreleaseageexclude)
 minimumReleaseAgeExclude:
-  - '@salesforce/storefront-next-dev@0.4.0-alpha.1'
-  - '@salesforce/storefront-next-runtime@0.4.0-alpha.1'
+  - '@salesforce/storefront-next-dev@0.4.0-alpha.2'
+  - '@salesforce/storefront-next-runtime@0.4.0-alpha.2'
   - '@salesforce/mrt-utilities'
 
 # Prevent lockfile version downgrades.

src/middlewares/page-designer-page-resolution.server.test.ts

@@ -20,15 +20,14 @@ import { createTestContext } from '@/lib/test-utils';
 import { scapiMiddlewareContext, type ScapiMiddlewareEntry } from '@/lib/scapi-middleware';
 import { resolvePage } from '@salesforce/storefront-next-runtime/design/data';
 import {
+    DataStore,
     DataStoreNotFoundError,
     DataStoreUnavailableError,
     DataStoreServiceError,
 } from '@salesforce/storefront-next-runtime/data-store';
 
 const mockGetEntry = vi.fn();
 const mockResolveQualifiers = vi.fn();
-const mockDataStoreProvider = { kind: 'mrt' as const, getEntry: mockGetEntry };
-const mockGetDefaultDataStoreProvider = vi.fn().mockResolvedValue(mockDataStoreProvider);
 
 const mockLogger = vi.hoisted(() => ({
     error: vi.fn(),
@@ -47,10 +46,15 @@ const mockClients = {
     },
 } as any;
 
-vi.mock('@salesforce/storefront-next-runtime/data-store', async (importOriginal) => ({
-    ...(await importOriginal()),
-    getDefaultDataStoreProvider: (...args: unknown[]) => mockGetDefaultDataStoreProvider(...args),
-}));
+vi.mock('@salesforce/storefront-next-runtime/data-store', async (importOriginal) => {
+    const original = await importOriginal<typeof import('@salesforce/storefront-next-runtime/data-store')>();
+    return {
+        ...original,
+        DataStore: {
+            getDataStore: vi.fn(() => ({ getEntry: mockGetEntry })),
+        },
+    };
+});
 
 vi.mock('@salesforce/storefront-next-runtime/design/data', () => ({
     resolvePage: vi.fn(),
@@ -145,7 +149,8 @@ describe('pageDesignerResolutionMiddleware', () => {
         mockGetEntry.mockReset();
         mockResolveQualifiers.mockReset();
         mockedResolvePage.mockReset();
-        mockGetDefaultDataStoreProvider.mockReset().mockResolvedValue(mockDataStoreProvider);
+        DataStore._testDocumentClient = null;
+        DataStore._testLogMRTError = null;
     });
 
     describe('factory registration', () => {
@@ -179,16 +184,6 @@ describe('pageDesignerResolutionMiddleware', () => {
             expect(next).toHaveBeenCalled();
         });
 
-        it('should return undefined from onRequest when data store provider is not available', async () => {
-            mockGetDefaultDataStoreProvider.mockResolvedValue(null);
-            const handler = await setupHandler();
-
-            const result = await handler(middlewareParams(new Request(getPageUrl('homepage'))));
-
-            expect(result).toBeUndefined();
-            expect(mockedResolvePage).not.toHaveBeenCalled();
-        });
-
         it('should return an onRequest handler from factory when feature flag is enabled', async () => {
             const context = createTestContext({
                 appConfig: { features: { mrtBasedPageDesignerResolution: true } } as any,

src/middlewares/page-designer-page-resolution.server.ts

@@ -23,17 +23,16 @@ import {
     type SiteManifest,
 } from '@salesforce/storefront-next-runtime/design/data';
 import {
-    getDefaultDataStoreProvider,
-    type DataStoreProvider,
+    DataStore,
     DataStoreNotFoundError,
     DataStoreUnavailableError,
     DataStoreServiceError,
 } from '@salesforce/storefront-next-runtime/data-store';
 import type { ShopperExperience, Middleware, Clients } from '@salesforce/storefront-next-runtime/scapi';
 import { getConfig } from '@salesforce/storefront-next-runtime/config';
 import { siteContext } from '@salesforce/storefront-next-runtime/site-context';
-import type { AppConfig } from '@/types/config';
 import { getTranslation } from '@salesforce/storefront-next-runtime/i18n';
+import type { AppConfig } from '@/types/config';
 import { scapiMiddlewareContext } from '@/lib/scapi-middleware';
 import { getLogger } from '@/lib/logger.server';
 import type { Logger } from '@/lib/logger';
@@ -56,6 +55,7 @@ type ManifestWrapperKey<TType extends ManifestType> = TType extends 'page' ? 'co
 type ManifestValue<TType extends ManifestType> = {
     [K in ManifestWrapperKey<TType>]: string;
 };
+type DataStoreClient = Pick<DataStore, 'getEntry'>;
 
 /**
  * Thrown when a Data Store entry cannot be decoded (base64), decompressed
@@ -127,16 +127,11 @@ function createPageResolutionMiddleware(
     const locale = i18next.language ?? config.i18n.fallbackLng;
     const logger = getLogger(context);
     const onError = getErrorHandler(logger);
-    const dataStorePromise = getDefaultDataStoreProvider();
+    const dataStore = DataStore.getDataStore();
 
     return {
         async onRequest({ request }) {
             const metrics: Metrics = {};
-            const dataStore = await dataStorePromise;
-
-            if (!dataStore) {
-                return;
-            }
 
             const response = await resolveGetPageRequest({
                 metrics,
@@ -280,7 +275,7 @@ async function resolveGetPageRequest({
 }: {
     request: Request;
     context: RouterContextProvider | Readonly<RouterContextProvider>;
-    dataStore: DataStoreProvider;
+    dataStore: DataStoreClient;
     siteId: string;
     locale: string;
     metrics: Metrics;
@@ -367,7 +362,7 @@ function getPageResolutionParams({
     onError,
     clients,
 }: {
-    dataStore: DataStoreProvider;
+    dataStore: DataStoreClient;
     siteId: string;
     locale: string;
     pageId: string;
@@ -456,7 +451,7 @@ function getPageManifestStorage({
     onError,
     metrics,
 }: {
-    dataStore: DataStoreProvider;
+    dataStore: DataStoreClient;
     siteId: string;
     onError: (error: unknown) => void;
     metrics: Metrics;
@@ -489,14 +484,14 @@ function getPageManifestStorage({
  * @throws {DataStoreEntryUnpackError} If decoding, decompression, or parsing fails.
  */
 async function getAndUnpackDataStoreEntry(
-    dataStore: DataStoreProvider,
+    dataStore: DataStoreClient,
     key: string,
     manifestType: ManifestType,
     metrics: Metrics
 ): Promise<PageManifest | SiteManifest> {
     metrics[`${manifestType}ManifestRetrievalStart`] = performance.now();
 
-    const entry = await dataStore.getEntry<ManifestValue<typeof manifestType>>(key);
+    const entry = (await dataStore.getEntry(key)) as { value?: ManifestValue<typeof manifestType> } | undefined;
 
     metrics[`${manifestType}ManifestRetrievalEnd`] = performance.now();
 
@@ -509,7 +504,7 @@ async function getAndUnpackDataStoreEntry(
 
         metrics[`${manifestType}ManifestUnpackStart`] = performance.now();
 
-        if (!entry.value?.compressedData && !entry.value?.data) {
+        if (!entry.value) {
             // This will get caught so the error message doesn't
             // really matter here.
             throw new Error('Data store entry is blank');

vite.config.ts

@@ -15,7 +15,7 @@
  */
 import { dirname, resolve } from 'node:path';
 import { fileURLToPath } from 'node:url';
-import { existsSync, readFileSync } from 'node:fs';
+import { readFileSync } from 'node:fs';
 import { defineConfig, perEnvironmentPlugin, loadEnv } from 'vite';
 import tailwindcss from '@tailwindcss/vite';
 import tsconfigPaths from 'vite-tsconfig-paths';
@@ -70,20 +70,6 @@ export default defineConfig(({ mode }) => {
                 'See .env.default for a complete example.'
         );
     }
-
-    const localProviderPath = resolve(__dirname, '../storefront-next-dev/dist/data-store/local-provider.js');
-    const mrtUtilitiesPath = resolve(
-        __dirname,
-        '../storefront-next-runtime/node_modules/@salesforce/mrt-utilities/dist/esm/middleware/index.js'
-    );
-    const localDevAliases: Record<string, string> = {};
-    if (existsSync(localProviderPath)) {
-        localDevAliases['@salesforce/storefront-next-dev/data-store/local-provider'] = localProviderPath;
-    }
-    if (existsSync(mrtUtilitiesPath)) {
-        localDevAliases['@salesforce/mrt-utilities/middleware'] = mrtUtilitiesPath;
-    }
-
     return {
         build: {
             sourcemap: true,
@@ -180,20 +166,11 @@ export default defineConfig(({ mode }) => {
                 // Server-only config access (must be before '@' to take precedence)
                 '@/config/server': resolve(__dirname, './config.server.ts'),
                 '@': resolve(__dirname, './src'),
-                // Fonts alias for easy customization
-                ...localDevAliases,
                 // Fonts alias — uses root-absolute path (not a filesystem resolve) because fonts
                 // live in public/. Vite serves public assets at the root, so '/fonts' maps to
                 // public/fonts/. Using resolve(__dirname, './public/fonts') would trigger Vite
                 // warnings about importing from the public directory.
                 '@fonts': '/fonts',
-                // The mrt-utilities package's "development" export condition points to
-                // ./src/index.ts which doesn't exist in the published package. Alias to
-                // the ESM dist to fix module resolution in tests and dev.
-                '@salesforce/mrt-utilities': resolve(
-                    __dirname,
-                    '../storefront-next-runtime/node_modules/@salesforce/mrt-utilities/dist/esm/index.js'
-                ),
             },
             // Prevent duplicate React instances in the monorepo. hooks break if multiple copies are loaded
             dedupe: ['react', 'react-dom', 'react-router'],