@devicecloud.dev/dcd 3.4.4 → 3.5.1

package/dist/commands/cloud.d.ts

@@ -41,6 +41,7 @@ export default class Cloud extends Command {
         async: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         'device-locale': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
         'download-artifacts': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+        'artifacts-path': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
         env: import("@oclif/core/lib/interfaces").OptionFlag<string[] | undefined, 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>;

package/dist/commands/cloud.js

@@ -80,7 +80,7 @@ class Cloud extends core_1.Command {
         let output = null;
         try {
             const { args, flags, raw } = await this.parse(Cloud);
-            let { 'additional-app-binary-ids': nonFlatAdditionalAppBinaryIds, 'additional-app-files': nonFlatAdditionalAppFiles, 'android-api-level': androidApiLevel, 'android-device': androidDevice, apiKey: apiKeyFlag, apiUrl, 'app-binary-id': appBinaryId, 'app-file': appFile, async, 'device-locale': deviceLocale, 'download-artifacts': downloadArtifacts, env, 'exclude-flows': excludeFlows, 'exclude-tags': excludeTags, flows, 'google-play': googlePlay, 'include-tags': includeTags, 'ignore-sha-check': ignoreShaCheck, 'ios-device': iOSDevice, 'ios-version': iOSVersion, 'maestro-version': maestroVersion, name, orientation, quiet, retry, report, 'runner-type': runnerType, 'x86-arch': x86Arch, json, ...rest } = flags;
+            let { 'additional-app-binary-ids': nonFlatAdditionalAppBinaryIds, 'additional-app-files': nonFlatAdditionalAppFiles, 'android-api-level': androidApiLevel, 'android-device': androidDevice, apiKey: apiKeyFlag, apiUrl, 'app-binary-id': appBinaryId, 'app-file': appFile, 'artifacts-path': artifactsPath, async, 'device-locale': deviceLocale, 'download-artifacts': downloadArtifacts, env, 'exclude-flows': excludeFlows, 'exclude-tags': excludeTags, flows, 'google-play': googlePlay, 'include-tags': includeTags, 'ignore-sha-check': ignoreShaCheck, 'ios-device': iOSDevice, 'ios-version': iOSVersion, 'maestro-version': maestroVersion, name, orientation, quiet, retry, report, 'runner-type': runnerType, 'x86-arch': x86Arch, json, ...rest } = flags;
             // If in JSON mode, temporarily intercept stdout to suppress the warning
             if (json) {
                 const originalStdoutWrite = process.stdout.write;
@@ -375,9 +375,9 @@ class Cloud extends core_1.Command {
                                             'content-type': 'application/json',
                                             'x-app-api-key': apiKey,
                                         },
-                                    });
+                                    }, artifactsPath);
                                     this.log('\n');
