@salesforce/b2c-dx-mcp 2.1.2 → 3.0.0

package/node_modules/@salesforce/b2c-agent-plugins/b2c-cli/skills/b2c-job/references/EXPORT.md

@@ -0,0 +1,115 @@
+# Export Site Archives
+
+## Compact Results
+
+Normal CLI output reports completion and the saved path. When scripting, save
+the full JSON and stderr to files; print only verification fields. For example:
+
+```bash
+b2c job export --site MySite --site-data campaigns_and_promotions \
+  --output ./verification --json > export-result.json 2> export-stderr.log
+archive_status=$?
+if [ "$archive_status" -eq 0 ]; then
+  jq '{localPath, archiveFilename, execution: (.execution | {id, execution_status, exit_status})}' export-result.json
+else
+  jq '{name, message, code}' export-result.json
+  tail -n 40 export-stderr.log
+  exit "$archive_status"
+fi
+```
+
+Keep full artifacts for investigation; do not print them alongside the projection.
+After an import/export failure, inspect job status/logs before retrying. For an
+import, the same approach reports execution status without `localPath`.
+
+## Export Commands
+
+The `job export` command exports data from a B2C Commerce instance as a site archive. You must specify at least one data unit to export.
+
+```bash
+# export global metadata
+b2c job export --global-data meta_data
+
+# export multiple global data units
+b2c job export --global-data meta_data,custom_types,locales
+
+# export a site with all site data
+b2c job export --site RefArch
+
+# export a site with specific site data units
+b2c job export --site RefArch --site-data content,site_preferences
+
+# export multiple sites
+b2c job export --site RefArch --site SiteGenesis --site-data campaigns_and_promotions
+
+# export catalogs
+b2c job export --catalog storefront-catalog
+b2c job export --catalog storefront-catalog,electronics-catalog
+
+# export libraries
+b2c job export --library RefArchSharedLibrary
+
+# export inventory lists
+b2c job export --inventory-list my-inventory
+
+# export price books
+b2c job export --price-book usd-sale-prices
+
+# combine multiple top-level categories
+b2c job export --site RefArch --site-data content --catalog storefront-catalog --global-data meta_data
+
+# full control via raw JSON data units configuration
+b2c job export --data-units '{"global_data":{"meta_data":true},"sites":{"RefArch":{"content":true}}}'
+
+# save to a specific output directory
+b2c job export --global-data meta_data -o ./my-export
+
+# save as a zip file without extracting
+b2c job export --global-data meta_data --zip-only
+
+# leave the archive on the instance without downloading
+b2c job export --global-data meta_data --no-download
+
+# keep the archive on the instance after downloading
+b2c job export --global-data meta_data --keep-archive
+
+# set a timeout (seconds)
+b2c job export --global-data meta_data --timeout 600
+```
+
+#### Output Directory Semantics
+
+When `--output` names a directory, the CLI extracts the downloaded platform zip as-is. Platform exports contain a generated top-level directory such as `<timestamp>_export`, so `--output migrations` creates `migrations/<generated>_export/...`; it does not merge data units directly into `migrations/`. If `--output` ends in `.zip`, the CLI writes that exact zip path instead.
+
+For an ordered import-set migration, export to the import-set directory, rename the one newly generated archive root once to its permanent ordered name, and then review and trim it in place:
+
+```bash
+b2c job export --site RefArch --site-data site_descriptor --output migrations
+mv migrations/<GENERATED_EXPORT_DIR> migrations/20260815T120000-update-site-descriptor
+b2c job import-set --dry-run
+```
+
+Do not require a temporary directory and copy step for export-based migrations. Never export over an existing or applied archive. See `b2c-cli:b2c-import-set-migrations` for naming, trimming, retry, and deployment rules, and `b2c-cli:b2c-site-import-export` for valid archive structure.
+
+#### Available Data Units
+
+**Top-level categories** (each takes one or more IDs via flags):
+
+| Flag               | Description                                                                    |
+| ------------------ | ------------------------------------------------------------------------------ |
+| `--site`           | Site IDs to export (use `--site-data` to pick specific units, defaults to all) |
+| `--catalog`        | Catalog IDs                                                                    |
+| `--library`        | Library IDs                                                                    |
+| `--inventory-list` | Inventory list IDs                                                             |
+| `--price-book`     | Price book IDs                                                                 |
+| `--global-data`    | Global data units (comma-separated names from the list below)                  |
+
+**Site data units** (use with `--site-data`):
+
+`ab_tests`, `active_data_feeds`, `all`, `cache_settings`, `campaigns_and_promotions`, `content`, `coupons`, `custom_objects`, `customer_cdn_settings`, `customer_groups`, `distributed_commerce_extensions`, `dynamic_file_resources`, `gift_certificates`, `ocapi_settings`, `payment_methods`, `payment_processors`, `redirect_urls`, `search_settings`, `shipping`, `site_descriptor`, `site_preferences`, `sitemap_settings`, `slots`, `sorting_rules`, `source_codes`, `static_dynamic_alias_mappings`, `stores`, `tax`, `url_rules`
+
+**Global data units** (use with `--global-data`):
+
+`access_roles`, `all`, `csc_settings`, `csrf_whitelists`, `custom_preference_groups`, `custom_quota_settings`, `custom_types`, `geolocations`, `global_custom_objects`, `job_schedules`, `job_schedules_deprecated`, `locales`, `meta_data`, `oauth_providers`, `ocapi_settings`, `page_meta_tags`, `preferences`, `price_adjustment_limits`, `services`, `sorting_rules`, `static_resources`, `system_type_definitions`, `users`, `webdav_client_permissions`
+
+For full control over the export configuration (including `catalog_static_resources`, `library_static_resources`, and `customer_lists`), use `--data-units` with a JSON string matching the `ExportDataUnitsConfiguration` shape.

