@devicecloud.dev/dcd 3.5.0 → 3.6.1

package/dist/commands/cloud.d.ts

@@ -39,8 +39,10 @@ export default class Cloud extends Command {
         'app-binary-id': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
         'app-file': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
         async: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        config: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
         '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, config: configFile, '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;
@@ -118,6 +118,19 @@ class Cloud extends core_1.Command {
                     throw new Error('runnerType m4 only supports iOS');
                 }
             }
+            if (runnerType === 'm1') {
+                this.log('Note: Runner Type m1 is experimental and currently supports Android only, iOS will revert to default.');
+                // todo - better platform checking
+                if (iOSDevice || iOSVersion) {
+                    this.log('runnerType m1 only supports Android, reverting to default');
+                    runnerType = 'default';
+                }
+                if (androidApiLevel || androidDevice) {
+                    this.log('Runner Type m1 only supports API Level 34 and Pixel 7, unsetting your android options.');
+                    androidApiLevel = undefined;
+                    androidDevice = undefined;
+                }
+            }
             const additionalAppBinaryIds = nonFlatAdditionalAppBinaryIds?.flat();
             const additionalAppFiles = nonFlatAdditionalAppFiles?.flat();
             const { firstFile, secondFile } = args;
@@ -164,7 +177,7 @@ class Cloud extends core_1.Command {
             }
             let executionPlan;
             try {
-                executionPlan = await (0, plan_1.plan)(flowFile, includeTags.flat(), excludeTags.flat(), excludeFlows.flat());
+                executionPlan = await (0, plan_1.plan)(flowFile, includeTags.flat(), excludeTags.flat(), excludeFlows.flat(), configFile);
             }
             catch (error) {
                 throw error;
@@ -375,9 +388,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/constants.d.ts

@@ -9,8 +9,10 @@ export declare const flags: {
     'app-binary-id': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
     'app-file': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
     async: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    config: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
     '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

@@ -52,6 +52,9 @@ exports.flags = {
     async: core_1.Flags.boolean({
         description: 'Immediately return (exit code 0) from the command without waiting for the results of the run (useful for saving CI minutes)',
     }),
+    config: core_1.Flags.file({
+        description: 'Path to custom config.yaml file. If not provided, defaults to config.yaml in root flows folders.',
+    }),
     'device-locale': core_1.Flags.string({
         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',
     }),
@@ -59,6 +62,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',
@@ -162,9 +169,9 @@ exports.flags = {
         description: 'Automatically retry the run up to the number of times specified (same as pressing retry in the UI) - this is free of charge',
     }),
     'runner-type': core_1.Flags.string({
-        description: '[iOS only] [experimental] The type of runner to use - note: anything other than default will incur advanced pricing tiers',
+        description: '[experimental] The type of runner to use - note: anything other than default will incur premium pricing tiers, see https://docs.devicecloud.dev/reference/runner-type for more information',
         default: 'default',
-        options: ['default', 'm4'],
+        options: ['default', 'm4', 'm1'],
     }),
     report: core_1.Flags.string({
         aliases: ['format'],

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/dist/plan.d.ts

@@ -25,5 +25,5 @@ interface IFlowSequence {
     continueOnFailure?: boolean;
     flows: string[];
 }
-export declare function plan(input: string, includeTags: string[], excludeTags: string[], excludeFlows?: string[]): Promise<IExecutionPlan>;
+export declare function plan(input: string, includeTags: string[], excludeTags: string[], excludeFlows?: string[], configFile?: string): Promise<IExecutionPlan>;
 export {};

package/dist/plan.js

@@ -52,7 +52,7 @@ function getWorkspaceConfig(input, unfilteredFlowFiles) {
         : {};
     return config;
 }
-async function plan(input, includeTags, excludeTags, excludeFlows) {
+async function plan(input, includeTags, excludeTags, excludeFlows, configFile) {
     const normalizedInput = path.normalize(input);
     if (!fs.existsSync(normalizedInput)) {
         throw new Error(`Flow path does not exist: ${path.resolve(normalizedInput)}`);
@@ -60,7 +60,7 @@ async function plan(input, includeTags, excludeTags, excludeFlows) {
     if (fs.lstatSync(normalizedInput).isFile()) {
         if (normalizedInput.endsWith('config.yaml') ||
             normalizedInput.endsWith('config.yml')) {
-            throw new Error('If using config.yaml, pass the workspace folder path, not the config file');
+            throw new Error('If using config.yaml, pass the workspace folder path, not the config file or a custom path via --config');
         }
         const checkedDependancies = await checkDependencies(normalizedInput);
         return {
@@ -74,7 +74,17 @@ async function plan(input, includeTags, excludeTags, excludeFlows) {
         throw new Error(`Flow directory does not contain any Flow files: ${path.resolve(normalizedInput)}`);
     }
     unfilteredFlowFiles = filterFlowFiles(unfilteredFlowFiles, excludeFlows);
-    const workspaceConfig = getWorkspaceConfig(normalizedInput, unfilteredFlowFiles);
+    let workspaceConfig;
+    if (configFile) {
+        const configFilePath = path.resolve(process.cwd(), configFile);
+        if (!fs.existsSync(configFilePath)) {
+            throw new Error(`Config file does not exist: ${configFilePath}`);
+        }
+        workspaceConfig = (0, planMethods_1.readYamlFileAsJson)(configFilePath);
+    }
+    else {
+        workspaceConfig = getWorkspaceConfig(normalizedInput, unfilteredFlowFiles);
+    }
     if (workspaceConfig.flows) {
         const globs = workspaceConfig.flows.map((glob) => glob);
         const matchedFiles = await (0, glob_1.glob)(globs, {
@@ -84,12 +94,16 @@ async function plan(input, includeTags, excludeTags, excludeFlows) {
         // overwrite the list of files with the globbed ones
         unfilteredFlowFiles = matchedFiles
             .filter((file) => file !== 'config.yaml' &&
+            file !== 'config.yml' &&
+            (!configFile || file !== path.basename(configFile)) &&
             (file.endsWith('.yaml') || file.endsWith('.yml')))
             .map((file) => path.resolve(normalizedInput, file));
     }
     else {
         // workspace config has no flows, so we need to remove the config file from the test list
-        unfilteredFlowFiles = unfilteredFlowFiles.filter((file) => !file.endsWith('config.yaml') && !file.endsWith('config.yml'));
+        unfilteredFlowFiles = unfilteredFlowFiles.filter((file) => !file.endsWith('config.yaml') &&
+            !file.endsWith('config.yml') &&
+            (!configFile || !file.endsWith(configFile)));
     }
     if (unfilteredFlowFiles.length === 0) {
         const error = workspaceConfig.flows

package/oclif.manifest.json

@@ -120,6 +120,13 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "config": {
+          "description": "Path to custom config.yaml file. If not provided, defaults to config.yaml in root flows folders.",
+          "name": "config",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "device-locale": {
           "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",
           "name": "device-locale",
@@ -138,6 +145,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",
@@ -300,14 +317,15 @@
           "type": "option"
         },
         "runner-type": {
-          "description": "[iOS only] [experimental] The type of runner to use - note: anything other than default will incur advanced pricing tiers",
+          "description": "[experimental] The type of runner to use - note: anything other than default will incur premium pricing tiers, see https://docs.devicecloud.dev/reference/runner-type for more information",
           "name": "runner-type",
           "default": "default",
           "hasDynamicHelp": false,
           "multiple": false,
           "options": [
             "default",
-            "m4"
+            "m4",
+            "m1"
           ],
           "type": "option"
         },
@@ -483,5 +501,5 @@
       ]
     }
   },
-  "version": "3.5.0"
+  "version": "3.6.1"
 }

package/package.json

@@ -71,16 +71,15 @@
   "scripts": {
     "dcd": "./bin/dev.js",
     "prod": "./bin/run.js",
-    "build": "shx rm -rf dist && tsc -b",
+    "build": "shx rm -rf dist && tsc -b", 
     "lint": "eslint . --ext .ts",
     "postpack": "shx rm -f oclif.manifest.json",
     "posttest": "yarn lint",
     "prepack": "yarn build && oclif manifest",
     "prepare": "yarn build",
-    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
     "version": "oclif readme && git add README.md"
   },
-  "version": "3.5.0",
+  "version": "3.6.1",
   "bugs": {
     "url": "https://discord.gg/gm3mJwcNw8"
   },