@salesforce/b2c-cli 1.19.1 → 1.20.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@salesforce/b2c-cli",
   "description": "A Salesforce B2C Commerce CLI",
-  "version": "1.19.1",
+  "version": "1.20.1",
   "author": "Charles Lavery",
   "bin": {
     "b2c": "./bin/run.js"
@@ -25,7 +25,7 @@
     "marked": "15.0.12",
     "marked-terminal": "7.3.0",
     "open": "11.0.0",
-    "@salesforce/b2c-tooling-sdk": "1.19.1"
+    "@salesforce/b2c-tooling-sdk": "1.20.1"
   },
   "devDependencies": {
     "@eslint/compat": "^1",
@@ -248,6 +248,22 @@
           }
         }
       },
+      "preferences": {
+        "description": "Commands for managing custom global and site preferences\n\nDocs: https://salesforcecommercecloud.github.io/b2c-developer-tooling/cli/preferences.html",
+        "subtopics": {
+          "global": {
+            "description": "Read and update custom preferences at the organization (global) level"
+          },
+          "site": {
+            "description": "Read, update, and search custom preferences at the site level",
+            "subtopics": {
+              "preference": {
+                "description": "Read and update a single preference value across sites in a site preference group"
+              }
+            }
+          }
+        }
+      },
       "metrics": {
         "description": "[CLOSED BETA] Retrieve observability metrics from SCAPI Metrics API\n\nDocs: https://salesforcecommercecloud.github.io/b2c-developer-tooling/cli/metrics.html"
       },

package/dist/commands/setup/ide/prophet.js

