Merge pull request #61 from appcircleio/feature/be-6106-download

#BE-6106 feat: add download command for environment variables with JSON output

Author: fuatguzel

docs/build/variable/download.md

@@ -0,0 +1,28 @@
+# `appcircle build variable download`
+
+Download environment variables as JSON
+
+```plaintext
+appcircle build variable download [options]
+```
+
+## Examples
+
+```plaintext
+$ appcircle build variable download --variableGroupId "Variable Group ID"
+
+$ appcircle build variable download --variableGroupId "Variable Group ID" --path "/path/to/save"
+```
+         
+## Options
+
+```plaintext
+      --variableGroupId <uuid>  Variable Groups ID
+      --path <string>           [OPTIONAL] The path for JSON file to be downloaded (Defaults to the current directory)
+```                       
+
+## Options inherited from parent commands
+
+```plaintext
+      --help   Show help for command
+``` 

docs/build/variable/index.md

@@ -17,4 +17,5 @@ appcircle build variable [command] [options]
 - [`group`](group/index.md)
 - [`create`](create.md)
 - [`view`](view.md)
+- [`download`](download.md)
 

docs/publish/variable/group/download.md

@@ -0,0 +1,28 @@
+# `appcircle publish variable group download`
+
+Download publish environment variables as JSON
+
+```plaintext
+appcircle publish variable group download [options]
+```
+
+## Examples
+
+```plaintext
+$ appcircle publish variable group download --publishVariableGroupId "Variable Group ID"
+
+$ appcircle publish variable group download --publishVariableGroupId "Variable Group ID" --path "/path/to/save"
+```
+         
+## Options
+
+```plaintext
+      --publishVariableGroupId <uuid>  Variable Group ID
+      --path <string>                  [OPTIONAL] The path for JSON file to be downloaded (Defaults to the current directory)
+```                       
+
+## Options inherited from parent commands
+
+```plaintext
+      --help   Show help for command
+``` 

docs/publish/variable/group/index.md

@@ -16,4 +16,5 @@ appcircle publish profile variable group [command] [options]
 
 - [`list`](list.md)
 - [`view`](view.md)
+- [`download`](download.md)
 

src/core/command-runner.ts

@@ -453,7 +453,60 @@ const handlePublishCommand = async (command: ProgramCommand, params: any) => {
         fullCommandName: command.fullCommandName,
         data: variables.variables,
       });
-    }else if(command.fullCommandName === `${PROGRAM_NAME}-publish-profile-version-list`){
+    } else if (command.fullCommandName === `${PROGRAM_NAME}-publish-variable-group-download`) {
+      const spinner = createOra('Downloading publish environment variables...').start();
+      try {
+        const variableGroups = await getPublishVariableGroups();
+        const variableGroup = variableGroups.find((group: any) => group.id === params.publishVariableGroupId);
+        
+        if (!variableGroup) {
+          spinner.fail(`Variable group with ID ${params.publishVariableGroupId} not found`);
+          throw new Error(`Variable group not found`);
+        }
+        
+        const variables = await getPublishVariableListByGroupId(params);
+        
+        let formattedVariables = variables.variables.map((variable: any) => ({
+          key: variable.key,
+          value: variable.value,
+          isSecret: variable.isSecret,
+          isFile: variable.isFile || false,
+          id: variable.key
+        }));
+        
+        formattedVariables.sort((a: any, b: any) => {
+          const aKey = a.key;
+          const bKey = b.key;
+          return bKey.localeCompare(aKey);
+        });
+        
+        const timestamp = Date.now();
+        const fileName = `${variableGroup.name}_${timestamp}.json`;
+        
+        let filePath = params.path || process.cwd();
+        
+        if (filePath.includes('~')) {
+          filePath = filePath.replace(/~/g, os.homedir());
+        }
+        
+        filePath = path.resolve(filePath);
+        
+        if (!fs.existsSync(filePath)) {
+          fs.mkdirSync(filePath, { recursive: true });
+        }
+        
+        if (fs.statSync(filePath).isDirectory()) {
+          filePath = path.join(filePath, fileName);
+        }
+        
+        fs.writeFileSync(filePath, JSON.stringify(formattedVariables));
+        
+        spinner.succeed(`Publish environment variables downloaded successfully to ${filePath}`);
+      } catch (e) {
+        spinner.fail('Failed to download publish environment variables');
+        throw e;
+      }
+    } else if(command.fullCommandName === `${PROGRAM_NAME}-publish-profile-version-list`){
       const spinner = createOra('Fetching...').start();
       const appVersions = await getAppVersions(params);
       spinner.succeed();
@@ -532,7 +585,7 @@ const handleBuildCommand = async (command: ProgramCommand, params:any) => {
       fullCommandName: command.fullCommandName,
       data: responseData,
     });