package/node_modules/@salesforce/b2c-agent-plugins/b2c-cli/skills/b2c-job/references/IMPORT.md

@@ -0,0 +1,43 @@
+# Import Site Archives
+
+### Import Site Archives
+
+The `job import` command waits for the import job to complete by default. The same command imports a **job definition** (`jobs.xml` at the archive root) that registers a new runnable job on the instance — for the `jobs.xml` structure (job/flow/step, step `type`, the required `<triggers>` element), see the [jobs.xml Reference](../../../../b2c/skills/b2c-custom-job-steps/references/JOBS-XML.md).
+
+```bash
+# import a local directory as a site archive (waits for completion by default)
+b2c job import ./my-site-data
+
+# import a local zip file
+b2c job import ./export.zip
+
+# import and return immediately without waiting for completion
+b2c job import ./my-site-data --no-wait
+
+# keep the archive on the instance after import
+b2c job import ./my-site-data --keep-archive
+
+# import an archive that already exists on the instance (in Impex/src/instance/)
+b2c job import existing-archive.zip --remote
+
+# show job log on failure
+b2c job import ./my-site-data --show-log
+
+# import only a subset of a directory (extra positionals are paths/globs
+# resolved against the directory; preserves layout inside the archive)
+b2c job import ./my-site-data sites/RefArch libraries/mylib
+b2c job import ./my-site-data 'libraries/**'
+```
+
+### Import Sets
+
+`job import-set` first applies site import/export archives from discovered cartridge `metadata/` sources, then applies archives in `./migrations`, and skips archives already recorded on the target instance:
+
+```bash
+b2c job import-set --dry-run
+b2c job import-set
+b2c job import-set --no-cartridge-metadata # only use ./migrations
+b2c job import-set --import-set-exclude fixtures # ignore this project subtree
+```
+
+`--import-set-exclude` can be repeated or comma-separated and can also be configured as `b2c.importSetExclude` in `package.json`, `import-set-exclude` in `dw.json`, or `SFCC_IMPORT_SET_EXCLUDE`. For the full migration workflow — archive layouts, timestamp naming, post-import README notes, retry behavior, reset options, concurrency, and recovery — use the `b2c-cli:b2c-import-set-migrations` skill.

package/node_modules/@salesforce/b2c-agent-plugins/b2c-cli/skills/b2c-job/references/RUN-AND-MONITOR.md

