@vention/vention-cli 0.6.0 → 0.7.0

package/README.md

@@ -1,6 +1,6 @@
 # @vention/vention-cli
 
-A command-line interface tool to interact with MachineCode applications from your local setup
+A command-line interface Tool to interact with MachineCode applications from your local setup
 
 ## Installation
 

package/cli.esm.js

@@ -165,6 +165,9 @@ const shouldIgnoreFileSystemNode = (nodeName, ignoredNodes) => {
     }
     return false;
 };
+const getSafeAppName = (appName) => {
+    return appName.replace(/[^a-zA-Z0-9-_]/g, "_");
+};
 const serializeFileSystem = (sourceDirectory, ignoredFileSystemNodes, shouldBase64Encoded) => {
     const fileSystemNode = {};
     const directoryContents = fs.readdirSync(sourceDirectory);
@@ -228,12 +231,17 @@ const checkIfDirectoryExists = async (directory) => {
         .catch(() => false);
     return exists;
 };
+const checkIfAppDirectoryExists = async (appName, targetDirectory) => {
+    const safeAppName = appName.replace(/[^a-zA-Z0-9-_]/g, "_");
+    const appDirectoryPath = path.join(targetDirectory, safeAppName);
+    return await checkIfDirectoryExists(appDirectoryPath);
+};
 const writeApplicationToDisk = async (appName, sourceCode, targetDirectory, overwriteExisting = false) => {
     if (overwriteExisting) {
         await createFileSystemFromJson(sourceCode, targetDirectory);
         return targetDirectory;
     }
-    const safeAppName = appName.replace(/[^a-zA-Z0-9-_]/g, "_");
+    const safeAppName = getSafeAppName(appName);
     const appDirectoryPath = path.join(targetDirectory, safeAppName);
     await createFileSystemFromJson(sourceCode, appDirectoryPath);
     return appDirectoryPath;
@@ -249,6 +257,7 @@ const getAppFromDigitalTwin = async (session, appId, appName) => {
     const allApplications = await getAllApplicationsWithSourceCode(session);
     const targetApp = allApplications.find((app) => app.id === appId);
     if (!targetApp) {
+        console.log();
         console.error(chalk.red(`Application "${appName}" (ID: ${appId}) not found in the digital twin.`));
         process.exit(1);
     }
@@ -264,14 +273,17 @@ const createNewAppDirectory = async (session, currentDir) => {
         process.exit(1);
     }
     const linkedAllocation = await checkIfDesignHasLiveAllocation(session, session.linkedDesignId);
+    console.log();
     console.log(chalk.blue(`You are currently linked to design: ${linkedAllocation === null || linkedAllocation === void 0 ? void 0 : linkedAllocation.designName}`));
     if (!linkedAllocation) {
+        console.log();
         console.error(chalk.red("Sorry, it seems you do not have that design open with the MachineLogic tab selected."));
         console.error(chalk.red("Please go to your browser, open your design, and navigate to the MachineLogic page."));
         process.exit(1);
     }
     const availableApps = await getAvailableAppsFromDigitalTwin(session);
     if (availableApps.length === 0) {
+        console.log();
         console.log(chalk.yellow("No machine code applications found in the digital twin"));
         process.exit(1);
     }
@@ -282,11 +294,22 @@ const createNewAppDirectory = async (session, currentDir) => {
             value: app,
         })),
     });
+    console.log();
     console.log(chalk.blue(`\nPulling application "${selectedApp.name}"...`));
     if (!selectedApp.sourceCode) {
+        console.log();
         console.log(chalk.yellow("No source code found for this application."));
         process.exit(1);
     }