@@ -1,327 +0,0 @@
-/*
- * Copyright (c) 2025, Salesforce, Inc.
- * SPDX-License-Identifier: Apache-2
- * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
- */
-import * as fs from 'node:fs/promises';
-import { existsSync } from 'node:fs';
-import path from 'node:path';
-import { Flags, ux } from '@oclif/core';
-import { BaseCommand } from '@salesforce/b2c-tooling-sdk/cli';
-import { withDocs } from '../../../i18n/index.js';
-/**
- * Build the dw.js script for Prophet integration.
- */
-function buildDwJsScript(inspectArgs) {
-    return `/**
- * Auto-generated by "b2c setup ide prophet".
- * Purpose: Provide Prophet VS Code extension with dw.json-compatible configuration
- * by exporting the resolved B2C CLI config as module.exports.
- * support dwJson multi-config in prophet and other tools that support dw.js loading
- * when this is present prophet will ignore dw.json and instead load the configuration exported
- * This script shells out to: b2c setup inspect --json --unmask
- */
-var childProcess = require('node:child_process');
-var path = require('node:path');
-var INSPECT_ARGS = ${JSON.stringify(inspectArgs)};
-var dwJson = {};
-
-function logProphetDw(message, error) {
-  var suffix = error && error.message ? ': ' + String(error.message) : '';
-  var line = '[b2c setup ide prophet] ' + message + suffix;
-
-  // Best-effort logging: this script is loaded by external tools (Prophet) where
-  // console may be redirected or unavailable. A failure to log a log message is
-  // not actionable and must not interfere with returning the resolved config.
-  try {
-    console.error(line);
-  } catch (logError) {
-    /* ignore */
-  }
-
-  try {
-    console.log(line);
-  } catch (logError) {
-    /* ignore */
-  }
-}
-
-function loadDotEnv() {
-  try {
-    require('dotenv').config({override: true});
-  } catch (error) {
-    // optional dependency
-  }
-}
-
-function getWorkspaceRoot() {
-  if (process.env.SFCC_PROJECT_DIRECTORY && process.env.SFCC_PROJECT_DIRECTORY.trim()) {
-    return process.env.SFCC_PROJECT_DIRECTORY.trim();
-  }
-
-  if (process.env.SFCC_WORKING_DIRECTORY && process.env.SFCC_WORKING_DIRECTORY.trim()) {
-    return process.env.SFCC_WORKING_DIRECTORY.trim();
-  }
-
-  if (process.env.SFCC_CONFIG && process.env.SFCC_CONFIG.trim()) {
-    return path.dirname(process.env.SFCC_CONFIG.trim());
-  }
-
-  if (typeof __dirname === 'string' && __dirname) {
-    return __dirname;
-  }
-
-  if (typeof module !== 'undefined' && module && module.filename) {
-    return path.dirname(module.filename);
-  }
-
-  if (typeof workspace !== 'undefined' && workspace && Array.isArray(workspace.workspaceFolders)) {
-    for (var i = 0; i < workspace.workspaceFolders.length; i += 1) {
-      var folder = workspace.workspaceFolders[i];
-      if (folder && folder.uri && typeof folder.uri.fsPath === 'string' && folder.uri.fsPath) {
-        return folder.uri.fsPath;
-      }
-    }
-  }
-
-  return process.cwd();
-}
-
-function withProjectDirectory(args, projectDirectory) {
-  if (!projectDirectory || args.indexOf('--project-directory') !== -1 || args.indexOf('--working-directory') !== -1) {
-    return args.slice();
-  }
-
-  return args.concat(['--project-directory', projectDirectory]);
-}
-
-function pickInspectConfig(parsed) {
-  if (!parsed || typeof parsed !== 'object') {
-    return {};
-  }
-
-  var root = parsed.result && typeof parsed.result === 'object' ? parsed.result : parsed;
-
-  if (root.config && typeof root.config === 'object') {
-    return root.config;
-  }
-
-  if (root.result && root.result.config && typeof root.result.config === 'object') {
-    return root.result.config;
-  }
-
-  return root;
-}
-
-function runSetupInspect(projectDirectory) {
-  var inspectArgs = withProjectDirectory(INSPECT_ARGS, projectDirectory);
-  var candidates = [];
-
-  if (process.env.B2C_CLI_BIN && process.env.B2C_CLI_BIN.trim()) {
-    candidates.push({cmd: process.env.B2C_CLI_BIN.trim(), args: inspectArgs});
-  }
-
-  candidates.push({cmd: 'b2c', args: inspectArgs});
-  candidates.push({cmd: 'npx', args: ['--yes', '@salesforce/b2c-cli'].concat(inspectArgs)});
-
-  var lastError;
-
-  for (var i = 0; i < candidates.length; i += 1) {
-    var candidate = candidates[i];
-    try {
-      var execOptions = {
-        encoding: 'utf8',
-        stdio: ['ignore', 'pipe', 'pipe'],
-      };
-      if (projectDirectory) {
-        execOptions.cwd = projectDirectory;
-      }
-
-      var stdout = childProcess.execFileSync(candidate.cmd, candidate.args, execOptions);
-      return pickInspectConfig(JSON.parse(stdout));
-    } catch (error) {
-      logProphetDw('setup inspect candidate failed (' + candidate.cmd + ')', error);
-      lastError = error;
-    }
-  }
-
-  throw lastError || new Error('No setup inspect candidate succeeded');
-}
-
-function resolveDwJsonConfig(raw) {
-  if (!raw || typeof raw !== 'object') {
-    return {};
-  }
-
-  var instanceName = process.env.SFCC_INSTANCE;
-
-  if (!instanceName || raw.name !== instanceName) {
-    if (instanceName && Array.isArray(raw.configs)) {
-      return raw.configs.find(function (item) {
-        return item && item.name === instanceName;
-      }) || raw;
-    }
-
-    if (Array.isArray(raw.configs) && raw.active !== true) {
-      return raw.configs.find(function (item) {
-        return item && item.active === true;
-      }) || raw;
-    }
-  }
-
-  return raw;
-}
-
-function loadDwJsonFallback(projectDirectory) {
-  try {
-    var dwJsonPath = process.env.SFCC_CONFIG ? process.env.SFCC_CONFIG : path.join(projectDirectory, 'dw.json');
-    if (!path.isAbsolute(dwJsonPath)) {
-      dwJsonPath = path.resolve(projectDirectory || process.cwd(), dwJsonPath);
-    }
-
-    return resolveDwJsonConfig(require(dwJsonPath));
-  } catch (error) {
-    logProphetDw('dw.json fallback failed', error);
-    return {};
-  }
-}
-
-function toProphetConfig(config) {
-  if (!config || typeof config !== 'object') {
-    return {};
-  }
-
-  var result = {};
-  var codeVersion = config['code-version'] || config.codeVersion || config.version;
-
-  if (config.hostname || config.server) {
-    result.hostname = config.hostname || config.server;
-  }
-  if (config.username) {
-    result.username = config.username;
-  }
-  if (config.password) {
-    result.password = config.password;
-  }
-  if (codeVersion) {
-    result['code-version'] = codeVersion;
-    result.version = codeVersion;
-  }
-  if (config.cartridgesPath !== undefined) {
-    result.cartridgesPath = config.cartridgesPath;
-  }
-  if (config.siteID !== undefined || config.siteId !== undefined) {
-    result.siteID = config.siteID || config.siteId;
-  }
-  if (config.storefrontPassword !== undefined) {
-    result.storefrontPassword = config.storefrontPassword;
-  }
-  if (config.cartridge !== undefined) {
-    result.cartridge = config.cartridge;
-  }
-
-  return result;
-}
-
-function loadDwConfig() {
-  loadDotEnv();
-  var projectDirectory = getWorkspaceRoot();
-
-  try {
-    var inspectConfig = runSetupInspect(projectDirectory);
-    var inspectMapped = toProphetConfig(inspectConfig);
-    if (inspectMapped.hostname) {
-      return inspectMapped;
-    }
-
-    logProphetDw('setup inspect returned no hostname; falling back to dw.json');
-  } catch (error) {
-    logProphetDw('setup inspect failed; falling back to dw.json', error);
-  }
-
-  try {
-    var fallbackMapped = toProphetConfig(loadDwJsonFallback(projectDirectory));
-    if (!fallbackMapped.hostname) {
-      logProphetDw('dw.json fallback returned no hostname');
-    }
-
-    return fallbackMapped;
-  } catch (error) {
-    logProphetDw('dw.json mapping failed; returning empty config', error);
-    return {};
-  }
-}
-
-try {
-  dwJson = loadDwConfig();
-} catch (error) {
-  logProphetDw('unexpected dw.js error; returning empty config', error);
-  dwJson = {};
-}
-
-module.exports = dwJson;
-`;
-}
-/**
- * Create dw.js integration script for Prophet VS Code extension.
- */
-export default class SetupIdeProphet extends BaseCommand {
-    static description = withDocs('Generate a dw.js script that exposes B2C CLI config for Prophet VS Code', '/cli/setup.html#b2c-setup-ide-prophet');
-    static enableJsonFlag = true;
-    static examples = [
-        '<%= config.bin %> <%= command.id %>',
-        '<%= config.bin %> <%= command.id %> --force',
-        '<%= config.bin %> <%= command.id %> --output .vscode/dw.js',
-        '<%= config.bin %> <%= command.id %> --instance staging',
-    ];
-    static flags = {
-        ...BaseCommand.baseFlags,
-        output: Flags.string({
-            char: 'o',
-            description: 'Path for generated script file',
-            default: 'dw.js',
-        }),
-        force: Flags.boolean({
-            char: 'f',
-            description: 'Overwrite output file if it already exists',
-            default: false,
-        }),
-    };
-    async run() {
-        const outputPath = path.resolve(this.flags.output);
-        const alreadyExists = existsSync(outputPath);
-        if (alreadyExists && !this.flags.force) {
-            this.error(`File already exists at ${outputPath}. Use --force to overwrite.`);
-        }
-        const inspectArgs = this.buildInspectArgs();
-        const script = buildDwJsScript(inspectArgs);
-        await fs.mkdir(path.dirname(outputPath), { recursive: true });
-        await fs.writeFile(outputPath, script, 'utf8');
-        const result = {
-            path: outputPath,
-            overwritten: alreadyExists,
-        };
-        if (!this.jsonEnabled()) {
-            ux.stdout(`Created ${outputPath}`);
-        }
-        return result;
-    }
-    /**
-     * Build setup inspect arguments for the generated script.
-     * Includes setup context flags so runtime resolution matches command intent.
-     */
-    buildInspectArgs() {
-        const args = ['setup', 'inspect', '--json', '--unmask'];
-        if (this.flags.instance) {
-            args.push('--instance', this.flags.instance);
-        }
-        if (this.flags.config) {
-            args.push('--config', this.flags.config);
-        }
-        if (this.flags['project-directory']) {
-            args.push('--project-directory', this.flags['project-directory']);
-        }
-        return args;
-    }
-}
-//# sourceMappingURL=prophet.js.map