-                                    this.log('Test artifacts have been downloaded to ./artifacts.zip');
+                                    this.log(`Test artifacts have been downloaded to ${artifactsPath || './artifacts.zip'}`);
                                 }
                                 catch {
                                     this.warn('Failed to download artifacts');

package/dist/commands/status.js

@@ -41,7 +41,8 @@ class Status extends core_1.Command {
     }
     async run() {
         const { flags } = await this.parse(Status);
-        const { apiUrl, apiKey, name, 'upload-id': uploadId, json } = flags;
+        const { apiUrl, apiKey: apiKeyFlag, name, 'upload-id': uploadId, json, } = flags;
+        const apiKey = apiKeyFlag || process.env.DEVICE_CLOUD_API_KEY;
         if (!apiKey) {
             this.error('API Key is required. Please provide it via --api-key flag or DEVICE_CLOUD_API_KEY environment variable.');
             return;

package/dist/commands/upload.d.ts

@@ -0,0 +1,17 @@
+import { Command } from '@oclif/core';
+export default class Upload extends Command {
+    static args: {
+        appFile: import("@oclif/core/lib/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        apiKey: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+        apiUrl: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+        'ignore-sha-check': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    };
+    static enableJsonFlag: boolean;
+    run(): Promise<{
+        appBinaryId: string;
+    } | undefined>;
+}

package/dist/commands/upload.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const constants_1 = require("../constants");
+const methods_1 = require("../methods");
+class Upload extends core_1.Command {
+    static args = {
+        appFile: core_1.Args.string({
+            description: 'The binary file to upload (e.g. test.apk for android or test.app/.zip for ios)',
+            required: true,
+            name: 'App file',
+        }),
+    };
+    static description = 'Upload an app binary to devicecloud.dev';
+    static examples = [
+        '<%= config.bin %> <%= command.id %> path/to/app.apk',
+        '<%= config.bin %> <%= command.id %> path/to/app.zip --api-key YOUR_API_KEY',
+    ];
+    static flags = {
+        apiKey: constants_1.flags.apiKey,
+        apiUrl: constants_1.flags.apiUrl,
+        'ignore-sha-check': constants_1.flags['ignore-sha-check'],
+    };
+    static enableJsonFlag = true;
+    async run() {
+        try {
+            const { args, flags } = await this.parse(Upload);
+            const { appFile } = args;
+            const { apiKey: apiKeyFlag, apiUrl, 'ignore-sha-check': ignoreShaCheck, json, } = flags;
+            const apiKey = apiKeyFlag || process.env.DEVICE_CLOUD_API_KEY;
+            if (!apiKey) {
+                throw new Error('You must provide an API key via --api-key flag or DEVICE_CLOUD_API_KEY environment variable');
+            }
+            if (!['apk', '.app', '.zip'].some((ext) => appFile.endsWith(ext))) {
+                throw new Error('App file must be a .apk for android or .app/.zip file for iOS');
+            }
+            if (appFile.endsWith('.zip')) {
+                await (0, methods_1.verifyAppZip)(appFile);
+            }
+            this.log(`
+        Uploading app binary
+      → File: ${appFile}
+      `);
+            const appBinaryId = await (0, methods_1.uploadBinary)(appFile, apiUrl, apiKey, ignoreShaCheck, !json);
+            if (json) {
+                return { appBinaryId };
+            }
+            this.log(`\nUpload complete. Binary ID: ${appBinaryId}\n`);
+            this.log(`You can use this Binary ID in subsequent test runs with:`);
+            this.log(`dcd cloud --app-binary-id ${appBinaryId} path/to/flow.yaml\n`);
+        }
+        catch (error) {
+            this.error(error, { exit: 1 });
+        }
+    }
+}
+exports.default = Upload;

package/dist/constants.d.ts

@@ -11,6 +11,7 @@ export declare const flags: {
     async: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     'device-locale': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
     'download-artifacts': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    'artifacts-path': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
     env: import("@oclif/core/lib/interfaces").OptionFlag<string[] | undefined, 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>;

package/dist/constants.js

@@ -59,6 +59,10 @@ exports.flags = {
         description: 'Download a zip containing the logs, screenshots and videos for each result in this run. You will debited a $0.01 egress fee for each result. Use --download-artifacts=FAILED for failures only or --download-artifacts=ALL for every result.',
         options: ['ALL', 'FAILED'],
     }),
+    'artifacts-path': core_1.Flags.string({
+        description: 'Custom file path for downloaded artifacts (default: ./artifacts.zip)',
+        dependsOn: ['download-artifacts'],
+    }),
     env: core_1.Flags.file({
         char: 'e',
         description: 'One or more environment variables to inject into your flows',

package/dist/methods.d.ts

@@ -8,7 +8,7 @@ export declare const typeSafePost: <T extends keyof paths>(baseUrl: string, path
 export declare const typeSafePostDownload: (baseUrl: string, path: string, init?: {
     body?: BodyInit;
     headers?: HeadersInit;
-}) => Promise<void>;
+}, artifactsPath?: string) => Promise<void>;
 export declare const typeSafeGet: <T extends keyof paths>(baseUrl: string, path: string, init?: {
     body?: FormData;
     headers?: HeadersInit;

package/dist/methods.js

@@ -18,6 +18,8 @@ const StreamZip = require("node-stream-zip");
 const plist_1 = require("plist");
 const node_crypto_1 = require("node:crypto");
 const path = require("path");
+const node_path_1 = require("node:path");
+const os = require("node:os");
 const cloud_1 = require("./commands/cloud");
 const PERMITTED_EXTENSIONS = new Set([
     'yml',
@@ -40,7 +42,7 @@ const typeSafePost = async (baseUrl, path, init) => {
     return res.json();
 };
 exports.typeSafePost = typeSafePost;
-const typeSafePostDownload = async (baseUrl, path, init) => {
+const typeSafePostDownload = async (baseUrl, path, init, artifactsPath) => {
     const res = await fetch(baseUrl + path, {
         ...init,
         method: 'POST',
@@ -48,7 +50,25 @@ const typeSafePostDownload = async (baseUrl, path, init) => {
     if (!res.ok) {
         throw new Error(await res.text());
     }
-    const fileStream = (0, node_fs_1.createWriteStream)('./artifacts.zip', { flags: 'wx' });
+    let outputPath = artifactsPath || './artifacts.zip';
+    // Handle tilde expansion for home directory
+    if (outputPath.startsWith('~/') || outputPath === '~') {
+        outputPath = outputPath.replace(/^~(?=$|\/|\\)/, os.homedir());
+    }
+    // Create directory structure if it doesn't exist
+    const directory = (0, node_path_1.dirname)(outputPath);
+    if (directory !== '.') {
+        try {
+            (0, node_fs_1.mkdirSync)(directory, { recursive: true });
+        }
+        catch (error) {
+            // Ignore if directory already exists
+            if (error.code !== 'EEXIST') {
+                throw error;
+            }
+        }
+    }
+    const fileStream = (0, node_fs_1.createWriteStream)(outputPath, { flags: 'wx' });
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     await (0, promises_2.finished)(node_stream_1.Readable.fromWeb(res.body).pipe(fileStream));
 };

package/oclif.manifest.json

@@ -138,6 +138,16 @@
           ],
           "type": "option"
         },
+        "artifacts-path": {
+          "dependsOn": [
+            "download-artifacts"
+          ],
+          "description": "Custom file path for downloaded artifacts (default: ./artifacts.zip)",
+          "name": "artifacts-path",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "env": {
           "char": "e",
           "description": "One or more environment variables to inject into your flows",
@@ -414,7 +424,74 @@
         "commands",
         "status.js"
       ]
+    },
+    "upload": {
+      "aliases": [],
+      "args": {
+        "appFile": {
+          "description": "The binary file to upload (e.g. test.apk for android or test.app/.zip for ios)",
+          "name": "appFile",
+          "required": true
+        }
+      },
+      "description": "Upload an app binary to devicecloud.dev",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> path/to/app.apk",
+        "<%= config.bin %> <%= command.id %> path/to/app.zip --api-key YOUR_API_KEY"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "apiKey": {
+          "aliases": [
+            "api-key"
+          ],
+          "description": "API key for devicecloud.dev (find this in the console UI). You can also set the DEVICE_CLOUD_API_KEY environment variable.",
+          "name": "apiKey",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "apiUrl": {
+          "aliases": [
+            "api-url",
+            "apiURL"
+          ],
+          "description": "API base URL",
+          "hidden": true,
+          "name": "apiUrl",
+          "default": "https://api.devicecloud.dev",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "ignore-sha-check": {
+          "description": "Ignore the sha hash check and upload the binary regardless of whether it already exists (not recommended)",
+          "name": "ignore-sha-check",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "upload",
+      "pluginAlias": "@devicecloud.dev/dcd",
+      "pluginName": "@devicecloud.dev/dcd",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": true,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "upload.js"
+      ]
     }
   },
-  "version": "3.4.4"
+  "version": "3.5.1"
 }

package/package.json

@@ -80,7 +80,7 @@
     "test": "mocha --forbid-only \"test/**/*.test.ts\"",
     "version": "oclif readme && git add README.md"
   },
-  "version": "3.4.4",
+  "version": "3.5.1",
   "bugs": {
     "url": "https://discord.gg/gm3mJwcNw8"
   },