@salesforce/storefront-next-dev 0.3.1 → 0.4.0-alpha.0

package/dist/commands/config/inspect.js

@@ -0,0 +1,191 @@
+import { r as commonFlags } from "../../flags.js";
+import { ux } from "@oclif/core";
+import fs from "fs-extra";
+import chalk from "chalk";
+import { parseEnv } from "node:util";
+import { join, resolve } from "node:path";
+import { pathToFileURL } from "node:url";
+import { MrtCommand } from "@salesforce/b2c-tooling-sdk/cli";
+import { listEnvVars } from "@salesforce/b2c-tooling-sdk/operations/mrt";
+
+//#region src/utils/objects.ts
+/**
+* Recursively flattens a nested object into dot-notation key-value pairs.
+* Arrays and primitives are treated as leaf values (not further traversed).
+*
+* @param obj - The object to flatten
+* @param prefix - Dot-notation prefix for nested keys
+*/
+function flattenObject(obj, prefix = "") {
+	const entries = [];
+	for (const [k, v] of Object.entries(obj)) {
+		const key = prefix ? `${prefix}.${k}` : k;
+		if (v !== null && typeof v === "object" && !Array.isArray(v)) entries.push(...flattenObject(v, key));
+		else entries.push({
+			key,
+			value: v
+		});
+	}
+	return entries;
+}
+
+//#endregion
+//#region src/commands/config/inspect-utils.ts
+/**
+* Converts a PUBLIC__-prefixed env key to dot-notation config path.
+* Example: PUBLIC__app__commerce__api__clientId → app.commerce.api.clientId
+*/
+function envKeyToConfigPath(envKey) {
+	return envKey.replace(/^PUBLIC__/, "").replace(/__/g, ".");
+}
+/**
+* Converts a dot-notation config path to a PUBLIC__-prefixed env key.
+* Example: app.commerce.api.clientId → PUBLIC__app__commerce__api__clientId
+*/
+function configPathToEnvKey(configPath) {
+	return `PUBLIC__${configPath.replace(/\./g, "__")}`;
+}
+/**
+* Determines the source of each flattened config path.
+* Returns ".env" when there is a corresponding PUBLIC__-prefixed key in envKeys;
+* returns "config" otherwise.
+*
+* @param flattenedKeys - Array of dot-notation config paths
+* @param envKeys - Set of PUBLIC__-prefixed keys found in .env
+*/
+function getValueSources(flattenedKeys, envKeys) {
+	const sources = /* @__PURE__ */ new Map();
+	for (const configPath of flattenedKeys) sources.set(configPath, envKeys.has(configPathToEnvKey(configPath)) ? ".env" : "config");
+	return sources;
+}
+/**
+* Formats the full inspection output as a string.
+*/
+function formatInspectOutput({ flatConfig, sources, localVars, mrtVars }) {
+	const lines = [];
+	const maxKeyLen = (keys) => keys.reduce((max, k) => Math.max(max, k.length), 0);
+	const envOverrides = flatConfig.filter((e) => sources.get(e.key) === ".env").sort((a, b) => a.key.localeCompare(b.key));
+	const totalCount = flatConfig.length;
+	if (totalCount > 0) lines.push(`  Config:  config.server.ts (${totalCount} values, ${envOverrides.length} overridden by .env)`);
+	else lines.push(chalk.dim("  (no config loaded)"));
+	lines.push("");
+	lines.push(chalk.bold("=== .env Overrides ==="));
+	lines.push(chalk.dim("  Config paths overridden by PUBLIC__ env vars in .env."));
+	lines.push("");
+	if (envOverrides.length === 0) lines.push(chalk.dim("  (no .env overrides)"));
+	else {
+		const padLen = maxKeyLen(envOverrides.map((e) => e.key));
+		for (const { key, value } of envOverrides) {
+			const tag = mrtVars !== null && !mrtVars.has(configPathToEnvKey(key)) ? `  ${chalk.yellow("[local only]")}` : "";
+			lines.push(`  ${key.padEnd(padLen)} = ${JSON.stringify(value)}${tag}`);
+		}
+	}
+	lines.push("");
+	if (mrtVars !== null) {
+		lines.push(chalk.bold("=== MRT Overrides ==="));
+		lines.push(chalk.dim("  Config paths overridden by PUBLIC__ env vars in MRT. Values are masked by MRT."));
+		lines.push("");
+		const mrtPublicEntries = [...mrtVars.entries()].filter(([key]) => key.startsWith("PUBLIC__")).map(([key, value]) => [
+			key,
+			value,
+			envKeyToConfigPath(key)
+		]).sort(([, , configPath1], [, , configPath2]) => configPath1.localeCompare(configPath2));
+		if (mrtPublicEntries.length === 0) lines.push(chalk.dim("  (no MRT config overrides)"));
+		else {
+			const padLen = maxKeyLen(mrtPublicEntries.map(([, , configPath]) => configPath));
+			for (const [key, value, configPath] of mrtPublicEntries) {
+				const tag = !localVars.has(key) ? `  ${chalk.cyan("[MRT only]")}` : "";
+				lines.push(`  ${configPath.padEnd(padLen)} = ${value}${tag}`);
+			}
+		}
+		lines.push("");
+	}
+	if (envOverrides.length > 0) {
+		lines.push(chalk.dim("  Tip: Run `pnpm config:push-env` to sync local .env overrides to MRT."));
+		lines.push("");
+	}
+	return lines.join("\n");
+}
+
+//#endregion
+//#region src/commands/config/inspect.ts
+/**
+* Show which config.server.ts values are overridden by .env or MRT.
+* When MRT is configured, each override is marked [local only] or [MRT only] as applicable.
+*
+* Environment variables read:
+*   MRT_PROJECT  (optional) - MRT project slug, overridden by --project flag
+*   MRT_TARGET   (optional) - MRT target environment, overridden by --environment flag
+*/
+var ConfigInspect = class ConfigInspect extends MrtCommand {
+	static description = "Show which config.server.ts values are overridden by .env or MRT";
+	static examples = [
+		"<%= config.bin %> <%= command.id %>",
+		"<%= config.bin %> <%= command.id %> --project my-project --environment staging",
+		"<%= config.bin %> <%= command.id %> -d /path/to/my-storefront"
+	];
+	static flags = {
+		...MrtCommand.baseFlags,
+		...commonFlags
+	};
+	operations = {
+		readEnvFile: (projectDirectory) => {
+			const envPath = join(projectDirectory, ".env");
+			try {
+				return parseEnv(fs.readFileSync(envPath, "utf8"));
+			} catch (err) {
+				if (err.code === "ENOENT") return {};
+				throw err;
+			}
+		},
+		loadConfig: async (projectDirectory) => {
+			return (await import(pathToFileURL(join(projectDirectory, "node_modules/@salesforce/storefront-next-runtime/dist/config-load.js")).href)).loadConfig();
+		},
+		listEnvVars
+	};
+	async run() {
+		const { flags, raw } = await this.parse(ConfigInspect);
+		const projectDirectory = resolve(flags["project-directory"]);
+		const explicitFlags = new Set(raw.filter((t) => t.type === "flag").map((t) => t.flag));
+		const rawEnvVars = this.operations.readEnvFile(projectDirectory);
+		if (Object.keys(rawEnvVars).length === 0) this.warn(`No .env file found in ${projectDirectory}. Showing config.server.ts defaults only.`);
+		let config = {};
+		const originalCwd = process.cwd();
+		try {
+			process.chdir(projectDirectory);
+			config = await this.operations.loadConfig(projectDirectory);
+		} catch (err) {
+			this.warn(`Could not load storefront config: ${err.message}`);
+		} finally {
+			process.chdir(originalCwd);
+		}
+		const flatConfig = flattenObject(config);
+		const envKeys = new Set(Object.keys(rawEnvVars).filter((k) => k.startsWith("PUBLIC__")));
+		const sources = getValueSources(flatConfig.map((e) => e.key), envKeys);
+		const project = (explicitFlags.has("project") ? flags.project : void 0) || rawEnvVars.MRT_PROJECT || this.resolvedConfig.values.mrtProject;
+		const environment = (explicitFlags.has("environment") ? flags.environment : void 0) || rawEnvVars.MRT_TARGET || this.resolvedConfig.values.mrtEnvironment;
+		let mrtVars = null;
+		if (project && environment) try {
+			this.requireMrtCredentials();
+			const { variables } = await this.operations.listEnvVars({
+				projectSlug: project,
+				environment,
+				origin: this.resolvedConfig.values.mrtOrigin
+			}, this.getMrtAuth());
+			mrtVars = new Map(variables.map((v) => [v.name, v.value]));
+		} catch (err) {
+			this.warn(`Could not fetch MRT env vars for ${project}/${environment}: ${err.message}`);
+		}
+		else ux.stdout("ℹ MRT project/environment not configured. Skipping MRT comparison.\n  Use --project and --environment flags or set MRT_PROJECT/MRT_TARGET.\n");
+		const output = formatInspectOutput({
+			flatConfig,
+			sources,
+			localVars: new Map(Object.entries(rawEnvVars)),
+			mrtVars
+		});
+		ux.stdout(output);
+	}
+};
+
+//#endregion
+export { ConfigInspect as default };

