@capawesome/cli 4.21.0 → 4.23.0

package/dist/commands/apps/builds/download.js

@@ -1,12 +1,17 @@
 import appBuildsService from '../../../services/app-builds.js';
+import { APP_BUILD_ARTIFACT_FORM_FACTORS, APP_BUILD_ARTIFACT_LABELS, APP_BUILD_ARTIFACT_TYPES_BY_PLATFORM, handleAppBuildArtifactDownload, } from '../../../utils/app-build-artifacts.js';
 import { withAuth } from '../../../utils/auth.js';
+import { isInteractive } from '../../../utils/environment.js';
 import { prompt, promptAppSelection, promptOrganizationSelection } from '../../../utils/prompt.js';
 import consola from 'consola';
-import fs from 'fs/promises';
-import path from 'path';
-import { isInteractive } from '../../../utils/environment.js';
 import { z } from 'zod';
 import { defineCommand, defineOptions } from 'zodline';
+const ARTIFACT_TYPES = ['apk', 'aab', 'ipa', 'app', 'zip'];
+const PLATFORM_LABELS = {
+    android: 'Android',
+    ios: 'iOS',
+    web: 'Web',
+};
 export default defineCommand({
     description: 'Download an app build.',
     options: defineOptions(z.object({
@@ -22,22 +27,32 @@ export default defineCommand({
         })
             .optional()
             .describe('Build ID to download.'),
+        formFactor: z
+            .enum(APP_BUILD_ARTIFACT_FORM_FACTORS, {
+            message: 'Invalid form factor. Must be one of `mobile`, `watch`, `tv`, or `automotive`.',
+        })
+            .optional()
+            .describe('The form factor of the Android artifact to download. Supported values are `mobile`, `watch`, `tv`, and `automotive`. Without it, the first artifact in the order `mobile`, `watch`, `tv`, `automotive` is downloaded.'),
         apk: z
             .union([z.boolean(), z.string()])
             .optional()
-            .describe('Download the APK artifact. Optionally provide a file path.'),
+            .describe('Download the APK artifact (Android only). Optionally provide a file path.'),
         aab: z
             .union([z.boolean(), z.string()])
             .optional()
-            .describe('Download the AAB artifact. Optionally provide a file path.'),
+            .describe('Download the AAB artifact (Android only). Optionally provide a file path.'),
         ipa: z
             .union([z.boolean(), z.string()])
             .optional()
-            .describe('Download the IPA artifact. Optionally provide a file path.'),
+            .describe('Download the IPA artifact (iOS only). Optionally provide a file path.'),
+        app: z
+            .union([z.boolean(), z.string()])
+            .optional()
+            .describe('Download the APP artifact, a zipped `.app` bundle (iOS simulator builds only). Optionally provide a file path.'),
         zip: z
             .union([z.boolean(), z.string()])
             .optional()
-            .describe('Download the ZIP artifact. Optionally provide a file path.'),
+            .describe('Download the ZIP artifact (Web only). Optionally provide a file path.'),
     })),
     action: withAuth(async (options) => {
         let { appId, buildId } = options;
@@ -74,156 +89,54 @@ export default defineCommand({
                 process.exit(1);
             }
         }
-        // Fetch the build details to get the job ID
         const build = await appBuildsService.findOne({ appId, appBuildId: buildId, relations: 'appBuildArtifacts,job' });
         if (build.job?.status !== 'succeeded') {
             consola.error('The build has not succeeded yet. Cannot download artifacts for incomplete builds.');
             process.exit(1);
         }
-        // Validate platform-specific artifact flags
-        if (build.platform === 'android' && options.ipa) {
-            consola.error('Cannot download IPA artifact for an Android build.');
-            process.exit(1);
-        }
-        if (build.platform === 'ios' && (options.apk || options.aab)) {
-            consola.error('Cannot download APK or AAB artifacts for an iOS build.');
-            process.exit(1);
-        }
-        if (build.platform === 'web' && (options.apk || options.aab || options.ipa)) {
-            consola.error('Cannot download APK, AAB, or IPA artifacts for a Web build.');
+        // Reject artifact flags that do not exist for the build's platform
+        const supportedArtifactTypes = APP_BUILD_ARTIFACT_TYPES_BY_PLATFORM[build.platform];
+        const requestedArtifactTypes = ARTIFACT_TYPES.filter((artifactType) => options[artifactType]);
+        const unsupportedArtifactType = requestedArtifactTypes.find((artifactType) => !supportedArtifactTypes.includes(artifactType));
+        if (unsupportedArtifactType) {
+            consola.error(`The ${APP_BUILD_ARTIFACT_LABELS[unsupportedArtifactType]} artifact is not available for ${PLATFORM_LABELS[build.platform]} builds.`);
             process.exit(1);
         }
-        // Determine which artifacts to download
-        let downloadApk = options.apk;
-        let downloadAab = options.aab;
-        let downloadIpa = options.ipa;
-        let downloadZip = options.zip;
         // Prompt for artifact types if none were provided
-        if (!downloadApk && !downloadAab && !downloadIpa && !downloadZip) {
+        let artifactTypesToDownload = requestedArtifactTypes;
+        if (artifactTypesToDownload.length === 0) {
             if (!isInteractive()) {
-                consola.error('You must specify at least one artifact type (--apk, --aab, --ipa, or --zip) when running in non-interactive environment.');
+                consola.error('You must specify at least one artifact type (--apk, --aab, --ipa, --app, or --zip) when running in non-interactive environment.');
                 process.exit(1);
             }
-            // Get available artifact types from the build
-            const availableArtifacts = build.appBuildArtifacts?.filter((artifact) => artifact.status === 'ready').map((artifact) => artifact.type) ||
-                [];
-            if (availableArtifacts.length === 0) {
+            const availableArtifactTypes = supportedArtifactTypes.filter((artifactType) => build.appBuildArtifacts?.some((artifact) => artifact.type === artifactType && artifact.status === 'ready'));
+            if (availableArtifactTypes.length === 0) {
                 consola.error('No artifacts available for download.');
                 process.exit(1);
             }
-            // Create options based on available artifacts and platform
-            const artifactOptions = [];
-            if (build.platform === 'android') {
-                if (availableArtifacts.includes('apk')) {
-                    artifactOptions.push({ label: 'APK', value: 'apk' });
-                }
-                if (availableArtifacts.includes('aab')) {
-                    artifactOptions.push({ label: 'AAB', value: 'aab' });
-                }
-            }
-            else if (build.platform === 'ios') {
-                if (availableArtifacts.includes('ipa')) {
-                    artifactOptions.push({ label: 'IPA', value: 'ipa' });
-                }
-            }
-            else if (build.platform === 'web') {
-                if (availableArtifacts.includes('zip')) {
-                    artifactOptions.push({ label: 'ZIP', value: 'zip' });
-                }
-            }
             // @ts-ignore wait till https://github.com/unjs/consola/pull/280 is merged
-            const selectedArtifacts = await prompt('Which artifact type(s) do you want to download:', {
+            artifactTypesToDownload = await prompt('Which artifact type(s) do you want to download:', {
                 type: 'multiselect',
-                options: artifactOptions,
+                options: availableArtifactTypes.map((artifactType) => ({
+                    label: APP_BUILD_ARTIFACT_LABELS[artifactType],
+                    value: artifactType,
+                })),
             });
-            if (!selectedArtifacts || selectedArtifacts.length === 0) {
+            if (!artifactTypesToDownload || artifactTypesToDownload.length === 0) {
                 consola.error('You must select at least one artifact type to download.');
                 process.exit(1);
             }
-            // Set flags based on selection
-            downloadApk = selectedArtifacts.includes('apk');
-            downloadAab = selectedArtifacts.includes('aab');
-            downloadIpa = selectedArtifacts.includes('ipa');
-            downloadZip = selectedArtifacts.includes('zip');
-        }
-        // Download artifacts if flags are set
-        if (downloadApk) {
-            await handleArtifactDownload({
-                appId,
-                buildId: buildId,
-                buildArtifacts: build.appBuildArtifacts,
-                artifactType: 'apk',
-                filePath: typeof options.apk === 'string' ? options.apk : undefined,
-            });
-        }
-        if (downloadAab) {
-            await handleArtifactDownload({
-                appId,
-                buildId: buildId,
-                buildArtifacts: build.appBuildArtifacts,
-                artifactType: 'aab',
-                filePath: typeof options.aab === 'string' ? options.aab : undefined,
-            });
-        }
-        if (downloadIpa) {
-            await handleArtifactDownload({
-                appId,
-                buildId: buildId,
-                buildArtifacts: build.appBuildArtifacts,
-                artifactType: 'ipa',
-                filePath: typeof options.ipa === 'string' ? options.ipa : undefined,
-            });
         }
-        if (downloadZip) {
-            await handleArtifactDownload({
+        for (const artifactType of artifactTypesToDownload) {
+            const option = options[artifactType];
+            await handleAppBuildArtifactDownload({
                 appId,
-                buildId: buildId,
+                buildId,
                 buildArtifacts: build.appBuildArtifacts,
-                artifactType: 'zip',
-                filePath: typeof options.zip === 'string' ? options.zip : undefined,
+                artifactType,
+                formFactor: options.formFactor,
+                filePath: typeof option === 'string' ? option : undefined,
             });
         }
     }),
 });
-/**
- * Download a build artifact (APK, AAB, IPA, or ZIP).
- */
-const handleArtifactDownload = async (options) => {
-    const { appId, buildId, buildArtifacts, artifactType, filePath } = options;
-    try {
-        const artifactTypeUpper = artifactType.toUpperCase();
-        consola.start(`Downloading ${artifactTypeUpper}...`);
-        // Find the artifact
-        const artifact = buildArtifacts?.find((artifact) => artifact.type === artifactType);
-        if (!artifact) {
-            consola.warn(`No ${artifactTypeUpper} artifact found for this build.`);
-            return;
-        }
-        if (artifact.status !== 'ready') {
-            consola.warn(`${artifactTypeUpper} artifact is not ready (status: ${artifact.status}).`);
-            return;
-        }
-        // Download the artifact
-        const artifactData = await appBuildsService.downloadArtifact({
-            appId,
-            appBuildId: buildId,
-            artifactId: artifact.id,
-        });
-        // Determine the file path
-        let outputPath;
-        if (filePath) {
-            // Use provided path (can be relative or absolute)
-            outputPath = path.resolve(filePath);
-        }
-        else {
-            // Default to current working directory with build ID as filename
-            outputPath = path.resolve(`${buildId}.${artifactType}`);
-        }
-        // Save the file
-        await fs.writeFile(outputPath, Buffer.from(artifactData));
-        consola.success(`${artifactTypeUpper} downloaded successfully: ${outputPath}`);
-    }
-    catch (error) {
-        consola.error(`Failed to download ${artifactType.toUpperCase()}:`, error);
-    }
-};

package/dist/commands/apps/builds/download.test.js

@@ -0,0 +1,85 @@
+import { DEFAULT_API_BASE_URL } from '../../../config/consts.js';
+import authorizationService from '../../../services/authorization-service.js';
+import userConfig from '../../../utils/user-config.js';
+import consola from 'consola';
+import fs from 'fs/promises';
+import nock from 'nock';
+import os from 'os';
+import path from 'path';
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
+import downloadCommand from './download.js';
+vi.mock('@/utils/user-config.js');
+vi.mock('@/utils/prompt.js');
+vi.mock('@/services/authorization-service.js');
+vi.mock('consola');
+vi.mock('@/utils/environment.js', () => ({
+    isInteractive: () => false,
+}));
+describe('apps-builds-download', () => {
+    const mockUserConfig = vi.mocked(userConfig);
+    const mockAuthorizationService = vi.mocked(authorizationService);
+    const mockConsola = vi.mocked(consola);
+    const testToken = 'test-token';
+    const appId = '00000000-0000-0000-0000-000000000001';
+    const buildId = '00000000-0000-0000-0000-000000000002';
+    const artifactId = 'artifact-1';
+    const artifactContent = 'zipped app bundle';
+    let outputDirectory;
+    const mockSimulatorBuild = () => nock(DEFAULT_API_BASE_URL)
+        .get(`/v1/apps/${appId}/builds/${buildId}`)
+        .query({ relations: 'appBuildArtifacts,job' })
+        .matchHeader('Authorization', `Bearer ${testToken}`)
+        .reply(200, {
+        id: buildId,
+        platform: 'ios',
+        type: 'simulator',
+        job: { status: 'succeeded' },
+        appBuildArtifacts: [
+            { id: 'artifact-0', status: 'ready', type: 'xcarchive' },
+            { formFactor: 'mobile', id: artifactId, status: 'ready', type: 'app' },
+        ],
+    });
+    beforeEach(async () => {
+        vi.clearAllMocks();
+        mockUserConfig.read.mockReturnValue({ token: testToken });
+        mockAuthorizationService.hasAuthorizationToken.mockReturnValue(true);
+        mockAuthorizationService.getCurrentAuthorizationToken.mockReturnValue(testToken);
+        vi.spyOn(process, 'exit').mockImplementation((code) => {
+            throw new Error(`Process exited with code ${code}`);
+        });
+        outputDirectory = await fs.mkdtemp(path.join(os.tmpdir(), 'capawesome-cli-download-'));
+    });
+    afterEach(async () => {
+        nock.cleanAll();
+        vi.restoreAllMocks();
+        await fs.rm(outputDirectory, { force: true, recursive: true });
+    });
+    it('should download the app artifact of an iOS simulator build with --app', async () => {
+        const outputPath = path.join(outputDirectory, 'simulator.app.zip');
+        const buildScope = mockSimulatorBuild();
+        const downloadScope = nock(DEFAULT_API_BASE_URL)
+            .get(`/v1/apps/${appId}/builds/${buildId}/artifacts/${artifactId}/download`)
+            .matchHeader('Authorization', `Bearer ${testToken}`)
+            .reply(200, artifactContent);
+        await downloadCommand.action({ appId, buildId, app: outputPath }, undefined);
+        expect(buildScope.isDone()).toBe(true);
+        expect(downloadScope.isDone()).toBe(true);
+        expect(await fs.readFile(outputPath, 'utf-8')).toBe(artifactContent);
+        expect(mockConsola.success).toHaveBeenCalledWith(`APP downloaded successfully: ${outputPath}`);
+    });
+    it('should write the app artifact to `<build-id>.app.zip` by default', async () => {
+        vi.spyOn(process, 'cwd').mockReturnValue(outputDirectory);
+        mockSimulatorBuild();
+        nock(DEFAULT_API_BASE_URL)
+            .get(`/v1/apps/${appId}/builds/${buildId}/artifacts/${artifactId}/download`)
+            .reply(200, artifactContent);
+        await downloadCommand.action({ appId, buildId, app: true }, undefined);
+        const outputPath = path.join(outputDirectory, `${buildId}.app.zip`);
+        expect(await fs.readFile(outputPath, 'utf-8')).toBe(artifactContent);
+    });
+    it('should reject --zip for an iOS build', async () => {
+        mockSimulatorBuild();
+        await expect(downloadCommand.action({ appId, buildId, zip: true }, undefined)).rejects.toThrow('Process exited with code 1');
+        expect(mockConsola.error).toHaveBeenCalledWith('The ZIP artifact is not available for iOS builds.');
+    });
+});

package/dist/commands/apps/builds/run.js

@@ -1,6 +1,7 @@
 import appBuildsService from '../../../services/app-builds.js';
 import { defineCommand, defineOptions } from 'zodline';
 import { bootAndroidEmulator, findAllAndroidEmulators, installAndroidApp, launchAndroidApp, } from '../../../utils/android-emulator.js';
+import { findAppBuildArtifact } from '../../../utils/app-build-artifacts.js';
 import { withAuth } from '../../../utils/auth.js';
 import { isInteractive } from '../../../utils/environment.js';
 import { bootIosSimulator, findAllIosSimulators, installIosApp, launchIosApp, } from '../../../utils/ios-simulator.js';
@@ -99,7 +100,7 @@ export default defineCommand({
             process.exit(1);
         }
         const artifactType = isAndroid ? 'apk' : 'app';
-        const artifact = build.appBuildArtifacts?.find((artifact) => artifact.type === artifactType && artifact.status === 'ready');
+        const artifact = findAppBuildArtifact(build.appBuildArtifacts?.filter((artifact) => artifact.status === 'ready'), { type: artifactType });
         if (!artifact) {
             consola.error(`No ${artifactType.toUpperCase()} artifact is available for this build.`);
             process.exit(1);

package/dist/commands/apps/deployments/create.js

@@ -7,6 +7,7 @@ import { isInteractive } from '../../../utils/environment.js';
 import { offerJobFailureSummary } from '../../../utils/job-failure-summary.js';
 import { waitForJobCompletion } from '../../../utils/job.js';
 import { prompt, promptAppSelection, promptOrganizationSelection } from '../../../utils/prompt.js';
+import { parseReleaseNotes } from '../../../utils/release-notes.js';
 import consola from 'consola';
 import { z } from 'zod';
 import { defineCommand, defineOptions } from 'zodline';
@@ -37,9 +38,19 @@ export default defineCommand({
             .optional()
             .describe('Request an AI-powered failure summary (Capawesome Cloud Assist) if the deployment fails.'),
         json: z.boolean().optional().describe('Output in JSON format.'),
+        releaseNotes: z.string().optional().describe('Release notes for the deployment (default text).'),
+        releaseNotesFile: z
+            .string()
+            .optional()
+            .describe('Path to a JSON file with release notes by locale, e.g. `{"default": "…", "de-DE": "…"}`.'),
+        releaseNotesLocale: z
+            .array(z.string())
+            .optional()
+            .describe('Translated release notes as `<locale>=<text>`, e.g. `de-DE=Fehlerbehebungen`. Can be specified multiple times.'),
     })),
     action: withAuth(async (options) => {
         let { appId, buildId, buildNumber, channel, destination, json } = options;
+        const releaseNotes = await parseReleaseNotes(options);
         // Prompt for app ID if not provided
         if (!appId) {
             if (!isInteractive()) {
@@ -157,6 +168,7 @@ export default defineCommand({
             appBuildId: buildId,
             appDestinationName: build.platform === 'web' ? undefined : destination,
             appChannelName: build.platform === 'web' ? channel : undefined,
+            releaseNotes,
         });
         consola.info(`Deployment ID: ${response.id}`);
         consola.info(`Deployment URL: ${DEFAULT_CONSOLE_BASE_URL}/apps/${appId}/deployments/${response.id}`);

package/dist/commands/apps/deployments/create.test.js

@@ -0,0 +1,70 @@
+import { DEFAULT_API_BASE_URL } from '../../../config/consts.js';
+import authorizationService from '../../../services/authorization-service.js';
+import userConfig from '../../../utils/user-config.js';
+import consola from 'consola';
+import nock from 'nock';
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
+import createCommand from './create.js';
+// Mock dependencies
+vi.mock('@/utils/user-config.js');
+vi.mock('@/utils/prompt.js');
+vi.mock('@/services/authorization-service.js');
+vi.mock('@/utils/job.js');
+vi.mock('consola');
+vi.mock('@/utils/environment.js', () => ({
+    isInteractive: () => false,
+}));
+describe('apps-deployments-create', () => {
+    const mockUserConfig = vi.mocked(userConfig);
+    const mockAuthorizationService = vi.mocked(authorizationService);
+    const mockConsola = vi.mocked(consola);
+    const testToken = 'test-token';
+    const appId = '00000000-0000-0000-0000-000000000001';
+    const buildId = '00000000-0000-0000-0000-000000000002';
+    const deploymentId = 'deployment-1';
+    beforeEach(() => {
+        vi.clearAllMocks();
+        mockUserConfig.read.mockReturnValue({ token: testToken });
+        mockAuthorizationService.hasAuthorizationToken.mockReturnValue(true);
+        mockAuthorizationService.getCurrentAuthorizationToken.mockReturnValue(testToken);
+        vi.spyOn(process, 'exit').mockImplementation((code) => {
+            throw new Error(`Process exited with code ${code}`);
+        });
+    });
+    afterEach(() => {
+        nock.cleanAll();
+        vi.restoreAllMocks();
+    });
+    it('should send the release notes with the deployment', async () => {
+        const options = {
+            appId,
+            buildId,
+            destination: 'Google Play',
+            detached: true,
+            releaseNotes: 'Bug fixes',
+            releaseNotesLocale: ['de-DE=Fehlerbehebungen'],
+        };
+        const buildScope = nock(DEFAULT_API_BASE_URL)
+            .get(`/v1/apps/${appId}/builds/${buildId}`)
+            .matchHeader('Authorization', `Bearer ${testToken}`)
+            .reply(200, { id: buildId, platform: 'android' });
+        const deploymentScope = nock(DEFAULT_API_BASE_URL)
+            .post(`/v1/apps/${appId}/deployments`, {
+            appId,
+            appBuildId: buildId,
+            appDestinationName: 'Google Play',
+            releaseNotes: { default: 'Bug fixes', 'de-DE': 'Fehlerbehebungen' },
+        })
+            .matchHeader('Authorization', `Bearer ${testToken}`)
+            .reply(201, { id: deploymentId, jobId: 'job-1' });
+        await createCommand.action(options, undefined);
+        expect(buildScope.isDone()).toBe(true);
+        expect(deploymentScope.isDone()).toBe(true);
+        expect(mockConsola.success).toHaveBeenCalledWith('Deployment created successfully.');
+    });
+    it('should reject translated release notes without a default text', async () => {
+        const options = { appId, buildId, destination: 'Google Play', releaseNotesLocale: ['de-DE=Fehlerbehebungen'] };
+        await expect(createCommand.action(options, undefined)).rejects.toThrow('Process exited with code 1');
+        expect(mockConsola.error).toHaveBeenCalledWith('Release notes require a default text (--release-notes).');
+    });
+});