@devicecloud.dev/dcd 4.4.9 → 5.0.0-beta.1

package/dist/commands/cloud.d.ts

@@ -1,4 +1,3 @@
-import { Command } from '@oclif/core';
 /**
  * Primary CLI command for executing tests on DeviceCloud.
  * Orchestrates the complete test workflow:
@@ -11,90 +10,231 @@ import { Command } from '@oclif/core';
  *
  * Replaces `maestro cloud` with DeviceCloud-specific functionality.
  */
-export default class Cloud extends Command {
-    static args: {
-        firstFile: import("@oclif/core/lib/interfaces").Arg<string, Record<string, unknown>>;
-        secondFile: import("@oclif/core/lib/interfaces").Arg<string, Record<string, unknown>>;
-    };
-    static description: string;
-    static enableJsonFlag: boolean;
-    static examples: string[];
-    static flags: {
-        'artifacts-path': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        'junit-path': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        'allure-path': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        'html-path': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        async: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        debug: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        'download-artifacts': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        'dry-run': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        json: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        'json-file': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        'json-file-name': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        quiet: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        report: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        branch: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        'commit-sha': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        'repo-name': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        'pr-number': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        'pr-url': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        config: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        'exclude-flows': import("@oclif/core/lib/interfaces").OptionFlag<string[], import("@oclif/core/lib/interfaces").CustomOptions>;
-        'exclude-tags': import("@oclif/core/lib/interfaces").OptionFlag<string[], import("@oclif/core/lib/interfaces").CustomOptions>;
-        flows: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        'include-tags': import("@oclif/core/lib/interfaces").OptionFlag<string[], import("@oclif/core/lib/interfaces").CustomOptions>;
-        'maestro-version': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        retry: import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces").CustomOptions>;
-        'runner-type': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        env: import("@oclif/core/lib/interfaces").OptionFlag<string[], import("@oclif/core/lib/interfaces").CustomOptions>;
-        metadata: import("@oclif/core/lib/interfaces").OptionFlag<string[], import("@oclif/core/lib/interfaces").CustomOptions>;
-        mitmHost: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        mitmPath: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        'moropo-v1-api-key': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        name: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        'android-api-level': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        'android-device': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        'device-locale': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        'google-play': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        'ios-device': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        'ios-version': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        orientation: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        'show-crosshairs': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        'maestro-chrome-onboarding': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        'android-no-snapshot': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        'disable-animations': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        'app-binary-id': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        'app-file': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        'app-url': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        'ignore-sha-check': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        apiKey: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        apiUrl: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-    };
-    /** Service for device/OS compatibility validation */
-    private deviceValidationService;
-    /** Service for Moropo test framework integration */
-    private moropoService;
-    /** Service for downloading test reports and artifacts */
-    private reportDownloadService;
-    /** Service for polling test results with 10-second intervals */
-    private resultsPollingService;
-    /** Service for submitting tests to the API */
-    private testSubmissionService;
-    /**
-     * Check for CLI updates and notify user if outdated
-     * Compares current version with latest npm release
-     * @returns Promise that resolves when version check is complete
-     */
-    private versionCheck;
-    /** Service for CLI version checking */
-    private versionService;
-    /**
-     * Main command execution entry point
-     * Orchestrates the complete test submission and monitoring workflow
-     * @returns Promise that resolves when command execution is complete
-     * @throws RunFailedError if tests fail
-     * @throws Error for infrastructure or configuration errors
-     */
-    run(): Promise<any>;
-    protected toErrorJson(err: unknown): unknown;
-}
+export declare const cloudCommand: import("citty").CommandDef<{
+    readonly firstFile: {
+        readonly type: "positional";
+        readonly required: false;
+        readonly description: "The binary file of the app to run your flow against, e.g. test.apk for android or test.app/.zip for ios";
+    };
+    readonly secondFile: {
+        readonly type: "positional";
+        readonly required: false;
+        readonly description: "The flow file to run against the app, e.g. test.yaml";
+    };
+    readonly 'artifacts-path': {
+        readonly type: "string";
+        readonly description: "Custom file path for downloaded artifacts (default: ./artifacts.zip). Requires --download-artifacts.";
+    };
+    readonly 'junit-path': {
+        readonly type: "string";
+        readonly description: "Custom file path for downloaded JUnit report (requires --report junit, default: ./report.xml)";
+    };
+    readonly 'allure-path': {
+        readonly type: "string";
+        readonly description: "Custom file path for downloaded Allure report (requires --report allure, default: ./report.html)";
+    };
+    readonly 'html-path': {
+        readonly type: "string";
+        readonly description: "Custom file path for downloaded HTML report (requires --report html, default: ./report.html)";
+    };
+    readonly async: {
+        readonly type: "boolean";
+        readonly description: "Immediately return (exit code 0) from the command without waiting for the results of the run (useful for saving CI minutes)";
+    };
+    readonly debug: {
+        readonly type: "boolean";
+        readonly default: false;
+        readonly description: "Enable detailed debug logging for troubleshooting issues";
+    };
+    readonly 'download-artifacts': {
+        readonly type: "string";
+        readonly description: "Download a zip containing the logs, screenshots and videos for each result in this run (options: ALL, FAILED)";
+    };
+    readonly 'dry-run': {
+        readonly type: "boolean";
+        readonly default: false;
+        readonly description: "Simulate the run without actually triggering the upload/test, useful for debugging workflow issues.";
+    };
+    readonly json: {
+        readonly type: "boolean";
+        readonly description: "Output results in JSON format. Exit codes: 0 on success, 2 if the test run fails, 1 on CLI/infrastructure errors";
+    };
+    readonly 'json-file': {
+        readonly type: "boolean";
+        readonly description: "Write JSON output to a file. File will be called <upload_id>_dcd.json unless you supply the --json-file-name flag - note: exits with code 0 even if the test run fails (CLI/infrastructure errors still exit 1)";
+    };
+    readonly 'json-file-name': {
+        readonly type: "string";
+        readonly description: "A custom name for the JSON file (can also include relative path). Requires --json-file.";
+    };
+    readonly quiet: {
+        readonly type: "boolean";
+        readonly alias: ["q"];
+        readonly default: false;
+        readonly description: "Quieter console output that won't provide progress updates";
+    };
+    readonly report: {
+        readonly type: "string";
+        readonly alias: ["format"];
+        readonly description: "Generate and download test reports in the specified format (options: allure, junit, html, html-detailed). Use \"allure\" for a complete HTML report.";
+    };
+    readonly branch: {
+        readonly type: "string";
+        readonly description: "Git branch name for this run (stored as gh_branch metadata)";
+    };
+    readonly 'commit-sha': {
+        readonly type: "string";
+        readonly description: "Git commit SHA for this run (stored as gh_sha metadata)";
+    };
+    readonly 'repo-name': {
+        readonly type: "string";
+        readonly description: "Repository in owner/repo format (stored as gh_repo metadata, e.g. \"acme/my-app\")";
+    };
+    readonly 'pr-number': {
+        readonly type: "string";
+        readonly description: "Pull request number for this run (stored as gh_pr_number metadata)";
+    };
+    readonly 'pr-url': {
+        readonly type: "string";
+        readonly description: "Pull request URL for this run (stored as gh_pr_url metadata)";
+    };
+    readonly config: {
+        readonly type: "string";
+        readonly description: "Path to custom config.yaml file. If not provided, defaults to config.yaml in root flows folders.";
+        readonly valueHint: "path";
+    };
+    readonly 'exclude-flows': {
+        readonly type: "string";
+        readonly description: "Sub directories to ignore when building the flow file list (comma-separated, may be repeated)";
+    };
+    readonly 'exclude-tags': {
+        readonly type: "string";
+        readonly description: "Flows which have these tags will be excluded from the run (comma-separated, may be repeated)";
+    };
+    readonly flows: {
+        readonly type: "string";
+        readonly description: "The path to the flow file or folder containing your flows";
+    };
+    readonly 'include-tags': {
+        readonly type: "string";
+        readonly description: "Only flows which have these tags will be included in the run (comma-separated, may be repeated)";
+    };
+    readonly 'maestro-version': {
+        readonly type: "string";
+        readonly alias: ["maestroVersion"];
+        readonly description: "Maestro version to run your flow against. Use \"latest\" for the most recent version. See https://docs.devicecloud.dev/configuration/maestro-versions for supported versions.";
+    };
+    readonly retry: {
+        readonly type: "string";
+        readonly description: "Automatically retry the run up to the number of times specified (same as pressing retry in the UI) - this is free of charge";
+    };
+    readonly 'runner-type': {
+        readonly type: "string";
+        readonly default: "default";
+        readonly description: "[experimental] The type of runner to use (options: default, m4, m1, gpu1, cpu1) - note: anything other than default or cpu1 will incur premium pricing tiers, see https://docs.devicecloud.dev/configuration/runner-type for more information.";
+    };
+    readonly env: {
+        readonly type: "string";
+        readonly alias: ["e"];
+        readonly description: "One or more environment variables to inject into your flows (format: KEY=VALUE, may be repeated)";
+        readonly valueHint: "KEY=VALUE";
+    };
+    readonly metadata: {
+        readonly type: "string";
+        readonly alias: ["m"];
+        readonly description: "Arbitrary key-value metadata to include with your test run (format: key=value, may be repeated)";
+    };
+    readonly mitmHost: {
+        readonly type: "string";
+        readonly description: "used for mitmproxy support, enterprise only, contact support if interested";
+    };
+    readonly mitmPath: {
+        readonly type: "string";
+        readonly description: "used for mitmproxy support, enterprise only, contact support if interested";
+    };
+    readonly 'moropo-v1-api-key': {
+        readonly type: "string";
+        readonly description: "API key for Moropo v1 integration";
+    };
+    readonly name: {
+        readonly type: "string";
+        readonly description: "A custom name for your upload (useful for tagging commits etc)";
+    };
+    readonly 'android-api-level': {
+        readonly type: "string";
+        readonly description: `[Android only] Android API level to run your flow against (options: ${string})`;
+    };
+    readonly 'android-device': {
+        readonly type: "string";
+        readonly description: `[Android only] Android device to run your flow against (options: ${string})`;
+    };
+    readonly 'device-locale': {
+        readonly type: "string";
+        readonly description: "Locale that will be set to a device, ISO-639-1 code and uppercase ISO-3166-1 code e.g. \"de_DE\" for Germany";
+    };
+    readonly 'google-play': {
+        readonly type: "boolean";
+        readonly default: false;
+        readonly description: "[Android only] Run your flow against Google Play devices";
+    };
+    readonly 'ios-device': {
+        readonly type: "string";
+        readonly description: `[iOS only] iOS device to run your flow against (options: ${string})`;
+    };
+    readonly 'ios-version': {
+        readonly type: "string";
+        readonly description: `[iOS only] iOS version to run your flow against (options: ${string})`;
+    };
+    readonly orientation: {
+        readonly type: "string";
+        readonly description: "[Android only] The orientation of the device to run your flow against (0 = portrait, 90 = landscape)";
+    };
+    readonly 'show-crosshairs': {
+        readonly type: "boolean";
+        readonly default: false;
+        readonly description: "[Android only] Display crosshairs for screen interactions during test execution";
+    };
+    readonly 'maestro-chrome-onboarding': {
+        readonly type: "boolean";
+        readonly default: false;
+        readonly description: "[Android only] Force Maestro-based Chrome onboarding - note: this will slow your tests but can fix browser related crashes. See https://docs.devicecloud.dev/advanced/chrome-onboarding for more information.";
+    };
+    readonly 'android-no-snapshot': {
+        readonly type: "boolean";
+        readonly default: false;
+        readonly description: "[Android only] Force cold boot instead of using snapshot boot. This is automatically enabled for API 35+ but can be used to force cold boot on older API levels.";
+    };
+    readonly 'disable-animations': {
+        readonly type: "boolean";
+        readonly default: false;
+        readonly description: "Disable device animations during test execution. On Android, disables system animation scales. On iOS, enables Reduce Motion. Reduces CPU load and may improve test reliability.";
+    };
+    readonly 'app-binary-id': {
+        readonly type: "string";
+        readonly description: "The ID of the app binary previously uploaded to devicecloud.dev";
+    };
+    readonly 'app-file': {
+        readonly type: "string";
+        readonly description: "App binary to run your flows against";
+        readonly valueHint: "path";
+    };
+    readonly 'app-url': {
+        readonly type: "string";
+        readonly description: "Signed URL to an Expo iOS build (.tar.gz). The archive is downloaded and extracted automatically. Expo signed URLs expire after ~1 hour.";
+    };
+    readonly 'ignore-sha-check': {
+        readonly type: "boolean";
+        readonly description: "Ignore the sha hash check and upload the binary regardless of whether it already exists (not recommended)";
+    };
+    readonly 'api-key': {
+        readonly type: "string";
+        readonly alias: ["apiKey"];
+        readonly description: "API key for devicecloud.dev (find this in the console UI). You can also set the DEVICE_CLOUD_API_KEY environment variable.";
+    };
+    readonly 'api-url': {
+        readonly type: "string";
+        readonly alias: ["apiURL", "apiUrl"];
+        readonly description: "API base URL (defaults to the URL stored by `dcd login`, else prod)";
+    };
+}>;
+export default cloudCommand;