package/dist/commands/create-bundle.js

@@ -2,7 +2,7 @@ import { t as logger } from "../logger.js";
 import "../logger2.js";
 import { i as getMrtConfig, n as getDefaultBuildDir, r as getDefaultMessage } from "../utils.js";
 import { a as buildMrtConfig } from "../config.js";
-import { t as commonFlags } from "../flags.js";
+import { r as commonFlags } from "../flags.js";
 import { t as createBundle } from "../bundle.js";
 import { Command, Flags } from "@oclif/core";
 import path from "path";

package/dist/commands/create-storefront.js

@@ -7,8 +7,8 @@ import { Command, Flags } from "@oclif/core";
 import { execFileSync, execSync } from "child_process";
 import path from "path";
 import fs from "fs-extra";
-import dotenv from "dotenv";
 import prompts from "prompts";
+import { parseEnv } from "node:util";
 
 //#region src/create-storefront.ts
 const DEFAULT_STOREFRONT = "sfcc-storefront";
@@ -156,7 +156,7 @@ const createStorefront = async (options = {}) => {
 	const configMeta = JSON.parse(fs.readFileSync(configMetaPath, "utf8"));
 	const envDefaultPath = path.join(outputPath, ".env.default");
 	let envDefaultValues = {};
-	if (fs.existsSync(envDefaultPath)) envDefaultValues = dotenv.parse(fs.readFileSync(envDefaultPath, "utf8"));
+	if (fs.existsSync(envDefaultPath)) envDefaultValues = parseEnv(fs.readFileSync(envDefaultPath, "utf8"));
 	logger.info("\n⚙️ We will now configure your storefront before it will be ready to run.\n");
 	const configOverrides = {};
 	for (const config of configMeta.configs) if (options.defaults) configOverrides[config.key] = envDefaultValues[config.key] ?? "";
@@ -164,7 +164,7 @@ const createStorefront = async (options = {}) => {
 		const answer = await prompts({
 			type: "text",
 			name: config.key,
-			message: `What is the value for ${config.name}? (default: ${envDefaultValues[config.key]})\n`,
+			message: `What is the value for ${config.name}? (default: ${envDefaultValues[config.key] ?? ""})\n`,
 			initial: envDefaultValues[config.key] ?? ""
 		});
 		configOverrides[config.key] = answer[config.key];

package/dist/commands/dev.js

@@ -1,9 +1,8 @@
 import { i as printShutdownMessage, n as printServerConfig, r as printServerInfo } from "../logger.js";
 import "../logger2.js";
-import { c as loadEnvFile } from "../utils.js";
 import { i as loadProjectConfig, n as initBasePathEnv, r as getCommerceCloudApiUrl, t as createServer$2 } from "../server.js";
 import "../config.js";
-import { t as commonFlags } from "../flags.js";
+import { r as commonFlags } from "../flags.js";
 import { Command, Flags } from "@oclif/core";
 import path from "path";
 import { createServer } from "node:http";
@@ -49,7 +48,6 @@ async function dev(options = {}) {
 	const projectDir = path.resolve(options.projectDirectory || process.cwd());
 	const port = options.port || 5173;
 	process.env.NODE_ENV = process.env.NODE_ENV ?? "development";
-	loadEnvFile(projectDir);
 	await initBasePathEnv(projectDir);
 	process.env.EXTERNAL_DOMAIN_NAME = process.env.EXTERNAL_DOMAIN_NAME ?? `localhost:${port}`;
 	const config = await loadProjectConfig(projectDir);

package/dist/commands/extensions/install.js

@@ -1,7 +1,7 @@
 import "../../logger.js";
 import "../../logger2.js";
 import "../../dependency-utils.js";
-import { t as commonFlags } from "../../flags.js";
+import { r as commonFlags } from "../../flags.js";
 import { r as manageExtensions } from "../../manage-extensions.js";
 import { Command, Flags } from "@oclif/core";
 

package/dist/commands/extensions/list.js

@@ -1,7 +1,7 @@
 import "../../logger.js";
 import "../../logger2.js";
 import "../../dependency-utils.js";
-import { t as commonFlags } from "../../flags.js";
+import { r as commonFlags } from "../../flags.js";
 import { n as listExtensions } from "../../manage-extensions.js";
 import { Command } from "@oclif/core";
 

package/dist/commands/extensions/remove.js

@@ -1,7 +1,7 @@
 import "../../logger.js";
 import "../../logger2.js";
 import "../../dependency-utils.js";
-import { t as commonFlags } from "../../flags.js";
+import { r as commonFlags } from "../../flags.js";
 import { r as manageExtensions } from "../../manage-extensions.js";
 import { Command, Flags } from "@oclif/core";
 

package/dist/commands/generate-cartridge.js

@@ -1,7 +1,7 @@
 import "../logger.js";
 import "../logger2.js";
 import { i as SFNEXT_BASE_CARTRIDGE_OUTPUT_DIR, t as CARTRIDGES_BASE_DIR } from "../config.js";
-import { t as commonFlags } from "../flags.js";
+import { r as commonFlags } from "../flags.js";
 import { t as generateMetadata } from "../generate-cartridge.js";
 import { t as validateCartridgeMetadata } from "../validate-cartridge.js";
 import { Command } from "@oclif/core";

package/dist/commands/locales/aggregate-extensions.js

@@ -0,0 +1,181 @@
+import { t as logger } from "../../logger.js";
+import "../../logger2.js";
+import { r as commonFlags } from "../../flags.js";
+import { Command, Flags } from "@oclif/core";
+import { existsSync } from "node:fs";
+import { join } from "node:path";
+import { mkdir, readdir, writeFile } from "fs/promises";
+
+//#region src/i18n/aggregate-extension-locales.ts
+/** Apache License 2.0 header text for generated files. Inlined to avoid path resolution issues in standalone projects. */
+const APACHE_LICENSE_HEADER = [
+	`Copyright ${(/* @__PURE__ */ new Date()).getFullYear()} Salesforce, Inc.`,
+	"",
+	"Licensed under the Apache License, Version 2.0 (the \"License\");",
+	"you may not use this file except in compliance with the License.",
+	"You may obtain a copy of the License at",
+	"",
+	"    http://www.apache.org/licenses/LICENSE-2.0",
+	"",
+	"Unless required by applicable law or agreed to in writing, software",
+	"distributed under the License is distributed on an \"AS IS\" BASIS,",
+	"WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.",
+	"See the License for the specific language governing permissions and",
+	"limitations under the License."
+].join("\n");
+function getDefaultDirs(projectDirectory) {
+	const srcDir = join(projectDirectory, "src");
+	return {
+		SRC_DIR: srcDir,
+		EXTENSIONS_DIR: join(srcDir, "extensions"),
+		OUTPUT_DIR: join(srcDir, "extensions", "locales")
+	};
+}
+/** Convert kebab-case to PascalCase (e.g. `store-locator` → `StoreLocator`). */
+function toPascalCase(str) {
+	return str.split("-").map((part) => part.charAt(0).toUpperCase() + part.slice(1)).join("");
+}
+/** Convert kebab-case to camelCase for variable names (e.g. `store-locator` → `storeLocator`). */
+function toCamelCase(str) {
+	const pascal = toPascalCase(str);
+	return pascal.charAt(0).toLowerCase() + pascal.slice(1);
+}
+/** Scan main app and extension directories to find all available locale codes. */
+async function discoverLocales(dirs) {
+	const { SRC_DIR, EXTENSIONS_DIR } = dirs;
+	const locales = /* @__PURE__ */ new Set();
+	const mainLocalesPath = join(SRC_DIR, "locales");
+	if (existsSync(mainLocalesPath)) try {
+		const mainLocaleEntries = await readdir(mainLocalesPath, { withFileTypes: true });
+		for (const entry of mainLocaleEntries) if (entry.isDirectory()) locales.add(entry.name);
+	} catch (error) {
+		if (error.code !== "ENOENT") throw error;
+	}
+	try {
+		const extensions = await readdir(EXTENSIONS_DIR, { withFileTypes: true });
+		for (const extension of extensions) {
+			if (!extension.isDirectory() || extension.name === "locales") continue;
+			const localesPath = join(EXTENSIONS_DIR, extension.name, "locales");
+			if (!existsSync(localesPath)) continue;
+			const localeEntries = await readdir(localesPath, { withFileTypes: true });
+			for (const localeEntry of localeEntries) if (localeEntry.isDirectory()) locales.add(localeEntry.name);
+		}
+	} catch (error) {
+		if (error.code !== "ENOENT") throw error;
+	}
+	return locales;
+}
+/** Find all extensions (NOT main app) that have a `translations.json` for the given locale. */
+async function findExtensionsWithLocale(locale, extensionsDir) {
+	const extensions = [];
+	try {
+		const extensionEntries = await readdir(extensionsDir, { withFileTypes: true });
+		for (const entry of extensionEntries) {
+			if (!entry.isDirectory() || entry.name === "locales") continue;
+			if (existsSync(join(extensionsDir, entry.name, "locales", locale, "translations.json"))) extensions.push({
+				name: entry.name,
+				path: `@/extensions/${entry.name}/locales/${locale}/translations.json`
+			});
+		}
+	} catch (error) {
+		if (error.code !== "ENOENT") throw error;
+	}
+	return extensions.sort((a, b) => a.name.localeCompare(b.name));
+}
+/** Generate the locale index file content that re-exports extension translations under `extPascalCase` namespaces. */
+function generateLocaleFile(extensions) {
+	const header = `${`/**\n${APACHE_LICENSE_HEADER.split("\n").map((line) => line ? ` * ${line}` : " *").join("\n")}\n */`}
+
+// NOTE: This file is auto-generated. Do not edit manually.
+// Run 'pnpm locales:aggregate-extensions' to regenerate this file.
+
+`;
+	if (extensions.length === 0) return `${header}// No extension translations found for this locale\nexport default {};\n`;
+	return `${header}${extensions.map((ext) => {
+		return `import ${`${toCamelCase(ext.name)}Translations`} from '${ext.path}';`;
+	}).join("\n")}
+
+// Namespace is based on the following convention: extPascalCase, and it's the pascal case of the folder name (e.g. store-locator -> extStoreLocator)
+export default {
+${extensions.map((ext) => {
+		return `    ${`ext${toPascalCase(ext.name)}`}: ${`${toCamelCase(ext.name)}Translations`},`;
+	}).join("\n")}
+};
+`;
+}
+/**
+* Generate aggregation files for extension translations only.
+* Main app translations in `/src/locales/` are NOT aggregated — only per-extension `translations.json` files.
+*/
+async function aggregateExtensionLocales(options = {}) {
+	const { projectDirectory = process.cwd(), silent = false } = options;
+	const dirs = options.dirs ?? getDefaultDirs(projectDirectory);
+	const { OUTPUT_DIR, EXTENSIONS_DIR } = dirs;
+	const log = (message, ...args) => {
+		if (!silent) logger.debug(message, ...args);
+	};
+	try {
+		log("🔍 Scanning for extension translation files...");
+		const locales = await discoverLocales(dirs);
+		if (locales.size === 0) {
+			log("📝 No locales found in extensions. Nothing to generate.");
+			return {
+				generated: 0,
+				locales: []
+			};
+		}
+		log(`📝 Found ${locales.size} locale(s): ${Array.from(locales).join(", ")}`);
+		await mkdir(OUTPUT_DIR, { recursive: true });
+		const results = [];
+		for (const locale of locales) {
+			const extensions = await findExtensionsWithLocale(locale, EXTENSIONS_DIR);
+			const content = generateLocaleFile(extensions);
+			const outputPath = join(OUTPUT_DIR, locale);
+			await mkdir(outputPath, { recursive: true });
+			const filePath = join(outputPath, "index.ts");
+			await writeFile(filePath, content, "utf8");
+			log(`✅ Generated: src/extensions/locales/${locale}/index.ts (${extensions.length} extension(s))`);
+			results.push({
+				locale,
+				extensionCount: extensions.length,
+				filePath
+			});
+		}
+		log("✨ Extension locale generation complete!");
+		return {
+			generated: results.length,
+			locales: results
+		};
+	} catch (error) {
+		if (!silent) logger.error(`❌ Error generating extension locales: ${String(error)}`);
+		throw error;
+	}
+}
+
+//#endregion
+//#region src/commands/locales/aggregate-extensions.ts
+var AggregateExtensions = class AggregateExtensions extends Command {
+	static description = "Aggregate extension translation files into per-locale barrel files";
+	static examples = [
+		"<%= config.bin %> <%= command.id %>",
+		"<%= config.bin %> <%= command.id %> -d ./my-project",
+		"<%= config.bin %> <%= command.id %> --silent"
+	];
+	static flags = {
+		...commonFlags,
+		silent: Flags.boolean({
+			description: "Suppress output",
+			default: false
+		})
+	};
+	async run() {
+		const { flags } = await this.parse(AggregateExtensions);
+		await aggregateExtensionLocales({
+			projectDirectory: flags["project-directory"],
+			silent: flags.silent
+		});
+	}
+};
+
+//#endregion
+export { AggregateExtensions as default };

package/dist/commands/prepare-local.js

@@ -1,6 +1,6 @@
 import "../logger.js";
 import { t as prepareForLocalDev } from "../local-dev-setup.js";
-import { t as commonFlags } from "../flags.js";
+import { r as commonFlags } from "../flags.js";
 import { Command, Flags } from "@oclif/core";
 
 //#region src/commands/prepare-local.ts

package/dist/commands/preview.js

@@ -1,9 +1,8 @@
 import { i as printShutdownMessage, n as printServerConfig, r as printServerInfo, t as logger } from "../logger.js";
 import "../logger2.js";
-import { c as loadEnvFile } from "../utils.js";
 import { i as loadProjectConfig, n as initBasePathEnv, r as getCommerceCloudApiUrl, t as createServer } from "../server.js";
 import "../config.js";
-import { t as commonFlags } from "../flags.js";
+import { r as commonFlags } from "../flags.js";
 import { Command, Flags } from "@oclif/core";
 import { execSync } from "child_process";
 import path from "path";
@@ -22,7 +21,6 @@ async function preview(options = {}) {
 	const port = options.port || 3e3;
 	process.env.NODE_ENV = process.env.NODE_ENV ?? "production";
 	process.env.EXTERNAL_DOMAIN_NAME = process.env.EXTERNAL_DOMAIN_NAME ?? `localhost:${port}`;
-	loadEnvFile(projectDir);
 	await initBasePathEnv(projectDir);
 	const buildPath = path.join(projectDir, "build", "server", "index.js");
 	if (!fs.existsSync(buildPath)) {