@devicecloud.dev/dcd 0.0.4 → 0.0.6

package/dist/commands/cloud.js

@@ -36,7 +36,7 @@ var EiOSDevices;
 class Cloud extends core_1.Command {
     static args = {
         firstFile: core_1.Args.string({
-            description: 'The binary file of the app to run your flow against, e.g. app.apk for android or app.zip for ios',
+            description: 'The binary file of the app to run your flow against, e.g. test.apk for android or test.app/.zip for ios',
             hidden: true,
             name: 'App file',
         }),
@@ -51,6 +51,7 @@ class Cloud extends core_1.Command {
     static flags = constants_1.flags;
     async run() {
         try {
+            await (0, methods_1.versionCheck)(this.config.version);
             const { args, flags, raw } = await this.parse(Cloud);
             const { 'android-api-level': androidApiLevel, 'android-device': androidDevice, apiKey, apiUrl, 'app-binary-id': appBinaryId, 'app-file': appFile, arm64, async, env, 'exclude-tags': excludeTags, flows, 'google-play': googlePlay, 'include-tags': includeTags, 'ios-device': iOSDevice, 'ios-version': iOSVersion, name, orientation, ...rest } = flags;
             if (arm64) {
@@ -98,8 +99,8 @@ class Cloud extends core_1.Command {
                 if (!(flowFile && finalAppFile)) {
                     throw new Error('You must provide a flow file and an app binary id');
                 }
-                if (!finalAppFile.endsWith('.apk') && !finalAppFile.endsWith('.zip')) {
-                    throw new Error('App file must be a .apk or .zip file');
+                if (!['apk', '.app', '.zip'].some((ext) => finalAppFile.endsWith(ext))) {
+                    throw new Error('App file must be a .apk for android or .app/.zip file for iOS');
                 }
                 if (finalAppFile.endsWith('.zip')) {
                     await (0, methods_1.verifyAppZip)(finalAppFile);
@@ -125,10 +126,16 @@ class Cloud extends core_1.Command {
             if (!finalBinaryId) {
                 core_1.ux.action.start('Uploading binary', 'Initializing', { stdout: true });
                 const binaryFormData = new FormData();
-                const binaryBlob = new Blob([await (0, promises_1.readFile)(finalAppFile)], {
-                    type: mimeTypeLookupByExtension[finalAppFile.split('.').pop()],
-                });
-                binaryFormData.set('file', binaryBlob, finalAppFile);
+                if (finalAppFile?.endsWith('.app')) {
+                    const zippedAppBlob = await (0, methods_1.compressFolderToBlob)(finalAppFile);
+                    binaryFormData.set('file', zippedAppBlob, finalAppFile + '.zip');
+                }
+                else {
+                    const binaryBlob = new Blob([await (0, promises_1.readFile)(finalAppFile)], {
+                        type: mimeTypeLookupByExtension[finalAppFile.split('.').pop()],
+                    });
+                    binaryFormData.set('file', binaryBlob, finalAppFile);
+                }
                 const options = {
                     body: binaryFormData,
                     headers: { 'x-app-api-key': apiKey },
@@ -171,6 +178,7 @@ class Cloud extends core_1.Command {
                 continueOnFailure,
                 orientation,
                 raw,
+                version: this.config.version,
             }));
             if (androidApiLevel)
                 testFormData.set('androidApiLevel', androidApiLevel.toString());

package/dist/methods.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
 import * as archiver from 'archiver';
 import { paths } from '../../api/schema.types';
+export declare const versionCheck: (currentVersion: string) => Promise<void>;
 export declare const typeSafePost: <T extends keyof paths>(baseUrl: string, path: string, init?: {
     body?: FormData;
     headers?: HeadersInit;
@@ -11,5 +12,6 @@ export declare const typeSafeGet: <T extends keyof paths>(baseUrl: string, path:
 }) => Promise<paths[T]["get"]["responses"]["200"]["content"]["application/json"]>;
 export declare const toBuffer: (archive: archiver.Archiver) => Promise<Buffer>;
 export declare const compressDir: (sourceDir: string) => Promise<Buffer>;
+export declare const compressFolderToBlob: (sourceDir: string) => Promise<Blob>;
 export declare const compressFilesFromRelativePath: (path: string, files: string[]) => Promise<Buffer>;
 export declare const verifyAppZip: (zipPath: string) => Promise<void>;

package/dist/methods.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.verifyAppZip = exports.compressFilesFromRelativePath = exports.compressDir = exports.toBuffer = exports.typeSafeGet = exports.typeSafePost = void 0;
+exports.verifyAppZip = exports.compressFilesFromRelativePath = exports.compressFolderToBlob = exports.compressDir = exports.toBuffer = exports.typeSafeGet = exports.typeSafePost = exports.versionCheck = void 0;
+const cli_ux_1 = require("@oclif/core/lib/cli-ux");
 const archiver = require("archiver");
 // import { writeFile } from 'node:fs/promises';
 const nodePath = require("node:path");
@@ -16,6 +17,20 @@ const PERMITTED_EXTENSIONS = new Set([
     'mp4',
     'js',
 ]);
+const versionCheck = async (currentVersion) => {
+    const versionResponse = await fetch('https://registry.npmjs.org/@devicecloud.dev/dcd/latest');
+    const versionResponseJson = await versionResponse.json();
+    const latestVersion = versionResponseJson.version;
+    if (latestVersion !== currentVersion) {
+        (0, cli_ux_1.warn)(`
+-------------------
+A new version of the devicecloud.dev CLI is available: ${latestVersion}
+Run 'npm install -g @devicecloud.dev/dcd' to update to the latest version
+-------------------
+`);
+    }
+};
+exports.versionCheck = versionCheck;
 const typeSafePost = async (baseUrl, path, init) => {
     const res = await fetch(baseUrl + path, { ...init, method: 'POST' });
     if (!res.ok) {
@@ -68,6 +83,18 @@ const compressDir = async (sourceDir) => {
     return buffer;
 };
 exports.compressDir = compressDir;
+const compressFolderToBlob = async (sourceDir) => {
+    const archive = archiver('zip', {
+        zlib: { level: 9 },
+    });
+    archive.on('error', (err) => {
+        throw err;
+    });
+    archive.directory(sourceDir, sourceDir.split('/').pop());
+    const buffer = await (0, exports.toBuffer)(archive);
+    return new Blob([buffer], { type: 'application/zip' });
+};
+exports.compressFolderToBlob = compressFolderToBlob;
 const compressFilesFromRelativePath = async (path, files) => {
     const archive = archiver('zip', {
         zlib: { level: 9 },

package/dist/plan.js

@@ -1,35 +1,26 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.plan = void 0;
-/* eslint-disable complexity */
 const glob_1 = require("glob");
 const fs = require("node:fs");
 const path = require("node:path");
 const planMethods_1 = require("./planMethods");
-const commandsThatRequireFiles = new Set(['addMedia', 'runFlow', 'runScript']);
 async function plan(input, includeTags, excludeTags) {
     if (!fs.existsSync(input)) {
         throw new Error(`Flow path does not exist: ${path.resolve(input)}`);
     }
     if (fs.lstatSync(input).isFile()) {
-        const directory = path.dirname(input);
-        const { testSteps } = (0, planMethods_1.readTestYamlFileAsJson)(input);
-        let errors = [];
-        let allFiles = [];
-        for (const command of testSteps) {
-            if (typeof command === 'string')
-                continue;
-            for (const [commandName, commandValue] of Object.entries(command)) {
-                if (commandsThatRequireFiles.has(commandName)) {
-                    const { errors: newErrors, files } = (0, planMethods_1.checkIfFilesExistInWorkspace)(commandName, commandValue, path.normalize(input), directory + '/');
-                    errors = [...errors, ...newErrors];
-                    allFiles = [...allFiles, ...files];
-                }
-            }
-        }
-        if (errors.length > 0) {
+        const directory = path.dirname(input) + '/';
+        const { config, testSteps } = (0, planMethods_1.readTestYamlFileAsJson)(input);
+        const { allErrors, allFiles } = (0, planMethods_1.processDependencies)({
+            config,
+            directory,
+            input,
+            testSteps,
+        });
+        if (allErrors.length > 0) {
             throw new Error('The following flow files are not present in the provided directory: \n' +
-                errors.join('\n'));
+                allErrors.join('\n'));
         }
         return {
             flowsToRun: [input.split('/').pop() ?? input],
@@ -84,20 +75,17 @@ async function plan(input, includeTags, excludeTags) {
     });
     let errors = [];
     let allFiles = [];
-    for (const [filePath, commands] of Object.entries(testStepsPerFlowFile)) {
-        if (!commands)
+    for (const [filePath, testSteps] of Object.entries(testStepsPerFlowFile)) {
+        if (!testSteps)
             break;
-        for (const command of commands) {
-            if (typeof command === 'string')
-                continue;
-            for (const [commandName, commandValue] of Object.entries(command)) {
-                if (commandsThatRequireFiles.has(commandName)) {
-                    const { errors: newErrors, files } = (0, planMethods_1.checkIfFilesExistInWorkspace)(commandName, commandValue, filePath, cleanPath);
-                    errors = [...errors, ...newErrors];
-                    allFiles = [...allFiles, ...files];
-                }
-            }
-        }
+        const { allErrors: errs, allFiles: deps } = (0, planMethods_1.processDependencies)({
+            config: configPerFlowFile[path.relative(cleanPath, filePath)],
+            directory: cleanPath,
+            input: filePath,
+            testSteps,
+        });
+        allFiles = [...allFiles, ...deps];
+        errors = [...errors, ...errs];
     }
     if (errors.length > 0) {
         throw new Error('The following flow files are not present in the provided directory: \n' +
@@ -132,19 +120,6 @@ async function plan(input, includeTags, excludeTags) {
         ?.map((flowOrder) => (0, planMethods_1.getFlowsToRunInSequence)(pathsByName, [flowOrder]))
         .flat() || [];
     const normalFlows = allFlows.filter((flow) => !flowsToRunInSequence.includes(flow));
-    // for (const filePath of allFlows) {
-    //   const commands = YamlCommandReader.readCommands(filePath).filter(
-    //     (command) => command.addMediaCommand,
-    //   );
-    //   const mediaPaths = commands.flatMap(
-    //     (command) => command.addMediaCommand.mediaPaths,
-    //   );
-    //   YamlCommandsPathValidator.validatePathsExistInWorkspace(
-    //     input,
-    //     filePath,
-    //     mediaPaths,
-    //   );
-    // }
     return {
         allExcludeTags,
         allIncludeTags,

package/dist/planMethods.d.ts

@@ -15,3 +15,14 @@ export declare const checkIfFilesExistInWorkspace: (commandName: string, command
     errors: string[];
     files: string[];
 };
+interface IProcessDependencies {
+    config?: Record<string, unknown> | null;
+    directory: string;
+    input: string;
+    testSteps: Record<string, unknown>[];
+}
+export declare const processDependencies: ({ config, directory, input, testSteps, }: IProcessDependencies) => {
+    allErrors: string[];
+    allFiles: string[];
+};
+export {};

package/dist/planMethods.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkIfFilesExistInWorkspace = exports.walk = exports.readTestYamlFileAsJson = exports.readYamlFileAsJson = exports.isFlowFile = exports.getFlowsToRunInSequence = void 0;
+exports.processDependencies = exports.checkIfFilesExistInWorkspace = exports.walk = exports.readTestYamlFileAsJson = exports.readYamlFileAsJson = exports.isFlowFile = exports.getFlowsToRunInSequence = void 0;
 /* eslint-disable unicorn/filename-case */
 const yaml = require("js-yaml");
 const fs = require("node:fs");
 const path = require("node:path");
+const commandsThatRequireFiles = new Set(['addMedia', 'runFlow', 'runScript']);
 function getFlowsToRunInSequence(paths, flowOrder) {
     if (flowOrder.length === 0)
         return [];
@@ -77,7 +78,7 @@ const checkIfFilesExistInWorkspace = (commandName, command, filePath, cleanPath)
     const errors = [];
     const files = [];
     const directory = path.dirname(filePath);
-    const buildError = (error) => `Flow file "${filePath}" has a command "${commandName}" that references a ${error} "${command}"`;
+    const buildError = (error) => `Flow file "${filePath.replace(cleanPath, './')}" has a command "${commandName}" that references a ${error} ${JSON.stringify(command)}`;
     const processFilePath = (relativePath) => {
         const absoluteFilePath = path.resolve(directory, relativePath);
         const error = checkFile(absoluteFilePath, cleanPath);
@@ -107,3 +108,49 @@ const checkFile = (filePath, cleanPath) => {
     if (!filePath.startsWith(cleanPath))
         return `file outside the workspace`;
 };
+const checkStepsArray = (steps, input, directory) => {
+    let errors = [];
+    let files = [];
+    for (const command of steps) {
+        if (typeof command === 'string')
+            continue;
+        for (const [commandName, commandValue] of Object.entries(command)) {
+            if (commandsThatRequireFiles.has(commandName)) {
+                const { errors: newErrors, files: newFiles } = (0, exports.checkIfFilesExistInWorkspace)(commandName, commandValue, path.normalize(input), directory);
+                errors = [...errors, ...newErrors];
+                files = [...files, ...newFiles];
+            }
+            const nestedCommands = typeof commandValue === 'object' &&
+                commandValue.commands;
+            if (nestedCommands) {
+                const { errors: newErrors, files: newFiles } = checkStepsArray(nestedCommands, input, directory);
+                errors = [...errors, ...newErrors];
+                files = [...files, ...newFiles];
+            }
+        }
+    }
+    return { errors, files };
+};
+const processDependencies = ({ config, directory, input, testSteps, }) => {
+    let allErrors = [];
+    let allFiles = [];
+    const { onFlowComplete, onFlowStart } = config ?? {};
+    const stepsArray = [testSteps];
+    if (onFlowStart)
+        stepsArray.push(onFlowStart);
+    if (onFlowComplete)
+        stepsArray.push(onFlowComplete);
+    for (const [index, steps] of stepsArray.entries()) {
+        try {
+            const { errors, files } = checkStepsArray(steps, input, directory);
+            allErrors = [...allErrors, ...errors];
+            allFiles = [...allFiles, ...files];
+        }
+        catch {
+            const location = ['Test Steps', 'On Flow Start', 'On Flow Complete'][index];
+            throw new Error(`Error processing dependencies for file ${input} in the ${location} section. Expected an array of steps but received: ${JSON.stringify(steps)}`);
+        }
+    }
+    return { allErrors, allFiles };
+};
+exports.processDependencies = processDependencies;

package/oclif.manifest.json

@@ -4,7 +4,7 @@
       "aliases": [],
       "args": {
         "firstFile": {
-          "description": "The binary file of the app to run your flow against, e.g. app.apk for android or app.zip for ios",
+          "description": "The binary file of the app to run your flow against, e.g. test.apk for android or test.app/.zip for ios",
           "hidden": true,
           "name": "firstFile"
         },
@@ -220,5 +220,5 @@
       ]
     }
   },
-  "version": "0.0.4"
+  "version": "0.0.6"
 }

package/package.json

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