@@ -0,0 +1,119 @@
+# Run and Monitor Jobs
+
+### Run a Job
+
+```bash
+# run a job and return immediately
+b2c job run my-custom-job
+
+# run a job and wait for completion
+b2c job run my-custom-job --wait
+
+# run a job with a timeout (in seconds)
+b2c job run my-custom-job --wait --timeout 600
+
+# run a job with parameters (standard jobs)
+b2c job run my-custom-job -P "SiteScope={\"all_storefront_sites\":true}" -P OtherParam=value
+
+# show job log if the job fails
+b2c job run my-custom-job --wait --show-log
+```
+
+### Run System Jobs with Custom Request Bodies
+
+Some system jobs (like search indexing) use non-standard request schemas. Use `--body` to provide a raw JSON request body:
+
+```bash
+# run search index job for specific sites
+b2c job run sfcc-search-index-product-full-update --wait --body '{"site_scope":{"named_sites":["RefArch","SiteGenesis"]}}'
+
+# run search index job for a single site
+b2c job run sfcc-search-index-product-full-update --wait --body '{"site_scope":{"named_sites":["RefArch"]}}'
+```
+
+Note: `--body` and `-P` are mutually exclusive.
+
+### Standard (System) Job Steps
+
+B2C Commerce ships a catalog of **standard job steps** — built-in step **type IDs** (for example `ImportCatalog`, `ExportCatalog`, `ImportInventoryLists`) that are added to job flows in **Business Manager → Administration → Operations → Jobs**, or referenced by type ID in a `jobs.xml` flow inside a site-import archive. They are the building blocks of the multi-step jobs you run with `b2c job run`.
+
+Look up the catalog and any step's configuration parameters via the `b2c-cli:b2c-docs` skill — these docs are bundled with the CLI, so no instance connection is needed:
+
+```bash
+# Browse the standard step catalog
+b2c docs read job-steps
+
+# Look up a specific step's purpose + parameters
+b2c docs read ImportCatalog
+b2c docs search "export inventory"
+```
+
+**In-flow standard step vs. CLI command.** Some standard steps overlap with CLI commands — for instance, the standard catalog/site import steps vs. `b2c job import` (which itself runs the `sfcc-site-archive-import` system job). Use an **in-flow standard step** when the file is already staged on the instance or produced by an earlier step in the same flow (no round-trip, runs on a BM schedule). Use the **CLI** when moving data between your machine and the instance (uploading a local archive, downloading an export, or scripting from CI). For chaining custom + standard steps and IMPEX file hand-off, see the `b2c:b2c-custom-job-steps` skill.
+
+### View Job Logs
+
+```bash
+# get the log from the most recent execution of a job
+b2c job log my-custom-job
+
+# get the log from the most recent failed execution
+b2c job log my-custom-job --failed
+
+# get the log from a specific execution
+b2c job log my-custom-job abc123-def456
+```
+
+### Search Job Executions
+
+```bash
+# search for recent job executions
+b2c job search
+
+# filter by job ID
+b2c job search --job-id my-custom-job
+
+# filter by status
+b2c job search --status ERROR
+b2c job search --status RUNNING,PENDING
+
+# control result count and pagination
+b2c job search --count 50 --start 0
+
+# sort results
+b2c job search --sort-by start_time --sort-order desc
+
+# search with JSON output
+b2c job search --json
+```
+
+### Delete Job Executions
+
+```bash
+# delete a job execution record (requires SCAPI)
+b2c job execution delete my-job abc123-def456
+```
+
+### API Backend
+
+Job commands run over SCAPI. Configure `shortCode`, `tenantId`, and the SCAPI scopes and `job run`, `job search`, `job wait`, and `job log` work out of the box.
+
+**SCAPI scopes**: `sfcc.jobs.rw` (recommended) for full access, or `sfcc.jobs` for read-only (search, wait, log).
+
+OCAPI is deprecated and disabled on newer instances. `--api-backend auto` (the default) falls back to the OCAPI Data API on safe SCAPI capability/auth/request rejections; force a backend with `--api-backend scapi|ocapi`, dw.json `"api-backend": "scapi"`, or `SFCC_API_BACKEND=scapi`.
+
+SCAPI `DELETE` removes a completed execution record; it does not cancel a running job. The CLI does not expose job cancellation because the underlying job APIs do not provide that operation.
+
+> **Note:** `job import` and `job export` trigger the site-archive system jobs and transfer archive files over WebDAV. The job trigger honors `--api-backend`: in `auto` mode it runs over SCAPI (needs `sfcc.jobs.rw`) with OCAPI fallback if the SCAPI start is rejected. The archive transfer always uses WebDAV.
+
+### Wait for Job Completion
+
+```bash
+# wait for a specific job execution to complete (requires both job ID and execution ID)
+b2c job wait <job-id> <execution-id>
+
+# wait with a timeout
+b2c job wait <job-id> <execution-id> --timeout 600
+
+# wait with a custom polling interval
+b2c job wait <job-id> <execution-id> --poll-interval 5
+```