-  }else if(command.fullCommandName === `${PROGRAM_NAME}-build-profile-branch-list`) {
+  }else if(command.fullCommandName === `${PROGRAM_NAME}-build-profile-branch-list`){
     const spinner = createOra('Fetching...').start();
     const responseData = await getBranches(params);
     spinner.succeed();
@@ -624,6 +677,57 @@ const handleBuildCommand = async (command: ProgramCommand, params:any) => {
       fullCommandName: command.fullCommandName,
       data: responseData,
     });
+  } else if(command.fullCommandName === `${PROGRAM_NAME}-build-variable-download`){
+    const spinner = createOra('Downloading environment variables...').start();
+    try {
+      const variableGroups = await getEnvironmentVariableGroups();
+      const variableGroup = variableGroups.find((group: any) => group.id === params.variableGroupId);
+      
+      if (!variableGroup) {
+        spinner.fail(`Variable group with ID ${params.variableGroupId} not found`);
+        throw new Error(`Variable group not found`);
+      }
+      
+      const responseData = await getEnvironmentVariables(params);
+      
+      let formattedVariables = responseData.map((variable: any) => ({
+        key: variable.key,
+        value: variable.value,
+        isSecret: variable.isSecret,
+        isFile: variable.isFile || false,
+        id: variable.key
+      }));
+      
+      formattedVariables.sort((a: any, b: any) => {
+        const aKey = a.key;
+        const bKey = b.key;
+        return bKey.localeCompare(aKey);
+      });
+      
+      const timestamp = Date.now();
+      const fileName = `${variableGroup.name}_${timestamp}.json`;
+      let filePath = params.path || process.cwd();
+      
+      if (filePath.includes('~')) {
+        filePath = filePath.replace(/~/g, os.homedir());
+      }
+      
+      filePath = path.resolve(filePath);
+
+      if (!fs.existsSync(filePath)) {
+        fs.mkdirSync(filePath, { recursive: true });
+      }
+
+      if (fs.statSync(filePath).isDirectory()) {
+        filePath = path.join(filePath, fileName);
+      }
+      
+      fs.writeFileSync(filePath, JSON.stringify(formattedVariables));
+      spinner.succeed(`Environment variables downloaded successfully to ${filePath}`);
+    } catch (e) {
+      spinner.fail('Failed to download environment variables');
+      throw e;
+    }
   } else if(command.fullCommandName === `${PROGRAM_NAME}-build-variable-create`){
     const spinner = createOra('Creating environment variable').start();
     try {

src/core/commands.ts

@@ -547,6 +547,26 @@ export const Commands: CommandType[] = [
                 valueType: 'uuid',
               },
             ],
+          },
+          {
+            command: "download",
+            description: 'Download environment variables as JSON',
+            params: [
+              {
+                name: 'variableGroupId',
+                description: 'Variable Groups ID',
+                type: CommandParameterTypes.SELECT,
+                valueType: 'uuid',
+              },
+              {
+                name: 'path',
+                description: '[OPTIONAL] The path for JSON file to be downloaded',
+                longDescription:'[OPTIONAL] The path for JSON file to be downloaded (Defaults to the current directory)',
+                type: CommandParameterTypes.STRING,
+                valueType: 'string',
+                required: false,
+              }
+            ],
           }
         ],
         params: []
@@ -1461,6 +1481,28 @@ export const Commands: CommandType[] = [
                     required: true
                   }
                 ],
+              },
+              {
+                command: "download",
+                description: 'Download publish environment variables as JSON',
+                longDescription: 'Download publish environment variables as JSON file',
+                params: [
+                  {
+                    name: 'publishVariableGroupId',
+                    description: 'Variable Group ID',
+                    type: CommandParameterTypes.SELECT,
+                    valueType: 'uuid',
+                    required: true
+                  },
+                  {
+                    name: 'path',
+                    description: '[OPTIONAL] The path for JSON file to be downloaded',
+                    longDescription:'[OPTIONAL] The path for JSON file to be downloaded (Defaults to the current directory)',
+                    type: CommandParameterTypes.STRING,
+                    valueType: 'string',
+                    required: false,
+                  }
+                ],
               }
             ]
           }