+    const appDirectoryExists = await checkIfAppDirectoryExists(selectedApp.name, currentDir);
+    const safeAppName = getSafeAppName(selectedApp.name);
+    if (appDirectoryExists) {
+        console.log();
+        console.error(chalk.red(`You already have a directory with name "${safeAppName}" here.`));
+        console.error(chalk.red("If that is the machine code app you are trying to pull, please navigate to the root folder of the app and run the 'vention pull' command from there."));
+        console.error(chalk.red("If not, please rename that directory and try again."));
+        process.exit(1);
+    }
     const appDirectoryPath = await writeApplicationToDisk(selectedApp.name, selectedApp.sourceCode, currentDir);
     await writeMachineCodeAppDirectoryInfo(appDirectoryPath, {
         appName: selectedApp.name,
@@ -296,9 +319,10 @@ const createNewAppDirectory = async (session, currentDir) => {
         environment: session.environment,
         uuid: selectedApp.uuid,
     });
+    console.log();
     console.log(chalk.green(`✅ Successfully pulled "${selectedApp.name}" to: ${appDirectoryPath}`));
     console.log(chalk.blue(`📁 To navigate to your project, run:`));
-    console.log(chalk.cyan(`cd "${appDirectoryPath}"`));
+    console.log(chalk.cyan(`cd "${safeAppName}"`));
     console.log(chalk.blue("💡 You can now start working on your application!"));
 };
 const updateExistingAppDirectory = async (session, projectState, currentDir) => {
@@ -306,6 +330,7 @@ const updateExistingAppDirectory = async (session, projectState, currentDir) =>
     console.log(chalk.blue(`Design ID: ${projectState.designId}, App ID: ${projectState.applicationId}`));
     const linkedAllocation = await checkIfDesignHasLiveAllocation(session, projectState.designId);
     if (!linkedAllocation) {
+        console.log();
         console.error(chalk.red("Sorry, it seems you do not have that design open with the MachineLogic tab selected."));
         console.error(chalk.red("Please go to your browser, open your design, and navigate to the MachineLogic page."));
         process.exit(1);
@@ -314,6 +339,7 @@ const updateExistingAppDirectory = async (session, projectState, currentDir) =>
     const appWithSourceCode = await getAppFromDigitalTwin(session, projectState.applicationId, projectState.appName);
     await writeApplicationToDisk(appWithSourceCode.name, appWithSourceCode.sourceCode, currentDir, true);
     await writeMachineCodeAppDirectoryInfo(currentDir, Object.assign(Object.assign({}, projectState), { lastPulledAt: new Date().toISOString() }));
+    console.log();
     console.log(chalk.green(`✅ Successfully pulled "${appWithSourceCode.name}" to: ${currentDir}`));
     console.log(chalk.blue("💡 Your project has been updated with the latest changes!"));
 };
@@ -354,9 +380,11 @@ program
             : undefined;
         await saveSession(Object.assign({ environment,
             ventionSession }, (environment !== "local" ? { stytchSessionJwt, ventionIdpSession } : {})));
+        console.log();
         console.log(chalk.green("Successfully logged in!"));
     }
     catch (error) {
+        console.log();
         console.error(chalk.red("Login failed:"), error);
         process.exit(1);
     }
@@ -373,6 +401,7 @@ program
         }
         const allocations = await getUserAllocations(session);
         if (allocations.length === 0) {
+            console.log();
             console.log(chalk.yellow("No active allocations found. Please open a design and navigate to the machine logic tab to activate a digital twin."));
             process.exit(1);
         }
@@ -384,9 +413,11 @@ program
             })),
         });
         await saveSession(Object.assign(Object.assign({}, session), { linkedDesignId: selectedDesign.id, linkedSessionToken: selectedDesign.sessionId }));