package/node_modules/@salesforce/b2c-agent-plugins/b2c-cli/skills/b2c-logs/SKILL.md

@@ -0,0 +1,249 @@
+---
+name: b2c-logs
+description: Retrieve and search logs from B2C Commerce instances using the b2c CLI. Use this skill whenever the user needs to view server logs, search for errors, filter log entries by level or time, or monitor logs in real-time. Also use when the user reports a 500 error, broken checkout, failing job, or any server-side issue that needs log investigation — even if they just say "something's broken on the sandbox" or "check the logs".
+---
+
+# B2C Logs Skill
+
+Use the `b2c` CLI to retrieve and monitor log files on Salesforce B2C Commerce instances. The `logs get` command is designed for agent-friendly, non-interactive log retrieval with structured JSON output.
+
+> **Tip:** If `b2c` is not installed globally, use `npx @salesforce/b2c-cli` instead (e.g., `npx @salesforce/b2c-cli logs get`).
+
+## Configuration & Authentication
+
+The CLI auto-discovers the target instance and credentials from `SFCC_*` environment variables (including project `.env`), the selected project-local or shared `dw.json`, and configuration plugins. `package.json` supplies only non-sensitive defaults. **Flags like `--server`, `--client-id`, `--client-secret`, `--username`, and `--password` are usually unnecessary** — only pass them to override what's auto-detected.
+
+Run `b2c setup inspect` to see the resolved configuration and which source provided each value (use `--json` for scripting; secrets stay masked by default). For precedence rules and troubleshooting, see the `b2c-cli:b2c-config` skill.
+
+## Agent-Friendly Log Retrieval
+
+The `logs get` command is optimized for coding agents:
+
+- Exits immediately after retrieving logs (non-interactive)
+- Supports `--json` for structured output
+- Filters by time, level, and text search
+- Auto-normalizes file paths for IDE click-to-open
+
+## Examples
+
+### Get Recent Logs
+
+```bash
+# Get last 20 entries from error and customerror logs (default)
+b2c logs get
+
+# Get last 50 entries
+b2c logs get --count 50
+
+# JSON output for programmatic parsing
+b2c logs get --json
+```
+
+### Filter by Time
+
+```bash
+# Entries from the last 5 minutes
+b2c logs get --since 5m
+
+# Entries from the last 1 hour
+b2c logs get --since 1h
+
+# Entries from the last 2 days
+b2c logs get --since 2d
+
+# Entries after a specific time (ISO 8601)
+b2c logs get --since "2026-01-25T10:00:00"
+```
+
+### Filter by Log Level
+
+```bash
+# Only ERROR level entries
+b2c logs get --level ERROR
+
+# ERROR and FATAL entries
+b2c logs get --level ERROR --level FATAL
+```
+
+### Search Text
+
+```bash
+# Search for "OrderMgr" in messages
+b2c logs get --search OrderMgr
+
+# Search for payment errors
+b2c logs get --search "PaymentProcessor"
+```
+
+### Combined Filters
+
+```bash
+# Recent errors containing "PaymentProcessor"
+b2c logs get --since 1h --level ERROR --search "PaymentProcessor" --json
+
+# Last hour of errors and fatals from specific log types
+b2c logs get --filter error --filter warn --since 1h --level ERROR --level FATAL
+```
+
+### List Available Log Files
+
+```bash
+# List all log files
+b2c logs list
+
+# List specific log types
+b2c logs list --filter error --filter customerror
+
+# List logs in a subdirectory (path-like filter)
+b2c logs list --filter internal/server
+
+# JSON output
+b2c logs list --json
+```
+
+### Real-Time Tailing (Human Use)
+
+For interactive log monitoring (not for agents):
+
+```bash
+# Tail error and customerror logs
+b2c logs tail
+
+# Tail specific log types
+b2c logs tail --filter debug --filter error
+
+# Tail only ERROR and FATAL level entries
+b2c logs tail --level ERROR --level FATAL
+
+# Tail with text search
+b2c logs tail --search "PaymentProcessor"
+
+# Combined filtering
+b2c logs tail --filter customerror --level ERROR --search "OrderMgr"
+
+# Stop with Ctrl+C
+```
+
+## Downloading Full Log Files
+
+To download the complete log file, use the `file` field from the JSON output with `b2c-cli:b2c-webdav`:
+
+```bash
+b2c webdav get error-odspod-0-appserver-20260126.log --root=logs -o -
+```
+
+## JSON Output Structure
+
+When using `--json`, `logs get` returns:
+
+```json
+{
+  "count": 1,
+  "entries": [
+    {
+      "file": "error-odspod-0-appserver-20260126.log",
+      "timestamp": "2026-01-26 04:38:03.022 GMT",
+      "level": "ERROR",
+      "message": "PipelineCallServlet|156679877|Sites-Site|...",
+      "raw": "[2026-01-26 04:38:03.022 GMT] ERROR PipelineCallServlet|..."
+    }
+  ]
+}
+```
+
+| Field       | Description                                                                |
+| ----------- | -------------------------------------------------------------------------- |
+| `file`      | Source log file name (use with `b2c-cli:b2c-webdav` to download full file) |
+| `level`     | Log level: ERROR, WARN, INFO, DEBUG, FATAL, TRACE                          |
+| `timestamp` | Entry timestamp                                                            |
+| `message`   | Log message (paths normalized for IDE click-to-open)                       |
+| `raw`       | Raw unprocessed log line                                                   |
+
+## Log Types
+
+Common log file prefixes:
+
+| Prefix        | Description                             |
+| ------------- | --------------------------------------- |
+| `error`       | System errors                           |
+| `customerror` | Custom script errors (`Logger.error()`) |
+| `warn`        | Warnings                                |
+| `debug`       | Debug output (when enabled)             |
+| `info`        | Informational messages                  |
+| `jobs`        | Job execution logs                      |
+| `api`         | API problems and violations             |
+| `deprecation` | Deprecated API usage                    |
+| `quota`       | Quota warnings                          |
+
+The prefixes above are the **built-in** log files. In addition, any script that logs through a _custom logger category_ writes to its own dedicated file with a `custom-` prefix — **distinct from `customerror`**. Integration and job code (payment gateways, ERP/OMS/CRM syncs, feed and import jobs) almost always logs this way, so the entry you need for a triage is frequently in a `custom-*` file, not in `error`/`customerror`.
+
+Custom log file names follow this pattern:
+
+```
+custom-<prefix>-<hostname>-appserver-<date>.log
+```
+
+The `<prefix>` segment is the **first argument** passed to `Logger.getLogger(prefix, category)` in the emitting code, so it maps a log file straight back to the code that wrote it:
+
+| Code                                              | Log file                        | Filter to read it                  |
+| ------------------------------------------------- | ------------------------------- | ---------------------------------- |
+| `Logger.getLogger('PaymentProcessor', 'payment')` | `custom-PaymentProcessor-*.log` | `--filter custom-PaymentProcessor` |
+| `Logger.getLogger('PimTaxImport', 'tax')`         | `custom-PimTaxImport-*.log`     | `--filter custom-PimTaxImport`     |
+| `Logger.getLogger('orderexport', 'export')`       | `custom-orderexport-*.log`      | `--filter custom-orderexport`      |
+
+(The second argument is the log _category_, used for configuration; it does not appear in the file name.) For the authoring side — how to create these loggers — see the `b2c:b2c-logging` skill.
+
+> **Note:** `--filter` does a **prefix (starts-with) match** on a file's log category, not an exact match — so `--filter custom-` sweeps every `custom-*` file, and `--filter custom-Payment` also matches `custom-PaymentProcessor`. The category is extracted by taking everything up to the _second_ dash, so a custom logger name is treated as word characters only (no dashes): a file named `custom-payment-gateway-*.log` is seen as category `custom-payment`. To read one specific custom log, filter on its full extracted prefix (e.g. `--filter custom-PimTaxImport`); to sweep them all, use `--filter custom-`.
+
+## Discovering Custom Log Files
+
+Because custom log files are not covered by the default `error`/`customerror` retrieval, discover them explicitly when investigating an integration or job:
+
+```bash
+# 1. Enumerate all log files, or narrow to just custom ones
+b2c logs list
+b2c logs list --filter custom
+
+# 2. Scan the output for an unfamiliar custom-* prefix whose size or
+#    last-modified time grew when the incident started, then read it
+b2c logs get --filter custom-PimTaxImport --since 1h
+
+# 3. Read all custom logs at once when you don't yet know the prefix
+b2c logs get --filter custom-
+```
+
+`b2c logs list` reports each file with its size and last-modified timestamp, which is the fastest way to spot the custom logger that lit up during an incident. Once you have the prefix, `--filter custom-<prefix>` (or a bare `--filter custom-` to sweep them all) reads the entries.
+
+If `logs list` output is incomplete or you want to confirm the raw `*.log` filenames on the instance, fall back to WebDAV:
+
+```bash
+# Enumerate log filenames directly over WebDAV
+b2c webdav ls --root logs
+```
+
+## Logs in Subdirectories
+
+The `Logs/` directory contains subdirectories such as `internal/` (e.g. `server`, `ccp`, `health`, `csrf-violations`, `internalquota`). These are **not** listed by default. To reach them, pass a path-like `--filter` (one containing a `/`): the tooling then recurses into that subdirectory and matches files by their path relative to `Logs/`.
+
+```bash
+# All "server" logs under internal/
+b2c logs list --filter internal/server
+
+# Everything under internal/ (trailing slash)
+b2c logs tail --filter internal/
+
+# Mix a subdirectory filter with normal prefix filters
+b2c logs get --filter error --filter internal/server
+```
+
+This works the same across `logs list`, `logs get`, and `logs tail` (and the equivalent MCP tools).
+
+## More Commands
+
+See `b2c logs --help` for all available commands and options.
+
+## Related Skills
+
+- `b2c-cli:b2c-webdav` - Direct WebDAV file access for downloading full log files
+- `b2c-cli:b2c-config` - Verify configuration and credentials
+- `b2c:b2c-logging` - Authoring side: how server-side code creates custom logger categories that produce `custom-*` log files

