@salesforce/b2c-cli 0.0.1 → 0.0.7

package/node_modules/@salesforce/b2c-tooling-sdk/dist/esm/operations/jobs/run.js

@@ -0,0 +1,333 @@
+/*
+ * 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
+ */
+/**
+ * Job execution operations for B2C Commerce.
+ *
+ * Provides functions for executing and monitoring jobs on B2C Commerce instances.
+ */
+import { B2CInstance } from '../../instance/index.js';
+import { getLogger } from '../../logging/logger.js';
+/**
+ * Executes a job on a B2C Commerce instance.
+ *
+ * Starts a job execution and returns immediately with the execution details.
+ * Use {@link waitForJob} to wait for completion.
+ *
+ * @param instance - B2C instance to execute on
+ * @param jobId - Job ID to execute
+ * @param options - Execution options
+ * @returns Job execution details
+ * @throws Error if job is already running (when waitForRunning is false)
+ * @throws Error if job not found or cannot be executed
+ *
+ * @example
+ * ```typescript
+ * // Execute a simple job
+ * const execution = await executeJob(instance, 'my-job-id');
+ *
+ * // Execute with parameters
+ * const execution = await executeJob(instance, 'CustomerImportJob', {
+ *   parameters: [
+ *     { name: 'SiteScope', value: '{"all_storefront_sites":true}' }
+ *   ]
+ * });
+ * ```
+ */
+export async function executeJob(instance, jobId, options = {}) {
+    const logger = getLogger();
+    const { parameters = [], body: rawBody, waitForRunning = true } = options;
+    // Build request body - use raw body if provided, otherwise use parameters array
+    let body;
+    if (rawBody) {
+        body = rawBody;
+        logger.debug({ jobId, body }, `Executing job ${jobId} with raw body`);
+    }
+    else if (parameters.length > 0) {
+        body = { parameters };
+        logger.debug({ jobId, parameters }, `Executing job ${jobId} with parameters`);
+    }
+    else {
+        logger.debug({ jobId }, `Executing job ${jobId}`);
+    }
+    const { data, error, response } = await instance.ocapi.POST('/jobs/{job_id}/executions', {
+        params: { path: { job_id: jobId } },
+        body: body,
+    });
+    // Handle JobAlreadyRunningException
+    if (response.status === 400) {
+        // Need to check fault type - read raw response
+        const errorBody = await response.text().catch(() => '');
+        if (errorBody.includes('JobAlreadyRunningException')) {
+            if (waitForRunning) {
+                logger.warn({ jobId }, `Job ${jobId} already running, waiting for it to finish...`);
+                // Search for the running execution
+                const runningExecution = await findRunningJobExecution(instance, jobId);
+                if (runningExecution) {
+                    logger.debug({ jobId, executionId: runningExecution.id }, `Found running execution ${runningExecution.id}`);
+                    await waitForJob(instance, jobId, runningExecution.id);
+                    // Retry execution after the running job finishes
+                    return executeJob(instance, jobId, { ...options, waitForRunning: false });
+                }
+                // Couldn't find running job, try again
+                return executeJob(instance, jobId, { ...options, waitForRunning: false });
+            }
+            throw new Error(`Job ${jobId} is already running`);
+        }
+    }
+    if (error || !data) {
+        const message = error?.fault?.message ?? `Failed to execute job ${jobId}`;
+        throw new Error(message);
+    }
+    logger.debug({ jobId, executionId: data.id, status: data.execution_status }, `Job ${jobId} started: ${data.id}`);
+    return data;
+}
+/**
+ * Gets the current status of a job execution.
+ *
+ * @param instance - B2C instance
+ * @param jobId - Job ID
+ * @param executionId - Execution ID
+ * @returns Current execution status
+ * @throws Error if execution not found
+ *
+ * @example
+ * ```typescript
+ * const status = await getJobExecution(instance, 'my-job', 'exec-123');
+ * console.log(`Status: ${status.execution_status}`);
+ * ```
+ */
+export async function getJobExecution(instance, jobId, executionId) {
+    const { data, error } = await instance.ocapi.GET('/jobs/{job_id}/executions/{id}', {
+        params: { path: { job_id: jobId, id: executionId } },
+    });
+    if (error || !data) {
+        const message = error?.fault?.message ?? `Failed to get job execution ${executionId}`;
+        throw new Error(message);
+    }
+    return data;
+}
+/**
+ * Waits for a job execution to complete.
+ *
+ * Polls the job status until it reaches a terminal state (finished or aborted).
+ *
+ * @param instance - B2C instance
+ * @param jobId - Job ID
+ * @param executionId - Execution ID to wait for
+ * @param options - Wait options
+ * @returns Final execution status
+ * @throws Error if job fails (status ERROR or aborted)
+ * @throws Error if timeout is exceeded
+ *
+ * @example
+ * ```typescript
+ * // Simple wait
+ * const result = await waitForJob(instance, 'my-job', 'exec-123');
+ *
+ * // With progress callback
+ * const result = await waitForJob(instance, 'my-job', 'exec-123', {
+ *   onProgress: (exec, elapsed) => {
+ *     console.log(`Status: ${exec.execution_status}, elapsed: ${elapsed}ms`);
+ *   }
+ * });
+ * ```
+ */
+export async function waitForJob(instance, jobId, executionId, options = {}) {
+    const logger = getLogger();
+    const { pollInterval = 3000, timeout, onProgress } = options;
+    const startTime = Date.now();
+    let ticks = 0;
+    while (true) {
+        await sleep(pollInterval);
+        const elapsed = Date.now() - startTime;
+        if (timeout && elapsed > timeout) {
+            throw new Error(`Timeout waiting for job ${jobId} execution ${executionId}`);
+        }
+        const execution = await getJobExecution(instance, jobId, executionId);
+        // Call progress callback
+        if (onProgress) {
+            onProgress(execution, elapsed);
+        }
+        // Check for terminal states
+        if (execution.execution_status === 'aborted' || execution.exit_status?.code === 'ERROR') {
+            logger.debug({ jobId, executionId, execution }, `Job ${jobId} failed`);
+            throw new JobExecutionError(`Job ${jobId} failed`, execution);
+        }
+        if (execution.execution_status === 'finished') {
+            const durationSec = (execution.duration ?? 0) / 1000;
+            logger.debug({ jobId, executionId, status: execution.exit_status?.code, duration: durationSec }, `Job ${jobId} finished. Status: ${execution.exit_status?.code} (duration: ${durationSec}s)`);
+            return execution;
+        }
+        // Log periodic updates
+        if (ticks % 5 === 0) {
+            logger.debug({ jobId, executionId, status: execution.execution_status, elapsed: elapsed / 1000 }, `Waiting for job ${jobId} to finish (${(elapsed / 1000).toFixed(0)}s elapsed)...`);
+        }
+        ticks++;
+    }
+}
+/**
+ * Error thrown when a job execution fails.
+ */
+export class JobExecutionError extends Error {
+    execution;
+    constructor(message, execution) {
+        super(message);
+        this.execution = execution;
+        this.name = 'JobExecutionError';
+    }
+}
+/**
+ * Extracts the error message from a failed job execution.
+ *
+ * Looks for the last step execution with exit_status code 'ERROR' and returns its message.
+ *
+ * @param execution - The job execution to extract the error message from
+ * @returns The error message if found, undefined otherwise
+ *
+ * @example
+ * ```typescript
+ * const errorMsg = getJobErrorMessage(execution);
+ * if (errorMsg) {
+ *   console.error(`Job failed: ${errorMsg}`);
+ * }
+ * ```
+ */
+export function getJobErrorMessage(execution) {
+    if (!execution.step_executions || execution.step_executions.length === 0) {
+        return undefined;
+    }
+    // Find the last step with ERROR status that has a message
+    for (let i = execution.step_executions.length - 1; i >= 0; i--) {
+        const step = execution.step_executions[i];
+        if (step.exit_status?.code === 'ERROR' && step.exit_status?.message) {
+            return step.exit_status.message;
+        }
+    }
+    return undefined;
+}
+/**
+ * Searches for job executions.
+ *
+ * @param instance - B2C instance
+ * @param options - Search options
+ * @returns Search results
+ *
+ * @example
+ * ```typescript
+ * // Search for all running jobs
+ * const results = await searchJobExecutions(instance, {
+ *   status: ['RUNNING', 'PENDING']
+ * });
+ *
+ * // Search for a specific job's recent executions
+ * const results = await searchJobExecutions(instance, {
+ *   jobId: 'my-job',
+ *   count: 10
+ * });
+ * ```
+ */
+export async function searchJobExecutions(instance, options = {}) {
+    const { jobId, status, count = 25, start = 0, sortBy = 'start_time', sortOrder = 'desc' } = options;
+    // Build query
+    const queries = [];
+    if (jobId) {
+        queries.push({
+            term_query: { fields: ['job_id'], operator: 'is', values: [jobId] },
+        });
+    }
+    if (status) {
+        const statusValues = Array.isArray(status) ? status : [status];
+        queries.push({
+            term_query: { fields: ['status'], operator: 'one_of', values: statusValues },
+        });
+    }
+    // Build the query object
+    let query;
+    if (queries.length === 0) {
+        query = { match_all_query: {} };
+    }
+    else if (queries.length === 1) {
+        query = queries[0];
+    }
+    else {
+        query = { bool_query: { must: queries } };
+    }
+    const { data, error } = await instance.ocapi.POST('/job_execution_search', {
+        body: {
+            query,
+            count,
+            start,
+            sorts: [{ field: sortBy, sort_order: sortOrder }],
+        },
+    });
+    if (error || !data) {
+        const message = error?.fault?.message ?? 'Failed to search job executions';
+        throw new Error(message);
+    }
+    return {
+        total: data.total ?? 0,
+        count: data.count ?? 0,
+        start: data.start ?? 0,
+        hits: (data.hits ?? []),
+    };
+}
+/**
+ * Finds a currently running job execution.
+ *
+ * @param instance - B2C instance
+ * @param jobId - Job ID to search for
+ * @returns Running execution or undefined if none found
+ */
+export async function findRunningJobExecution(instance, jobId) {
+    const results = await searchJobExecutions(instance, {
+        jobId,
+        status: ['RUNNING', 'PENDING'],
+        sortBy: 'start_time',
+        sortOrder: 'asc',
+        count: 1,
+    });
+    return results.hits[0];
+}
+/**
+ * Gets the log file content for a job execution.
+ *
+ * @param instance - B2C instance
+ * @param execution - Job execution with log file path
+ * @returns Log file content as string
+ * @throws Error if log file doesn't exist or cannot be retrieved
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   const result = await waitForJob(instance, 'my-job', 'exec-123');
+ * } catch (error) {
+ *   if (error instanceof JobExecutionError && error.execution.is_log_file_existing) {
+ *     const log = await getJobLog(instance, error.execution);
+ *     console.error('Job log:', log);
+ *   }
+ * }
+ * ```
+ */
+export async function getJobLog(instance, execution) {
+    if (!execution.log_file_path) {
+        throw new Error('No log file path available');
+    }
+    if (!execution.is_log_file_existing) {
+        throw new Error('Log file does not exist');
+    }
+    // log_file_path from OCAPI is "/Sites/LOGS/jobs/..."
+    // WebDAV client base is /webdav/Sites, so strip the leading /Sites/
+    const logPath = execution.log_file_path.replace(/^\/Sites\//, '');
+    const content = await instance.webdav.get(logPath);
+    return new TextDecoder().decode(content);
+}
+/**
+ * Helper function for sleeping.
+ */
+function sleep(ms) {
+    return new Promise((resolve) => setTimeout(resolve, ms));
+}
+//# sourceMappingURL=run.js.map

package/node_modules/@salesforce/b2c-tooling-sdk/dist/esm/operations/jobs/run.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"run.js","sourceRoot":"","sources":["../../../../src/operations/jobs/run.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH;;;;GAIG;AACH,OAAO,EAAC,WAAW,EAAC,MAAM,yBAAyB,CAAC;AAEpD,OAAO,EAAC,SAAS,EAAC,MAAM,yBAAyB,CAAC;AAkDlD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,QAAqB,EACrB,KAAa,EACb,UAA6B,EAAE;IAE/B,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAC3B,MAAM,EAAC,UAAU,GAAG,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,cAAc,GAAG,IAAI,EAAC,GAAG,OAAO,CAAC;IAExE,gFAAgF;IAChF,IAAI,IAAyC,CAAC;IAC9C,IAAI,OAAO,EAAE,CAAC;QACZ,IAAI,GAAG,OAAO,CAAC;QACf,MAAM,CAAC,KAAK,CAAC,EAAC,KAAK,EAAE,IAAI,EAAC,EAAE,iBAAiB,KAAK,gBAAgB,CAAC,CAAC;IACtE,CAAC;SAAM,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACjC,IAAI,GAAG,EAAC,UAAU,EAAC,CAAC;QACpB,MAAM,CAAC,KAAK,CAAC,EAAC,KAAK,EAAE,UAAU,EAAC,EAAE,iBAAiB,KAAK,kBAAkB,CAAC,CAAC;IAC9E,CAAC;SAAM,CAAC;QACN,MAAM,CAAC,KAAK,CAAC,EAAC,KAAK,EAAC,EAAE,iBAAiB,KAAK,EAAE,CAAC,CAAC;IAClD,CAAC;IAED,MAAM,EAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,2BAA2B,EAAE;QACrF,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,MAAM,EAAE,KAAK,EAAC,EAAC;QAC/B,IAAI,EAAE,IAAyB;KAChC,CAAC,CAAC;IAEH,oCAAoC;IACpC,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;QAC5B,+CAA+C;QAC/C,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;QACxD,IAAI,SAAS,CAAC,QAAQ,CAAC,4BAA4B,CAAC,EAAE,CAAC;YACrD,IAAI,cAAc,EAAE,CAAC;gBACnB,MAAM,CAAC,IAAI,CAAC,EAAC,KAAK,EAAC,EAAE,OAAO,KAAK,+CAA+C,CAAC,CAAC;gBAElF,mCAAmC;gBACnC,MAAM,gBAAgB,GAAG,MAAM,uBAAuB,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;gBACxE,IAAI,gBAAgB,EAAE,CAAC;oBACrB,MAAM,CAAC,KAAK,CAAC,EAAC,KAAK,EAAE,WAAW,EAAE,gBAAgB,CAAC,EAAE,EAAC,EAAE,2BAA2B,gBAAgB,CAAC,EAAE,EAAE,CAAC,CAAC;oBAC1G,MAAM,UAAU,CAAC,QAAQ,EAAE,KAAK,EAAE,gBAAgB,CAAC,EAAG,CAAC,CAAC;oBACxD,iDAAiD;oBACjD,OAAO,UAAU,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAC,GAAG,OAAO,EAAE,cAAc,EAAE,KAAK,EAAC,CAAC,CAAC;gBAC1E,CAAC;gBACD,uCAAuC;gBACvC,OAAO,UAAU,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAC,GAAG,OAAO,EAAE,cAAc,EAAE,KAAK,EAAC,CAAC,CAAC;YAC1E,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,OAAO,KAAK,qBAAqB,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;IAED,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;QACnB,MAAM,OAAO,GAAG,KAAK,EAAE,KAAK,EAAE,OAAO,IAAI,yBAAyB,KAAK,EAAE,CAAC;QAC1E,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;IAC3B,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,EAAC,KAAK,EAAE,WAAW,EAAE,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,gBAAgB,EAAC,EAAE,OAAO,KAAK,aAAa,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;IAE/G,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,QAAqB,EACrB,KAAa,EACb,WAAmB;IAEnB,MAAM,EAAC,IAAI,EAAE,KAAK,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,gCAAgC,EAAE;QAC/E,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,WAAW,EAAC,EAAC;KACjD,CAAC,CAAC;IAEH,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;QACnB,MAAM,OAAO,GAAG,KAAK,EAAE,KAAK,EAAE,OAAO,IAAI,+BAA+B,WAAW,EAAE,CAAC;QACtF,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;IAC3B,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,QAAqB,EACrB,KAAa,EACb,WAAmB,EACnB,UAA6B,EAAE;IAE/B,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAC3B,MAAM,EAAC,YAAY,GAAG,IAAI,EAAE,OAAO,EAAE,UAAU,EAAC,GAAG,OAAO,CAAC;IAE3D,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAC7B,IAAI,KAAK,GAAG,CAAC,CAAC;IAEd,OAAO,IAAI,EAAE,CAAC;QACZ,MAAM,KAAK,CAAC,YAAY,CAAC,CAAC;QAE1B,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;QACvC,IAAI,OAAO,IAAI,OAAO,GAAG,OAAO,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,2BAA2B,KAAK,cAAc,WAAW,EAAE,CAAC,CAAC;QAC/E,CAAC;QAED,MAAM,SAAS,GAAG,MAAM,eAAe,CAAC,QAAQ,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;QAEtE,yBAAyB;QACzB,IAAI,UAAU,EAAE,CAAC;YACf,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QACjC,CAAC;QAED,4BAA4B;QAC5B,IAAI,SAAS,CAAC,gBAAgB,KAAK,SAAS,IAAI,SAAS,CAAC,WAAW,EAAE,IAAI,KAAK,OAAO,EAAE,CAAC;YACxF,MAAM,CAAC,KAAK,CAAC,EAAC,KAAK,EAAE,WAAW,EAAE,SAAS,EAAC,EAAE,OAAO,KAAK,SAAS,CAAC,CAAC;YACrE,MAAM,IAAI,iBAAiB,CAAC,OAAO,KAAK,SAAS,EAAE,SAAS,CAAC,CAAC;QAChE,CAAC;QAED,IAAI,SAAS,CAAC,gBAAgB,KAAK,UAAU,EAAE,CAAC;YAC9C,MAAM,WAAW,GAAG,CAAC,SAAS,CAAC,QAAQ,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC;YACrD,MAAM,CAAC,KAAK,CACV,EAAC,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,CAAC,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAC,EAChF,OAAO,KAAK,sBAAsB,SAAS,CAAC,WAAW,EAAE,IAAI,eAAe,WAAW,IAAI,CAC5F,CAAC;YACF,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,uBAAuB;QACvB,IAAI,KAAK,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YACpB,MAAM,CAAC,KAAK,CACV,EAAC,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,CAAC,gBAAgB,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,EAAC,EACjF,mBAAmB,KAAK,eAAe,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAClF,CAAC;QACJ,CAAC;QAED,KAAK,EAAE,CAAC;IACV,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,OAAO,iBAAkB,SAAQ,KAAK;IAGxB;IAFlB,YACE,OAAe,EACC,SAAuB;QAEvC,KAAK,CAAC,OAAO,CAAC,CAAC;QAFC,cAAS,GAAT,SAAS,CAAc;QAGvC,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC;IAClC,CAAC;CACF;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,kBAAkB,CAAC,SAAuB;IACxD,IAAI,CAAC,SAAS,CAAC,eAAe,IAAI,SAAS,CAAC,eAAe,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzE,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,0DAA0D;IAC1D,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QAC/D,MAAM,IAAI,GAAG,SAAS,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QAC1C,IAAI,IAAI,CAAC,WAAW,EAAE,IAAI,KAAK,OAAO,IAAI,IAAI,CAAC,WAAW,EAAE,OAAO,EAAE,CAAC;YACpE,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC;QAClC,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAkCD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,QAAqB,EACrB,UAAsC,EAAE;IAExC,MAAM,EAAC,KAAK,EAAE,MAAM,EAAE,KAAK,GAAG,EAAE,EAAE,KAAK,GAAG,CAAC,EAAE,MAAM,GAAG,YAAY,EAAE,SAAS,GAAG,MAAM,EAAC,GAAG,OAAO,CAAC;IAElG,cAAc;IACd,MAAM,OAAO,GAAc,EAAE,CAAC;IAE9B,IAAI,KAAK,EAAE,CAAC;QACV,OAAO,CAAC,IAAI,CAAC;YACX,UAAU,EAAE,EAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,EAAC;SAClE,CAAC,CAAC;IACL,CAAC;IAED,IAAI,MAAM,EAAE,CAAC;QACX,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QAC/D,OAAO,CAAC,IAAI,CAAC;YACX,UAAU,EAAE,EAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAC;SAC3E,CAAC,CAAC;IACL,CAAC;IAED,yBAAyB;IACzB,IAAI,KAAc,CAAC;IACnB,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,KAAK,GAAG,EAAC,eAAe,EAAE,EAAE,EAAC,CAAC;IAChC,CAAC;SAAM,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAChC,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACrB,CAAC;SAAM,CAAC;QACN,KAAK,GAAG,EAAC,UAAU,EAAE,EAAC,IAAI,EAAE,OAAO,EAAC,EAAC,CAAC;IACxC,CAAC;IAED,MAAM,EAAC,IAAI,EAAE,KAAK,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,uBAAuB,EAAE;QACvE,IAAI,EAAE;YACJ,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK,EAAE,CAAC,EAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAC,CAAC;SACM;KACxD,CAAC,CAAC;IAEH,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;QACnB,MAAM,OAAO,GAAG,KAAK,EAAE,KAAK,EAAE,OAAO,IAAI,iCAAiC,CAAC;QAC3E,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;IAC3B,CAAC;IAED,OAAO;QACL,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,CAAC;QACtB,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,CAAC;QACtB,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,CAAC;QACtB,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAmB;KAC1C,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAAC,QAAqB,EAAE,KAAa;IAChF,MAAM,OAAO,GAAG,MAAM,mBAAmB,CAAC,QAAQ,EAAE;QAClD,KAAK;QACL,MAAM,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC;QAC9B,MAAM,EAAE,YAAY;QACpB,SAAS,EAAE,KAAK;QAChB,KAAK,EAAE,CAAC;KACT,CAAC,CAAC;IAEH,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACzB,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,QAAqB,EAAE,SAAuB;IAC5E,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAChD,CAAC;IAED,IAAI,CAAC,SAAS,CAAC,oBAAoB,EAAE,CAAC;QACpC,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IAED,qDAAqD;IACrD,oEAAoE;IACpE,MAAM,OAAO,GAAG,SAAS,CAAC,aAAa,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;IAElE,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACnD,OAAO,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AAC3C,CAAC;AAED;;GAEG;AACH,SAAS,KAAK,CAAC,EAAU;IACvB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;AAC3D,CAAC"}

package/node_modules/@salesforce/b2c-tooling-sdk/dist/esm/operations/jobs/site-archive.d.ts

@@ -0,0 +1,224 @@
+import { B2CInstance } from '../../instance/index.js';
+import { type JobExecution, type WaitForJobOptions } from './run.js';
+/**
+ * Options for site archive import.
+ */
+export interface SiteArchiveImportOptions {
+    /** Keep archive on instance after import (default: false) */
+    keepArchive?: boolean;
+    /** Wait options for job completion */
+    waitOptions?: WaitForJobOptions;
+}
+/**
+ * Result of a site archive import.
+ */
+export interface SiteArchiveImportResult {
+    /** Job execution details */
+    execution: JobExecution;
+    /** Archive filename on instance */
+    archiveFilename: string;
+    /** Whether archive was kept on instance */
+    archiveKept: boolean;
+}
+/**
+ * Imports a site archive to a B2C Commerce instance.
+ *
+ * Supports importing from:
+ * - A local directory (will be zipped automatically)
+ * - A local zip file
+ * - A Buffer containing zip data
+ * - A filename already on the instance (in Impex/src/instance/)
+ *
+ * @param instance - B2C instance to import to
+ * @param target - Source to import (directory path, zip file path, Buffer, or remote filename)
+ * @param options - Import options
+ * @returns Import result with execution details
+ * @throws JobExecutionError if import job fails
+ *
+ * @example
+ * ```typescript
+ * // Import from a local directory
+ * const result = await siteArchiveImport(instance, './my-site-data');
+ *
+ * // Import from a zip file
+ * const result = await siteArchiveImport(instance, './export.zip');
+ *
+ * // Import from a buffer
+ * const zipBuffer = await fs.promises.readFile('./export.zip');
+ * const result = await siteArchiveImport(instance, zipBuffer, {
+ *   archiveName: 'my-import'
+ * });
+ *
+ * // Import from existing file on instance
+ * const result = await siteArchiveImport(instance, {
+ *   remoteFilename: 'existing-archive.zip'
+ * });
+ * ```
+ */
+export declare function siteArchiveImport(instance: B2CInstance, target: string | Buffer | {
+    remoteFilename: string;
+    archiveName?: string;
+}, options?: SiteArchiveImportOptions & {
+    archiveName?: string;
+}): Promise<SiteArchiveImportResult>;
+/**
+ * Configuration for sites in export.
+ */
+export interface ExportSitesConfiguration {
+    ab_tests?: boolean;
+    active_data_feeds?: boolean;
+    all?: boolean;
+    cache_settings?: boolean;
+    campaigns_and_promotions?: boolean;
+    content?: boolean;
+    coupons?: boolean;
+    custom_objects?: boolean;
+    customer_cdn_settings?: boolean;
+    customer_groups?: boolean;
+    distributed_commerce_extensions?: boolean;
+    dynamic_file_resources?: boolean;
+    gift_certificates?: boolean;
+    ocapi_settings?: boolean;
+    payment_methods?: boolean;
+    payment_processors?: boolean;
+    redirect_urls?: boolean;
+    search_settings?: boolean;
+    shipping?: boolean;
+    site_descriptor?: boolean;
+    site_preferences?: boolean;
+    sitemap_settings?: boolean;
+    slots?: boolean;
+    sorting_rules?: boolean;
+    source_codes?: boolean;
+    static_dynamic_alias_mappings?: boolean;
+    stores?: boolean;
+    tax?: boolean;
+    url_rules?: boolean;
+}
+/**
+ * Configuration for global data in export.
+ */
+export interface ExportGlobalDataConfiguration {
+    access_roles?: boolean;
+    all?: boolean;
+    csc_settings?: boolean;
+    csrf_whitelists?: boolean;
+    custom_preference_groups?: boolean;
+    custom_quota_settings?: boolean;
+    custom_types?: boolean;
+    geolocations?: boolean;
+    global_custom_objects?: boolean;
+    job_schedules?: boolean;
+    job_schedules_deprecated?: boolean;
+    locales?: boolean;
+    meta_data?: boolean;
+    oauth_providers?: boolean;
+    ocapi_settings?: boolean;
+    page_meta_tags?: boolean;
+    preferences?: boolean;
+    price_adjustment_limits?: boolean;
+    services?: boolean;
+    sorting_rules?: boolean;
+    static_resources?: boolean;
+    system_type_definitions?: boolean;
+    users?: boolean;
+    webdav_client_permissions?: boolean;
+}
+/**
+ * Data units configuration for export.
+ */
+export interface ExportDataUnitsConfiguration {
+    /** Catalog static resources to export (catalog_id: true) */
+    catalog_static_resources?: Record<string, boolean>;
+    /** Catalogs to export (catalog_id: true) */
+    catalogs?: Record<string, boolean>;
+    /** Customer lists to export (list_id: true) */
+    customer_lists?: Record<string, boolean>;
+    /** Inventory lists to export (list_id: true) */
+    inventory_lists?: Record<string, boolean>;
+    /** Library static resources to export (library_id: true) */
+    library_static_resources?: Record<string, boolean>;
+    /** Libraries to export (library_id: true) */
+    libraries?: Record<string, boolean>;
+    /** Price books to export (pricebook_id: true) */
+    price_books?: Record<string, boolean>;
+    /** Sites to export (site_id: ExportSitesConfiguration) */
+    sites?: Record<string, Partial<ExportSitesConfiguration> | boolean>;
+    /** Global data to export */
+    global_data?: Partial<ExportGlobalDataConfiguration>;
+}
+/**
+ * Options for site archive export.
+ */
+export interface SiteArchiveExportOptions {
+    /** Keep archive on instance after download (default: false) */
+    keepArchive?: boolean;
+    /** Wait options for job completion */
+    waitOptions?: WaitForJobOptions;
+}
+/**
+ * Result of a site archive export.
+ */
+export interface SiteArchiveExportResult {
+    /** Job execution details */
+    execution: JobExecution;
+    /** Archive filename on instance */
+    archiveFilename: string;
+    /** Archive content as buffer (if downloaded) */
+    data?: Buffer;
+    /** Whether archive was kept on instance */
+    archiveKept: boolean;
+}
+/**
+ * Exports a site archive from a B2C Commerce instance.
+ *
+ * @param instance - B2C instance to export from
+ * @param dataUnits - Data units configuration specifying what to export
+ * @param options - Export options
+ * @returns Export result with archive data
+ * @throws JobExecutionError if export job fails
+ *
+ * @example
+ * ```typescript
+ * // Export global meta data
+ * const result = await siteArchiveExport(instance, {
+ *   global_data: { meta_data: true }
+ * });
+ *
+ * // Export a site's content
+ * const result = await siteArchiveExport(instance, {
+ *   sites: {
+ *     'RefArch': { content: true, site_preferences: true }
+ *   }
+ * });
+ *
+ * // Export catalogs
+ * const result = await siteArchiveExport(instance, {
+ *   catalogs: { 'storefront-catalog': true }
+ * });
+ * ```
+ */
+export declare function siteArchiveExport(instance: B2CInstance, dataUnits: Partial<ExportDataUnitsConfiguration>, options?: SiteArchiveExportOptions): Promise<SiteArchiveExportResult>;
+/**
+ * Exports a site archive and saves it to a local path.
+ *
+ * @param instance - B2C instance to export from
+ * @param dataUnits - Data units configuration
+ * @param outputPath - Local path to save the archive
+ * @param options - Export options
+ * @returns Export result
+ *
+ * @example
+ * ```typescript
+ * // Export and save to a directory (extracts zip)
+ * await siteArchiveExportToPath(instance, { global_data: { meta_data: true } }, './exports');
+ *
+ * // Export and save as zip
+ * await siteArchiveExportToPath(instance, { global_data: { meta_data: true } }, './exports/archive.zip');
+ * ```
+ */
+export declare function siteArchiveExportToPath(instance: B2CInstance, dataUnits: Partial<ExportDataUnitsConfiguration>, outputPath: string, options?: SiteArchiveExportOptions & {
+    extractZip?: boolean;
+}): Promise<SiteArchiveExportResult & {
+    localPath: string;
+}>;