Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added LegacyDeveloperDocumentation.pdf
Binary file not shown.
17,576 changes: 17,576 additions & 0 deletions legacydocs.md

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions packages/b2c-cli/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
"@oclif/plugin-version": "^2",
"@salesforce/b2c-tooling-sdk": "workspace:*",
"cliui": "^9.0.1",
"glob": "^13.0.0",
"marked": "^15.0.0",
"marked-terminal": "^7.3.0",
"open": "^11.0.0"
Expand Down
266 changes: 266 additions & 0 deletions packages/b2c-cli/src/commands/pipeline/convert.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,266 @@
/*
* 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 {existsSync} from 'node:fs';
import {writeFile} from 'node:fs/promises';
import {basename, dirname, join, resolve} from 'node:path';
import {Args, Flags, ux} from '@oclif/core';
import {BaseCommand} from '@salesforce/b2c-tooling-sdk/cli';
import {convertPipeline, type ConvertResult} from '@salesforce/b2c-tooling-sdk/operations/pipeline';
import {glob} from 'glob';
import {t} from '../../i18n/index.js';

interface ConvertError {
pipelineName: string;
error: string;
}

interface ConvertResponse {
results: ConvertResult[];
errors: ConvertError[];
totalPipelines: number;
successCount: number;
failureCount: number;
warningCount: number;
}

export default class PipelineConvert extends BaseCommand<typeof PipelineConvert> {
static args = {
input: Args.string({
description: 'Pipeline XML file or glob pattern (e.g., "*.xml" or "pipelines/**/*.xml")',
required: true,
}),
};

static description = t(
'commands.pipeline.convert.description',
'Convert B2C Commerce pipeline XML files to JavaScript controllers',
);

static enableJsonFlag = true;

static examples = [
'<%= config.bin %> <%= command.id %> Account.xml',
'<%= config.bin %> <%= command.id %> Account.xml --output ./controllers',
'<%= config.bin %> <%= command.id %> "pipelines/*.xml" --output ./controllers',
'<%= config.bin %> <%= command.id %> Cart.xml --dry-run',
];

static flags = {
...BaseCommand.baseFlags,
output: Flags.string({
char: 'o',
description: 'Output directory for generated controllers',
}),
'dry-run': Flags.boolean({
description: 'Preview generated code without writing files',
default: false,
}),
'allow-unsupported': Flags.boolean({
description: 'Continue conversion with unsupported pipelets (generates TODO comments instead of failing)',
default: false,
}),
};

protected operations = {
convertPipeline,
};

async run(): Promise<ConvertResponse> {
const {input} = this.args;
const {output, 'dry-run': dryRun, 'allow-unsupported': allowUnsupported} = this.flags;

// Resolve input files
const inputFiles = await this.resolveInputFiles(input);

if (inputFiles.length === 0) {
this.error(
t('commands.pipeline.convert.noFilesFound', 'No pipeline XML files found matching: {{pattern}}', {
pattern: input,
}),
);
}

// Process all files and collect results
const conversionResults = await this.processFiles(inputFiles, output, dryRun, allowUnsupported);

const response: ConvertResponse = {
results: conversionResults.results,
errors: conversionResults.errors,
totalPipelines: inputFiles.length,
successCount: conversionResults.successCount,
failureCount: conversionResults.failureCount,
warningCount: conversionResults.warningCount,
};

if (this.jsonEnabled()) {
return response;
}

if (!dryRun) {
this.log('');
if (conversionResults.failureCount > 0) {
this.log(
t(
'commands.pipeline.convert.summaryWithFailures',
'Converted {{success}} pipeline(s), {{failures}} failed, {{warnings}} warning(s)',
{
success: conversionResults.successCount,
failures: conversionResults.failureCount,
warnings: conversionResults.warningCount,
},
),
);
} else {
this.log(
t('commands.pipeline.convert.summary', 'Converted {{count}} pipeline(s) with {{warnings}} warning(s)', {
count: conversionResults.successCount,
warnings: conversionResults.warningCount,
}),
);
}
}

return response;
}

/**
* Processes a single input file.
*/
private async processFile(
inputFile: string,
output: string | undefined,
dryRun: boolean,
allowUnsupported: boolean,
): Promise<{result?: ConvertResult; success: boolean; error?: ConvertError}> {
const pipelineName = basename(inputFile, '.xml');

if (!dryRun) {
this.log(
t('commands.pipeline.convert.converting', 'Converting {{name}}...', {
name: pipelineName,
}),
);
}

// Determine output path
const outputPath = dryRun
? undefined
: output
? join(output, `${pipelineName}.js`)
: join(dirname(inputFile), `${pipelineName}.js`);

try {
const result = await this.operations.convertPipeline(inputFile, {
outputPath,
dryRun,
allowUnsupported,
});

if (result.warnings.length > 0) {
for (const warning of result.warnings) {
this.warn(warning);
}
}

let success = false;
if (dryRun) {
// In dry-run mode, output the generated code
if (!this.jsonEnabled()) {
ux.stdout(`\n// === ${pipelineName}.js ===\n`);
ux.stdout(result.code);
ux.stdout('\n');
}
success = true;
} else if (outputPath) {
// Write the file
await writeFile(outputPath, result.code, 'utf8');
this.log(
t('commands.pipeline.convert.generated', 'Generated: {{path}}', {
path: outputPath,
}),
);
success = true;
}

return {result, success};
} catch (error) {
const errorMessage = error instanceof Error ? error.message : String(error);
this.logToStderr(
t('commands.pipeline.convert.failed', 'Failed to convert {{name}}: {{error}}', {
name: pipelineName,
error: errorMessage,
}),
);
return {
success: false,
error: {pipelineName, error: errorMessage},
};
}
}