package/node_modules/@salesforce/b2c-agent-plugins/b2c-cli/skills/b2c-logs/evals/trigger-evals.json

@@ -0,0 +1,12 @@
+[
+  {"query": "Our checkout started throwing 500 errors about an hour ago on the sandbox. Can you pull the recent error logs so we can see what's going wrong?", "should_trigger": true},
+  {"query": "I'm debugging a custom controller and I want to watch the server logs in real time as I hit the endpoint. Is there a way to stream them from the terminal?", "should_trigger": true},
+  {"query": "We had a payment processing issue yesterday afternoon. I need to search the logs for PaymentProcessor errors between 2pm and 4pm to find the root cause.", "should_trigger": true},
+  {"query": "Something is intermittently causing a null pointer exception during the order placement flow on staging. I need to grab the last few hundred lines of the error log and filter for anything related to the order pipeline so I can see the full stack trace.", "should_trigger": true},
+  {"query": "I deployed a hotfix 20 minutes ago and I want to verify it's working. Can I tail the custom-error log on our production instance and filter for the specific error code ERR_INVENTORY_SYNC that was showing up before?", "should_trigger": true},
+  {"query": "Our support team reported that a customer got a blank page during checkout around 10:15 AM today. I need to pull the warn and error logs for that time window and look for any exceptions in the shipping calculation code.", "should_trigger": true},
+  {"query": "How do I add error logging calls in my B2C Commerce server-side script? I want to log to a custom log category.", "should_trigger": false},
+  {"query": "I need to configure Winston logging levels and file transports in my Node.js Express application.", "should_trigger": false},
+  {"query": "Is there a way to view server logs directly in Business Manager? I'm looking for the log viewer section in the admin panel.", "should_trigger": false},
+  {"query": "I'm adding a Logger.getLogger('mymodule') call to my script but the log statements aren't showing up. How do I configure the log level for my custom category in the logging preferences?", "should_trigger": false}
+]