@salesforce/storefront-next-dev 0.1.1 → 0.2.0-alpha.1

package/dist/cartridge-services/index.js

@@ -1,8 +1,5 @@
-import fs from "fs";
-import path, { extname } from "path";
-import archiver from "archiver";
 import { access, mkdir, readFile, readdir, rm, writeFile } from "node:fs/promises";
-import { basename, extname as extname$1, join, resolve } from "node:path";
+import { basename, extname, join, resolve } from "node:path";
 import { execSync } from "node:child_process";
 import { Node, Project } from "ts-morph";
 import { existsSync, readFileSync, unlinkSync } from "node:fs";
@@ -10,336 +7,6 @@ import { tmpdir } from "node:os";
 import { randomUUID } from "node:crypto";
 import { npmRunPathEnv } from "npm-run-path";
 
-//#region src/cartridge-services/types.ts
-const WEBDAV_BASE = "/on/demandware.servlet/webdav/Sites";
-const CARTRIDGES_PATH = "Cartridges";
-const HTTP_METHODS = {
-	PUT: "PUT",
-	POST: "POST",
-	DELETE: "DELETE"
-};
-const CONTENT_TYPES = {
-	APPLICATION_ZIP: "application/zip",
-	APPLICATION_FORM_URLENCODED: "application/x-www-form-urlencoded",
-	APPLICATION_JSON: "application/json"
-};
-const WEBDAV_OPERATIONS = {
-	UNZIP: "UNZIP",
-	TARGET_CARTRIDGES: "cartridges"
-};
-
-//#endregion
-//#region src/cartridge-services/sfcc-client.ts
-/**
-* Create HTTP request options for WebDAV operations (file upload/download)
-*
-* @param instance - The Commerce Cloud instance hostname
-* @param path - The WebDAV path (e.g., '/cartridges')
-* @param basicAuth - Base64 encoded basic authentication credentials (required)
-* @param method - HTTP method (PUT, DELETE, UNZIP, etc.)
-* @param formData - Optional form data for the request
-* @returns Configured HTTP request options for WebDAV operations
-*/
-function getWebdavOptions(instance, path$1, basicAuth, method, formData) {
-	const endpoint = `${WEBDAV_BASE}/${path$1}`;
-	return {
-		baseUrl: `https://${instance}`,
-		uri: endpoint,
-		auth: { basic: basicAuth },
-		method,
-		...formData && { form: formData }
-	};
-}
-/**
-* Check if an HTTP response indicates an authentication error and throw if so
-*
-* @param response - The HTTP response to check
-* @throws Error with authentication message if status code is 401
-*/
-function checkAuthenticationError(response) {
-	if (response.statusCode === 401) throw new Error("Authentication failed. Please login again.");
-}
-/**
-* Execute an HTTP request using the native fetch API with default SSL validation
-*
-* This function handles general HTTP requests and does not automatically set Content-Type headers.
-* Callers must set the appropriate Content-Type header in opts.headers based on their body type
-*
-* @param opts - HTTP request configuration including URL, method, headers, and body
-* @returns Promise resolving to an object containing the HTTP response and parsed body
-* @throws Error if the HTTP request fails or cannot be completed
-*/
-async function makeRequest(opts) {
-	const url = opts.uri;
-	const fetchOptions = {
-		...opts,
-		headers: {
-			Authorization: `Basic ${opts.auth.basic}`,
-			...opts.headers
-		}
-	};
-	if (opts.form) {
-		const formData = new URLSearchParams();
-		Object.entries(opts.form).forEach(([key, value]) => {
-			formData.append(key, String(value));
-		});
-		fetchOptions.body = formData;
-		fetchOptions.headers = {
-			...fetchOptions.headers,
-			"Content-Type": CONTENT_TYPES.APPLICATION_FORM_URLENCODED
-		};
-	}
-	try {
-		const response = await fetch(url, fetchOptions);
-		const body = response.headers.get("content-type")?.includes(CONTENT_TYPES.APPLICATION_JSON) ? await response.json() : await response.text();
-		const headers = {};
-		response.headers.forEach((value, key) => {
-			headers[key] = value;
-		});
-		return {
-			response: {
-				statusCode: response.status,
-				statusMessage: response.statusText,
-				headers
-			},
-			body
-		};
-	} catch (error) {
-		throw new Error(`HTTP request failed: ${error instanceof Error ? error.message : String(error)}`);
-	}
-}
-
-//#endregion
-//#region src/cartridge-services/validation.ts
-/**
-* Validation error class for cartridge service parameter validation
-*/
-var ValidationError = class extends Error {
-	constructor(message) {
-		super(message);
-		this.name = "ValidationError";
-	}
-};
-/**
-* Validate Commerce Cloud instance hostname
-*
-* @param instance - The instance hostname to validate
-* @throws ValidationError if instance is invalid
-*/
-function validateInstance(instance) {
-	if (!instance || typeof instance !== "string") throw new ValidationError("Instance parameter is required and must be a string");
-	if (instance.trim().length === 0) throw new ValidationError("Instance parameter cannot be empty");
-	if (!instance.includes(".")) throw new ValidationError("Parameter instance must be a valid domain name");
-}
-/**
-* Validate cartridge file (must be a ZIP file)
-*
-* @param cartridgePath - The cartridge file path to validate
-* @throws ValidationError if cartridge is invalid
-*/
-function validateCartridgePath(cartridgePath) {
-	if (!cartridgePath || typeof cartridgePath !== "string") throw new ValidationError("cartridge parameter is required and must be a string");
-	if (cartridgePath.trim().length === 0) throw new ValidationError("cartridge parameter cannot be empty");
-	const ext = extname(cartridgePath).toLowerCase();
-	if (ext !== "") throw new ValidationError(`cartridge must be a directory, got: ${ext}`);
-}
-/**
-* Validate Basic Auth credentials
-*
-* @param basicAuth - The base64 encoded basic auth credentials to validate
-* @throws ValidationError if credentials are invalid
-*/
-function validateBasicAuth(basicAuth) {
-	if (!basicAuth || typeof basicAuth !== "string") throw new ValidationError("Basic auth credentials parameter is required and must be a string");
-	if (basicAuth.trim().length === 0) throw new ValidationError("Basic auth credentials parameter cannot be empty");
-	if (basicAuth.length < 10) throw new ValidationError("Basic auth credentials appear to be too short to be valid");
-}
-/**
-* Validate code version name
-*
-* @param version - The code version name to validate
-* @throws ValidationError if version is invalid
-*/
-function validateVersion(version) {
-	if (!version || typeof version !== "string") throw new ValidationError("Version parameter is required and must be a string");
-	if (version.trim().length === 0) throw new ValidationError("Version parameter cannot be empty");
-	if (!/^[a-zA-Z0-9._-]+$/.test(version)) throw new ValidationError("Version parameter contains invalid characters. Only alphanumeric, dots, hyphens, and underscores are allowed");
-}
-/**
-* Validate WebDAV path
-*
-* @param webdavPath - The WebDAV path to validate
-* @throws ValidationError if path is invalid
-*/
-function validateWebdavPath(webdavPath) {
-	if (!webdavPath || typeof webdavPath !== "string") throw new ValidationError("WebDAV path parameter is required and must be a string");
-	if (!webdavPath.startsWith("/")) throw new ValidationError("WebDAV path must start with a forward slash");
-}
-/**
-* Validate all parameters for deployCode function
-*
-* @param instance - Commerce Cloud instance hostname
-* @param codeVersionName - Target code version name
-* @param cartridgeDirectoryPath - Path to the source directory
-* @param basicAuth - Base64 encoded basic auth credentials
-* @param cartridgeWebDevPath - WebDAV path for cartridge deployment
-* @throws ValidationError if any parameter is invalid
-*/
-function validateDeployCodeParams(instance, codeVersionName, cartridgeDirectoryPath, basicAuth, cartridgeWebDevPath) {
-	validateInstance(instance);
-	validateVersion(codeVersionName);
-	validateCartridgePath(cartridgeDirectoryPath);
-	validateBasicAuth(basicAuth);
-	validateWebdavPath(cartridgeWebDevPath);
-}
-
-//#endregion
-//#region src/cartridge-services/deploy-cartridge.ts
-/**
-* Extract the filename (including extension) from a file path
-*
-* @param filePath - The full path to the file
-* @returns The filename portion of the path (e.g., 'archive.zip' from '/path/to/archive.zip')
-*/
-function getFilename(filePath) {
-	return path.basename(filePath);
-}
-/**
-* Create a ZIP cartridge from a directory
-*
-* @param sourceDir - The directory to zip
-* @param outputPath - The output ZIP file path (can be same as sourceDir)
-* @returns Promise resolving when the ZIP file is created
-*/
-async function zipCartridge(sourceDir, outputPath) {
-	const archive = archiver("zip", { zlib: { level: 9 } });
-	const output = fs.createWriteStream(outputPath);
-	archive.pipe(output);
-	archive.directory(sourceDir, false);
-	await archive.finalize();
-}
-/**
-* Build the WebDAV endpoint URL for a file
-*
-* @param instance - The Commerce Cloud instance hostname
-* @param path - The WebDAV path (e.g., 'Cartridges/local_metadata')
-* @param file - The local file path (filename will be extracted)
-* @returns The complete WebDAV endpoint URL
-*/
-function buildWebdavEndpoint(instance, webdavPath, file) {
-	return `https://${instance}${WEBDAV_BASE}/${webdavPath}/${getFilename(file)}`;
-}
-/**
-* Unzip an uploaded archive file on Commerce Cloud via WebDAV
-*
-* @param instance - The Commerce Cloud instance hostname
-* @param path - The WebDAV path where the file was uploaded
-* @param file - The local file path (used to determine the remote filename)
-* @param basicAuth - Base64 encoded basic authentication credentials
-* @returns Promise resolving to HTTP response and body from the unzip operation
-*/
-async function unzip(instance, webdavPath, file, basicAuth) {
-	const endpoint = buildWebdavEndpoint(instance, webdavPath, file);
-	const opts = getWebdavOptions(instance, webdavPath, basicAuth, HTTP_METHODS.POST, {
-		method: WEBDAV_OPERATIONS.UNZIP,
-		target: WEBDAV_OPERATIONS.TARGET_CARTRIDGES
-	});
-	opts.uri = endpoint;
-	const result = await makeRequest(opts);
-	checkAuthenticationError(result.response);
-	return result;
-}
-/**
-* Delete a file from Commerce Cloud via WebDAV
-*
-* @param instance - The Commerce Cloud instance hostname
-* @param path - The WebDAV path where the file is located
-* @param file - The local file path (used to determine the remote filename)
-* @param basicAuth - Base64 encoded basic authentication credentials
-* @returns Promise resolving to HTTP response and body from the delete operation
-*/
-async function deleteFile(instance, webdavPath, file, basicAuth) {
-	const endpoint = buildWebdavEndpoint(instance, webdavPath, file);
-	const opts = getWebdavOptions(instance, webdavPath, basicAuth, HTTP_METHODS.DELETE);
-	opts.uri = endpoint;
-	const result = await makeRequest(opts);
-	checkAuthenticationError(result.response);
-	return result;
-}
-/**
-* Upload a file to a specific cartridge version on Commerce Cloud via WebDAV (internal function)
-*
-* @param instance - The Commerce Cloud instance hostname
-* @param codeVersionName - The target code version name
-* @param filePath - The local file path to upload
-* @param basicAuth - Base64 encoded basic authentication credentials
-* @returns Promise resolving to HTTP response and body from the upload operation
-*/
-async function postFile(instance, codeVersionName, filePath, basicAuth) {
-	const targetPath = `${CARTRIDGES_PATH}/${codeVersionName}`;
-	try {
-		const endpoint = buildWebdavEndpoint(instance, targetPath, filePath);
-		const opts = getWebdavOptions(instance, targetPath, basicAuth, HTTP_METHODS.PUT);
-		opts.uri = endpoint;
-		opts.body = fs.createReadStream(filePath);
-		opts.duplex = "half";
-		opts.headers = {
-			...opts.headers,
-			"Content-Type": CONTENT_TYPES.APPLICATION_ZIP
-		};
-		const result = await makeRequest(opts);
-		checkAuthenticationError(result.response);
-		if (![
-			200,
-			201,
-			204
-		].includes(result.response.statusCode)) throw new Error(`Post file "${filePath}" failed: ${result.response.statusCode} (${result.response.statusMessage})`);
-		return result;
-	} catch (error) {
-		throw new Error(`Post file "${filePath}" failed: ${error instanceof Error ? error.message : String(error)}`);
-	}
-}
-/**
-* Deploy code to Commerce Cloud by uploading, unzipping, and cleaning up
-*
-* This function performs a complete code deployment workflow:
-* 1. Uploads the archive file via WebDAV to the specified cartridge version
-* 2. Unzips the archive on the server
-* 3. Deletes the uploaded archive file
-* 4. Returns the deployed version name
-*
-* @param instance - The Commerce Cloud instance hostname
-* @param codeVersionName - The target code version name
-* @param sourceDir - The local directory containing the source files to deploy
-* @param basicAuth - Base64 encoded basic authentication credentials
-* @returns Promise resolving to deployment result with the version name
-* @throws Error if any step of the deployment process fails
-*/
-async function deployCode(instance, codeVersionName, sourceDir, basicAuth) {
-	validateDeployCodeParams(instance, codeVersionName, sourceDir, basicAuth, `/${CARTRIDGES_PATH}/${codeVersionName}/cartridges`);
-	const tempZipPath = path.join(path.dirname(sourceDir), `metadata-${Date.now()}.zip`);
-	try {
-		await zipCartridge(sourceDir, tempZipPath);
-		const file = path.basename(tempZipPath);
-		await postFile(instance, codeVersionName, tempZipPath, basicAuth);
-		const unzipResult = await unzip(instance, `${CARTRIDGES_PATH}/${codeVersionName}`, file, basicAuth);
-		if (![
-			200,
-			201,
-			202
-		].includes(unzipResult.response.statusCode)) throw new Error(`Deploy code ${file} failed (unzip step): ${unzipResult.response.statusCode} (${unzipResult.response.statusMessage})`);
-		const deleteResult = await deleteFile(instance, `${CARTRIDGES_PATH}/${codeVersionName}`, file, basicAuth);
-		if (![200, 204].includes(deleteResult.response.statusCode)) throw new Error(`Delete ZIP file ${file} after deployment failed (deleteFile step): ${deleteResult.response.statusCode} (${deleteResult.response.statusMessage})`);
-		return { version: getFilename(file).replace(".zip", "") };
-	} catch (error) {
-		if (error instanceof Error) throw error;
-		throw new Error(`Deploy code ${sourceDir} failed: ${String(error)}`);
-	} finally {
-		if (fs.existsSync(tempZipPath)) fs.unlinkSync(tempZipPath);
-	}
-}
-
-//#endregion
 //#region src/cartridge-services/react-router-config.ts
 let isCliAvailable = null;
 function checkReactRouterCli(projectDirectory) {
@@ -892,7 +559,7 @@ async function generateMetadata(projectDirectory, metadataDirectory, options) {
 					const fullPath = join(dir, entry.name);
 					if (entry.isDirectory()) {
 						if (!SKIP_DIRECTORIES.includes(entry.name)) await scanDirectory(fullPath);
-					} else if (entry.isFile() && (extname$1(entry.name) === ".ts" || extname$1(entry.name) === ".tsx" || extname$1(entry.name) === ".json")) files.push(fullPath);
+					} else if (entry.isFile() && (extname(entry.name) === ".ts" || extname(entry.name) === ".tsx" || extname(entry.name) === ".json")) files.push(fullPath);
 				}
 			};
 			await scanDirectory(srcDir);
@@ -950,5 +617,5 @@ async function generateMetadata(projectDirectory, metadataDirectory, options) {
 }
 
 //#endregion
-export { deployCode, generateMetadata };
+export { generateMetadata };
 //# sourceMappingURL=index.js.map