/**
* Processes all input files and returns results.
*/
private async processFiles(
inputFiles: string[],
output: string | undefined,
dryRun: boolean,
allowUnsupported: boolean,
): Promise<{
results: ConvertResult[];
errors: ConvertError[];
successCount: number;
failureCount: number;
warningCount: number;
}> {
const results: ConvertResult[] = [];
const errors: ConvertError[] = [];
let successCount = 0;
let failureCount = 0;
let warningCount = 0;

// Process files sequentially to maintain order and avoid concurrent file operations
for (const inputFile of inputFiles) {
// eslint-disable-next-line no-await-in-loop
const fileResult = await this.processFile(inputFile, output, dryRun, allowUnsupported);
if (fileResult.result) {
results.push(fileResult.result);
warningCount += fileResult.result.warnings.length;
}
if (fileResult.error) {
errors.push(fileResult.error);
failureCount++;
}
if (fileResult.success) {
successCount++;
}
}

return {results, errors, successCount, failureCount, warningCount};
}

/**
* Resolves input pattern to list of files.
*/
private async resolveInputFiles(pattern: string): Promise<string[]> {
const resolvedPattern = resolve(pattern);

// Check if it's a direct file path
if (existsSync(resolvedPattern) && resolvedPattern.endsWith('.xml')) {
return [resolvedPattern];
}

// Otherwise treat as glob pattern
const files = await glob(pattern, {
absolute: true,
nodir: true,
});

// Filter to only XML files
return files.filter((f) => f.endsWith('.xml'));
}
}
8 changes: 7 additions & 1 deletion packages/b2c-tooling-sdk/.c8rc.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
{
"all": true,
"src": ["src"],
"exclude": ["src/clients/*.generated.ts", "test/**", "**/*.d.ts", "src/**/*types.ts"],
"exclude": [
"src/clients/*.generated.ts",
"test/**",
"**/*.d.ts",
"src/**/*types.ts",
"src/operations/pipeline/generator/pipelets/**"
],
"reporter": ["text", "text-summary", "html", "lcov"],
"report-dir": "coverage",
"check-coverage": true,
Expand Down
77 changes: 77 additions & 0 deletions packages/b2c-tooling-sdk/debug-getproduct.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
import { parsePipeline, analyzePipeline } from './src/operations/pipeline/index.js';
import * as fs from 'fs';

const xml = fs.readFileSync('/Users/clavery/code/sitegenesis/app_storefront_pipelines/cartridge/pipelines/Product.xml', 'utf-8');

async function main() {
const pipeline = await parsePipeline(xml, 'Product');

// Find GetProduct start node
let getProductStartId: string | undefined;
for (const [id, node] of pipeline.nodes) {
if (node.type === 'start' && node.name === 'GetProduct') {
getProductStartId = id;
console.log('GetProduct start node:', id);
console.log(' transitions:', JSON.stringify(node.transitions, null, 2));
break;
}
}

// Trace the path from GetProduct start
if (getProductStartId) {
console.log('\n=== Tracing GetProduct path ===');
let currentId = getProductStartId;
const visited = new Set<string>();

while (currentId && !visited.has(currentId)) {
visited.add(currentId);
const node = pipeline.nodes.get(currentId);
if (!node) break;

console.log(`\nNode ${currentId}: ${node.type}`);
if (node.type === 'decision') {
console.log(' condition:', (node as any).condition);
}
if (node.type === 'pipelet') {
console.log(' pipeletName:', (node as any).pipeletName);
console.log(' hasErrorBranch:', (node as any).hasErrorBranch);
}
if (node.type === 'interaction') {
console.log(' template:', (node as any).templateName);
}
if (node.type === 'end') {
console.log(' name:', (node as any).name);
}
console.log(' transitions:', JSON.stringify(node.transitions, null, 2));

// Follow first/default transition
currentId = node.transitions[0]?.targetId;
}
}

// Find all interaction nodes with error/notfound
console.log('\n=== Interaction nodes with error/notfound ===');
for (const [id, node] of pipeline.nodes) {
if (node.type === 'interaction' && (node as any).templateName === 'error/notfound') {
console.log('Found error/notfound:', id);
// Find what leads to this node
for (const [srcId, srcNode] of pipeline.nodes) {
for (const t of srcNode.transitions) {
if (t.targetId === id) {
console.log(` <- from ${srcId} (${srcNode.type})`);
}
}
}
}
}

// Run analysis
console.log('\n=== Analysis ===');
const analysis = analyzePipeline(pipeline);
console.log('Total warnings:', analysis.warnings.length);
for (const w of analysis.warnings) {
console.log(' ', w);
}
}

main().catch(console.error);
Loading
Loading