+        console.log();
         console.log(chalk.green(`\nSuccessfully linked to design "${selectedDesign.name}" (ID: ${selectedDesign.id})`));
     }
     catch (error) {
+        console.log();
         console.error(chalk.red("Failed to get allocations:"));
         console.error(chalk.red(`Error: ${error instanceof Error ? error.message : String(error)}`));
         process.exit(1);
@@ -409,14 +440,17 @@ program
         const allocations = await getUserAllocations(session);
         const linkedAllocation = allocations.find(a => a.designId === session.linkedDesignId);
         if (!linkedAllocation) {
+            console.log();
             console.error(chalk.red("Linked design is not currently allocated. Please check if the digital twin is running."));
             process.exit(1);
         }
         const digitalTwinResponse = await makeTestRequestToLinkedDigitalTwin(session);
+        console.log();
         console.log(chalk.green("Digital twin response:"));
         console.log(chalk.green(JSON.stringify(digitalTwinResponse, null, 2)));
     }
     catch (error) {
+        console.log();
         console.error(chalk.red("Failed to get digital twin response:"));
         console.error(chalk.red(`Error: ${error instanceof Error ? error.message : String(error)}`));
         process.exit(1);
@@ -443,6 +477,7 @@ program
         }
     }
     catch (error) {
+        console.log();
         console.error(chalk.red("Failed to pull application:"));
         console.error(chalk.red(`Error: ${error instanceof Error ? error.message : String(error)}`));
         process.exit(1);
@@ -461,19 +496,23 @@ program
         const currentDir = process.cwd();
         const machineCodeAppDirectoryInfo = await readMachineCodeAppDirectoryInfo(currentDir);
         if (!machineCodeAppDirectoryInfo) {
+            console.log();
             console.error(chalk.red("Not in a machine code application directory. Please run 'vention pull' first to create a project."));
             console.error(chalk.red("Make sure you are in the root directory of a machine code application you have created using the 'vention pull' command."));
             process.exit(1);
         }
+        console.log();
         console.log(chalk.blue(`Pushing changes for project: ${machineCodeAppDirectoryInfo.appName}`));
         console.log(chalk.blue(`Design ID: ${machineCodeAppDirectoryInfo.designId}, App ID: ${machineCodeAppDirectoryInfo.applicationId}`));
         const linkedAllocation = await checkIfDesignHasLiveAllocation(session, machineCodeAppDirectoryInfo.designId);
         if (!linkedAllocation) {
+            console.log();
             console.error(chalk.red("Sorry, it seems you do not have that design open with the MachineLogic tab selected."));
             console.error(chalk.red("Please go to your browser, open your design, and navigate to the MachineLogic page."));
             process.exit(1);
         }
         await saveSession(Object.assign(Object.assign({}, session), { linkedDesignId: machineCodeAppDirectoryInfo.designId, linkedSessionToken: linkedAllocation.sessionId }));
+        console.log();
         console.log(chalk.blue("Serializing local files..."));
         const ignorePatterns = getDefaultIgnorePatterns();
         const serializedSourceCode = serializeFileSystem(currentDir, ignorePatterns, true);
@@ -487,10 +526,12 @@ program
         console.log(chalk.blue("Pushing to digital twin..."));
         await pushApplicationToDigitalTwin(session, applicationToPush);
         await writeMachineCodeAppDirectoryInfo(currentDir, Object.assign(Object.assign({}, machineCodeAppDirectoryInfo), { lastPushedAt: new Date().toISOString() }));
+        console.log();
         console.log(chalk.green(`✅ Successfully pushed "${machineCodeAppDirectoryInfo.appName}" to digital twin`));
         console.log(chalk.blue("💡 Your changes have been uploaded!"));
     }
     catch (error) {
+        console.log();
         console.error(chalk.red("Failed to push application:"));
         console.error(chalk.red(`Error: ${error instanceof Error ? error.message : String(error)}`));
         process.exit(1);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vention/vention-cli",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "CLI tool for Vention applications",
   "type": "module",
   "repository": {

package/src/file-system.d.ts

@@ -3,6 +3,9 @@ export interface FileSystemNode {
 }
 export declare const getDefaultIgnorePatterns: () => Set<string | RegExp>;
 export declare const shouldIgnoreFileSystemNode: (nodeName: string, ignoredNodes: Set<string | RegExp>) => boolean;
+export declare const getSafeAppName: (appName: string) => string;
 export declare const serializeFileSystem: (sourceDirectory: string, ignoredFileSystemNodes: Set<string | RegExp>, shouldBase64Encoded: boolean) => FileSystemNode;
 export declare const createFileSystemFromJson: (fileSystemNode: FileSystemNode, targetDirectory: string) => Promise<void>;
+export declare const checkIfDirectoryExists: (directory: string) => Promise<boolean>;
+export declare const checkIfAppDirectoryExists: (appName: string, targetDirectory: string) => Promise<boolean>;
 export declare const writeApplicationToDisk: (appName: string, sourceCode: FileSystemNode, targetDirectory: string, overwriteExisting?: boolean) => Promise<string>;