package/dist/commands/setup/ide/prophet.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"prophet.js","sourceRoot":"","sources":["../../../../src/commands/setup/ide/prophet.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACvC,OAAO,EAAC,UAAU,EAAC,MAAM,SAAS,CAAC;AACnC,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAC,KAAK,EAAE,EAAE,EAAC,MAAM,aAAa,CAAC;AACtC,OAAO,EAAC,WAAW,EAAC,MAAM,iCAAiC,CAAC;AAC5D,OAAO,EAAC,QAAQ,EAAC,MAAM,wBAAwB,CAAC;AAUhD;;GAEG;AACH,SAAS,eAAe,CAAC,WAAqB;IAC5C,OAAO;;;;;;;;;;qBAUY,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6O/C,CAAC;AACF,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,WAAmC;IAC9E,MAAM,CAAC,WAAW,GAAG,QAAQ,CAC3B,yEAAyE,EACzE,uCAAuC,CACxC,CAAC;IAEF,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC;IAE7B,MAAM,CAAC,QAAQ,GAAG;QAChB,qCAAqC;QACrC,6CAA6C;QAC7C,4DAA4D;QAC5D,wDAAwD;KACzD,CAAC;IAEF,MAAM,CAAC,KAAK,GAAG;QACb,GAAG,WAAW,CAAC,SAAS;QACxB,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;YACnB,IAAI,EAAE,GAAG;YACT,WAAW,EAAE,gCAAgC;YAC7C,OAAO,EAAE,OAAO;SACjB,CAAC;QACF,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC;YACnB,IAAI,EAAE,GAAG;YACT,WAAW,EAAE,4CAA4C;YACzD,OAAO,EAAE,KAAK;SACf,CAAC;KACH,CAAC;IAEF,KAAK,CAAC,GAAG;QACP,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACnD,MAAM,aAAa,GAAG,UAAU,CAAC,UAAU,CAAC,CAAC;QAE7C,IAAI,aAAa,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YACvC,IAAI,CAAC,KAAK,CAAC,0BAA0B,UAAU,6BAA6B,CAAC,CAAC;QAChF,CAAC;QAED,MAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC5C,MAAM,MAAM,GAAG,eAAe,CAAC,WAAW,CAAC,CAAC;QAE5C,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC,CAAC;QAC5D,MAAM,EAAE,CAAC,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;QAE/C,MAAM,MAAM,GAA4B;YACtC,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,aAAa;SAC3B,CAAC;QAEF,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACxB,EAAE,CAAC,MAAM,CAAC,WAAW,UAAU,EAAE,CAAC,CAAC;QACrC,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;OAGG;IACK,gBAAgB;QACtB,MAAM,IAAI,GAAG,CAAC,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;QAExD,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;YACxB,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC/C,CAAC;QACD,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YACtB,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC3C,CAAC;QACD,IAAI,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,EAAE,CAAC;YACpC,IAAI,CAAC,IAAI,CAAC,qBAAqB,EAAE,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC;QACpE,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC"}