@shopify/shop-minis-cli 0.0.35

package/README.md

@@ -0,0 +1,8 @@
+# Shop Minis CLI
+
+A CLI tool to create, run and publish Shop Minis.
+
+## Getting started
+
+Use this CLI tool to create a new Shop Mini by running `npm init @shopify/shop-mini` or `yarn create @shopify/shop-mini`.
+Follow the instructions in the console to run your mini.

package/build/commands/create-mini/index.d.ts

@@ -0,0 +1,2 @@
+import { Command } from 'commander';
+export declare function loadCommand(parentProgram: Command): void;

package/build/commands/create-mini/index.js

@@ -0,0 +1,116 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadCommand = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const commander_1 = require("commander");
+const prompts_1 = __importDefault(require("prompts"));
+const chalk_1 = __importDefault(require("chalk"));
+const lodash_1 = __importDefault(require("lodash"));
+const exec_async_child_process_1 = require("../utils/exec-async-child-process");
+const wrap_with_loading_indicator_1 = require("../utils/wrap-with-loading-indicator");
+const template_app_1 = require("./utils/template-app");
+function logSuccess(handle, useYarn, outputDir = '.') {
+    console.log(`\n \nShop Mini`, chalk_1.default.green.bold(`${handle}`), 'created. Next steps:\n');
+    const currentPath = `${process.cwd()}/`;
+    const cdAbsolutePath = path_1.default.resolve(outputDir, handle);
+    const cdPath = cdAbsolutePath.startsWith(currentPath)
+        ? cdAbsolutePath.replace(currentPath, '')
+        : cdAbsolutePath;
+    console.log(chalk_1.default.cyan.bold(`  cd ${cdPath}`));
+    console.log(chalk_1.default.dim('  Open your Shop Mini’s directory\n'));
+    console.log(chalk_1.default.cyan.bold(`  ↪ ${useYarn ? 'yarn' : 'npm'} start`));
+    console.log(chalk_1.default.dim('    Run Shop Mini, and open it on an iOS or Android device.\n'));
+    console.log(chalk_1.default.cyan('  ↪ ') +
+        chalk_1.default.cyan.underline.bold('https://shop.app/minis/docs/'));
+    console.log(chalk_1.default.dim('    Shop Minis documentation.\n \n'));
+}
+async function promptUser(miniNameArg) {
+    const questions = [];
+    if (miniNameArg === undefined) {
+        questions.push({
+            type: 'text',
+            name: 'miniName',
+            message: `Give your Shop Mini a name. ${chalk_1.default.dim('You can change it later.\n')}`,
+        });
+    }
+    questions.push({
+        type: 'select',
+        name: 'templateName',
+        message: 'Select a template',
+        choices: [
+            {
+                title: 'Snowdevil',
+                description: 'Example of a Shop Mini using prebuilt components',
+                value: 'snowboardz',
+            },
+            {
+                title: 'Hello World',
+                description: 'Prebuilt components you can play around with',
+                value: 'hello_world',
+            },
+            {
+                title: 'Blank',
+                value: 'blank',
+                description: 'A blank canvas so you can create from scratch',
+            },
+        ],
+        initial: 0,
+    });
+    const onCancel = () => {
+        console.log('\nShop Mini creation stopped at your request. Name not saved.\n');
+        process.exit(0);
+    };
+    const response = await prompts_1.default.prompt(questions, { onCancel });
+    return {
+        miniName: miniNameArg || response.miniName,
+        templateName: response.templateName,
+    };
+}
+function loadCommand(parentProgram) {
+    const command = new commander_1.Command()
+        .name('create')
+        .description('Create a new Shop Mini')
+        .argument('[mini name]', 'the name of your mini')
+        .option('--useYarn', 'Use yarn as package manager instead of npm')
+        .option('--output-dir [path]', 'Specify an output directory for the mini')
+        .action(async (miniNameArg, options = {}) => {
+        const outputDir = options.outputDir ?? '.';
+        if (!fs_1.default.existsSync(outputDir)) {
+            console.error(`Unable to create a mini at the specified output dir of ${outputDir}`);
+            process.exit(1);
+        }
+        try {
+            const { miniName, templateName } = await promptUser(miniNameArg);
+            const handle = lodash_1.default.kebabCase(miniName);
+            await (0, wrap_with_loading_indicator_1.wrapWithLoadingIndicator)((0, template_app_1.generateMiniFromTemplate)(miniName, handle, templateName, outputDir), {
+                loadingMessage: 'Fetching template...',
+                successMessage: 'Template fetched',
+            });
+            // Yarn is ignoring the `resolutions` when you install
+            // via `yarn create @shopify/shop-mini` so use `--ignore-engines` to work around the
+            // problem with `@apollo/federation`
+            // npm fails to install for a similar reason on node 15 but runs fine so we will
+            // use `--force` to get everything installed
+            const installCmd = options.useYarn
+                ? 'yarn --ignore-engines'
+                : 'npm i --force';
+            await (0, exec_async_child_process_1.execAsync)({
+                cmd: `cd ${path_1.default.resolve(outputDir, handle)} && ${installCmd}`,
+                loadingMessage: 'Installing dependencies. This might take a minute...',
+                successMessage: 'Dependencies installed',
+            });
+            logSuccess(handle, options.useYarn, outputDir);
+        }
+        catch (err) {
+            console.error(err?.message || err);
+            process.exit(1);
+        }
+    });
+    parentProgram.addCommand(command);
+}
+exports.loadCommand = loadCommand;
+//# sourceMappingURL=index.js.map

package/build/commands/create-mini/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/commands/create-mini/index.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAmB;AACnB,gDAAuB;AAEvB,yCAAiC;AACjC,sDAA6C;AAC7C,kDAAyB;AACzB,oDAAsB;AAEtB,gFAA2D;AAC3D,sFAA6E;AAE7E,uDAA6D;AAE7D,SAAS,UAAU,CAAC,MAAc,EAAE,OAAiB,EAAE,SAAS,GAAG,GAAG;IACpE,OAAO,CAAC,GAAG,CACT,gBAAgB,EAChB,eAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,MAAM,EAAE,CAAC,EAC7B,wBAAwB,CACzB,CAAA;IAED,MAAM,WAAW,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,GAAG,CAAA;IACvC,MAAM,cAAc,GAAG,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,CAAA;IACtD,MAAM,MAAM,GAAG,cAAc,CAAC,UAAU,CAAC,WAAW,CAAC;QACnD,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC;QACzC,CAAC,CAAC,cAAc,CAAA;IAElB,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,MAAM,EAAE,CAAC,CAAC,CAAA;IAC9C,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,GAAG,CAAC,qCAAqC,CAAC,CAAC,CAAA;IAE7D,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAA;IACrE,OAAO,CAAC,GAAG,CACT,eAAK,CAAC,GAAG,CAAC,+DAA+D,CAAC,CAC3E,CAAA;IAED,OAAO,CAAC,GAAG,CACT,eAAK,CAAC,IAAI,CAAC,MAAM,CAAC;QAChB,eAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAC5D,CAAA;IACD,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,GAAG,CAAC,oCAAoC,CAAC,CAAC,CAAA;AAC9D,CAAC;AAED,KAAK,UAAU,UAAU,CAAC,WAAoB;IAC5C,MAAM,SAAS,GAAwB,EAAE,CAAA;IAEzC,IAAI,WAAW,KAAK,SAAS,EAAE;QAC7B,SAAS,CAAC,IAAI,CAAC;YACb,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,UAAU;YAChB,OAAO,EAAE,+BAA+B,eAAK,CAAC,GAAG,CAC/C,4BAA4B,CAC7B,EAAE;SACJ,CAAC,CAAA;KACH;IAED,SAAS,CAAC,IAAI,CAAC;QACb,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,cAAc;QACpB,OAAO,EAAE,mBAAmB;QAC5B,OAAO,EAAE;YACP;gBACE,KAAK,EAAE,WAAW;gBAClB,WAAW,EAAE,kDAAkD;gBAC/D,KAAK,EAAE,YAAY;aACpB;YACD;gBACE,KAAK,EAAE,aAAa;gBACpB,WAAW,EAAE,8CAA8C;gBAC3D,KAAK,EAAE,aAAa;aACrB;YACD;gBACE,KAAK,EAAE,OAAO;gBACd,KAAK,EAAE,OAAO;gBACd,WAAW,EAAE,+CAA+C;aAC7D;SACF;QACD,OAAO,EAAE,CAAC;KACX,CAAC,CAAA;IAEF,MAAM,QAAQ,GAAG,GAAG,EAAE;QACpB,OAAO,CAAC,GAAG,CACT,iEAAiE,CAClE,CAAA;QACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACjB,CAAC,CAAA;IACD,MAAM,QAAQ,GAAG,MAAM,iBAAO,CAAC,MAAM,CAAC,SAAS,EAAE,EAAC,QAAQ,EAAC,CAAC,CAAA;IAC5D,OAAO;QACL,QAAQ,EAAE,WAAW,IAAI,QAAQ,CAAC,QAAQ;QAC1C,YAAY,EAAE,QAAQ,CAAC,YAAY;KACpC,CAAA;AACH,CAAC;AAED,SAAgB,WAAW,CAAC,aAAsB;IAChD,MAAM,OAAO,GAAG,IAAI,mBAAO,EAAE;SAC1B,IAAI,CAAC,QAAQ,CAAC;SACd,WAAW,CAAC,wBAAwB,CAAC;SACrC,QAAQ,CAAC,aAAa,EAAE,uBAAuB,CAAC;SAChD,MAAM,CAAC,WAAW,EAAE,4CAA4C,CAAC;SACjE,MAAM,CAAC,qBAAqB,EAAE,0CAA0C,CAAC;SACzE,MAAM,CACL,KAAK,EACH,WAAoB,EACpB,UAAmD,EAAE,EACrD,EAAE;QACF,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,GAAG,CAAA;QAC1C,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;YAC7B,OAAO,CAAC,KAAK,CACX,0DAA0D,SAAS,EAAE,CACtE,CAAA;YACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;SAChB;QAED,IAAI;YACF,MAAM,EAAC,QAAQ,EAAE,YAAY,EAAC,GAAG,MAAM,UAAU,CAAC,WAAW,CAAC,CAAA;YAC9D,MAAM,MAAM,GAAG,gBAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAA;YAEpC,MAAM,IAAA,sDAAwB,EAC5B,IAAA,uCAAwB,EAAC,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,SAAS,CAAC,EACnE;gBACE,cAAc,EAAE,sBAAsB;gBACtC,cAAc,EAAE,kBAAkB;aACnC,CACF,CAAA;YAED,sDAAsD;YACtD,oFAAoF;YACpF,oCAAoC;YACpC,gFAAgF;YAChF,4CAA4C;YAC5C,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO;gBAChC,CAAC,CAAC,uBAAuB;gBACzB,CAAC,CAAC,eAAe,CAAA;YACnB,MAAM,IAAA,oCAAS,EAAC;gBACd,GAAG,EAAE,MAAM,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,OAAO,UAAU,EAAE;gBAC7D,cAAc,EACZ,sDAAsD;gBACxD,cAAc,EAAE,wBAAwB;aACzC,CAAC,CAAA;YACF,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;SAC/C;QAAC,OAAO,GAAQ,EAAE;YACjB,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,OAAO,IAAI,GAAG,CAAC,CAAA;YAClC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;SAChB;IACH,CAAC,CACF,CAAA;IAEH,aAAa,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;AACnC,CAAC;AAvDD,kCAuDC"}

package/build/commands/create-mini/utils/template-app.d.ts

@@ -0,0 +1 @@
+export declare function generateMiniFromTemplate(name: string, handle: string, templateName: string, outputDir?: string): Promise<void>;

package/build/commands/create-mini/utils/template-app.js

@@ -0,0 +1,44 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateMiniFromTemplate = void 0;
+const path_1 = __importDefault(require("path"));
+const os_1 = __importDefault(require("os"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const replace_in_file_1 = require("replace-in-file");
+const lodash_1 = __importDefault(require("lodash"));
+async function replaceStringsInTemplate(dir, stringsToReplace) {
+    for (const [replaceKey, replaceValue] of Object.entries(stringsToReplace)) {
+        const replaceOptions = {
+            files: [`${dir}/**/*.*`],
+            from: new RegExp(replaceKey, 'g'),
+            to: replaceValue,
+            optionsForFiles: {
+                ignore: ['**/node_modules/**'],
+            },
+        };
+        await (0, replace_in_file_1.replaceInFile)(replaceOptions);
+    }
+}
+async function generateMiniFromTemplate(name, handle, templateName, outputDir = '.') {
+    const tmpDir = await fs_extra_1.default.mkdtemp(path_1.default.join(os_1.default.tmpdir(), `${handle}-`));
+    const miniTemplateDir = await path_1.default.join(__dirname, '../../../../templates', `__template_${templateName}`);
+    const miniDestinationDir = path_1.default.resolve(process.cwd(), outputDir, handle);
+    const CLIVersion = require('../../../../package.json').version; // eslint-disable-line @typescript-eslint/no-var-requires
+    const stringsToReplace = {
+        __MINI_APP_NAME__: name,
+        __MINI_APP_HANDLE_PASCAL_CASE__: lodash_1.default.startCase(handle).replace(/ /g, ''),
+        __MINI_APP_HANDLE_KEBAB_CASE__: handle,
+        __SHOP_MINIS_CLI_VERSION__: CLIVersion,
+    };
+    const commonTemplateFilesDir = await path_1.default.join(__dirname, '../../../../templates', '__template_common');
+    await fs_extra_1.default.copy(commonTemplateFilesDir, tmpDir);
+    await fs_extra_1.default.copy(miniTemplateDir, tmpDir);
+    await fs_extra_1.default.move(path_1.default.join(tmpDir, 'gitignore'), path_1.default.join(tmpDir, '.gitignore'));
+    await replaceStringsInTemplate(tmpDir, stringsToReplace);
+    await fs_extra_1.default.copy(tmpDir, miniDestinationDir);
+}
+exports.generateMiniFromTemplate = generateMiniFromTemplate;
+//# sourceMappingURL=template-app.js.map

package/build/commands/create-mini/utils/template-app.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"template-app.js","sourceRoot":"","sources":["../../../../src/commands/create-mini/utils/template-app.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAuB;AACvB,4CAAmB;AAEnB,wDAAyB;AACzB,qDAA6C;AAC7C,oDAAsB;AAEtB,KAAK,UAAU,wBAAwB,CACrC,GAAW,EACX,gBAAwC;IAExC,KAAK,MAAM,CAAC,UAAU,EAAE,YAAY,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE;QACzE,MAAM,cAAc,GAAG;YACrB,KAAK,EAAE,CAAC,GAAG,GAAG,SAAS,CAAC;YACxB,IAAI,EAAE,IAAI,MAAM,CAAC,UAAU,EAAE,GAAG,CAAC;YACjC,EAAE,EAAE,YAAY;YAChB,eAAe,EAAE;gBACf,MAAM,EAAE,CAAC,oBAAoB,CAAC;aAC/B;SACF,CAAA;QAED,MAAM,IAAA,+BAAa,EAAC,cAAc,CAAC,CAAA;KACpC;AACH,CAAC;AAEM,KAAK,UAAU,wBAAwB,CAC5C,IAAY,EACZ,MAAc,EACd,YAAoB,EACpB,SAAS,GAAG,GAAG;IAEf,MAAM,MAAM,GAAG,MAAM,kBAAE,CAAC,OAAO,CAAC,cAAI,CAAC,IAAI,CAAC,YAAE,CAAC,MAAM,EAAE,EAAE,GAAG,MAAM,GAAG,CAAC,CAAC,CAAA;IACrE,MAAM,eAAe,GAAG,MAAM,cAAI,CAAC,IAAI,CACrC,SAAS,EACT,uBAAuB,EACvB,cAAc,YAAY,EAAE,CAC7B,CAAA;IACD,MAAM,kBAAkB,GAAG,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,MAAM,CAAC,CAAA;IAEzE,MAAM,UAAU,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAAC,OAAO,CAAA,CAAC,yDAAyD;IACxH,MAAM,gBAAgB,GAAG;QACvB,iBAAiB,EAAE,IAAI;QACvB,+BAA+B,EAAE,gBAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;QACtE,8BAA8B,EAAE,MAAM;QACtC,0BAA0B,EAAE,UAAU;KACvC,CAAA;IAED,MAAM,sBAAsB,GAAG,MAAM,cAAI,CAAC,IAAI,CAC5C,SAAS,EACT,uBAAuB,EACvB,mBAAmB,CACpB,CAAA;IAED,MAAM,kBAAE,CAAC,IAAI,CAAC,sBAAsB,EAAE,MAAM,CAAC,CAAA;IAC7C,MAAM,kBAAE,CAAC,IAAI,CAAC,eAAe,EAAE,MAAM,CAAC,CAAA;IACtC,MAAM,kBAAE,CAAC,IAAI,CAAC,cAAI,CAAC,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,EAAE,cAAI,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAA;IAC9E,MAAM,wBAAwB,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;IACxD,MAAM,kBAAE,CAAC,IAAI,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAA;AAC3C,CAAC;AAjCD,4DAiCC"}

package/build/commands/dev/index.d.ts

@@ -0,0 +1,6 @@
+import { Command } from 'commander';
+export interface DevCommandOptions {
+    resetCache?: boolean;
+    host?: string;
+}
+export declare function loadCommand(parentProgram: Command): Promise<void>;

package/build/commands/dev/index.js

@@ -0,0 +1,31 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadCommand = void 0;
+const commander_1 = require("commander");
+const chalk_1 = __importDefault(require("chalk"));
+const internal_ip_1 = require("internal-ip");
+const interactive_terminal_1 = require("./utils/interactive-terminal");
+const metro_server_1 = require("./utils/metro/metro-server");
+const minis_manifest_1 = require("./utils/minis-manifest");
+async function loadCommand(parentProgram) {
+    const ip = await (0, internal_ip_1.v4)();
+    const command = new commander_1.Command()
+        .name('dev')
+        .version('2.0.0')
+        .description('Start a local dev server for the mini app')
+        .option('--reset-cache', 'reset the dev server cache')
+        .option('--host <host>', "packager's host", ip)
+        .action(async (options) => {
+        await (0, metro_server_1.runMetro)(options);
+        const miniHandle = (0, minis_manifest_1.getMiniManifest)().handle;
+        console.log('Local development environment for', chalk_1.default.green(miniHandle), 'is running...');
+        const interactiveTerminal = new interactive_terminal_1.InteractiveTerminal(options);
+        interactiveTerminal.start();
+    });
+    parentProgram.addCommand(command);
+}
+exports.loadCommand = loadCommand;
+//# sourceMappingURL=index.js.map

package/build/commands/dev/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/commands/dev/index.ts"],"names":[],"mappings":";;;;;;AAAA,yCAAiC;AACjC,kDAAyB;AACzB,6CAAsC;AAEtC,uEAAgE;AAChE,6DAAmD;AACnD,2DAAsD;AAO/C,KAAK,UAAU,WAAW,CAAC,aAAsB;IACtD,MAAM,EAAE,GAAG,MAAM,IAAA,gBAAI,GAAE,CAAA;IAEvB,MAAM,OAAO,GAAG,IAAI,mBAAO,EAAE;SAC1B,IAAI,CAAC,KAAK,CAAC;SACX,OAAO,CAAC,OAAO,CAAC;SAChB,WAAW,CAAC,2CAA2C,CAAC;SACxD,MAAM,CAAC,eAAe,EAAE,4BAA4B,CAAC;SACrD,MAAM,CAAC,eAAe,EAAE,iBAAiB,EAAE,EAAE,CAAC;SAC9C,MAAM,CAAC,KAAK,EAAE,OAA0B,EAAE,EAAE;QAC3C,MAAM,IAAA,uBAAQ,EAAC,OAAO,CAAC,CAAA;QAEvB,MAAM,UAAU,GAAG,IAAA,gCAAe,GAAE,CAAC,MAAM,CAAA;QAC3C,OAAO,CAAC,GAAG,CACT,mCAAmC,EACnC,eAAK,CAAC,KAAK,CAAC,UAAU,CAAC,EACvB,eAAe,CAChB,CAAA;QAED,MAAM,mBAAmB,GAAG,IAAI,0CAAmB,CAAC,OAAO,CAAC,CAAA;QAC5D,mBAAmB,CAAC,KAAK,EAAE,CAAA;IAC7B,CAAC,CAAC,CAAA;IAEJ,aAAa,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;AACnC,CAAC;AAxBD,kCAwBC"}

package/build/commands/dev/utils/android.d.ts

@@ -0,0 +1,16 @@
+export interface androidDevice {
+    readonly name: string;
+    readonly description: string;
+    readonly type: string;
+    readonly isBooted: boolean;
+    readonly isAuthorized: boolean;
+}
+export declare function getDevices(): Promise<androidDevice[]>;
+export declare function getEmulators(): Promise<androidDevice[]>;
+export declare function androidHomeExists(): boolean;
+export declare function promptForAndroidDevices(): Promise<androidDevice | null>;
+export declare function maybeLaunchEmulator(emulatorName: string): Promise<string | null>;
+export declare function installShopInEmulator(emulatorId: string, version: string): Promise<void>;
+export declare function getInstalledShopVersion(emulatorId: string): Promise<string | null | undefined>;
+export declare function connectDevelopmentServer(emulatorId: string): Promise<void>;
+export declare function deeplinkToEmulator(emulatorId: string, deeplink: string): Promise<void>;

package/build/commands/dev/utils/android.js

@@ -0,0 +1,165 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deeplinkToEmulator = exports.connectDevelopmentServer = exports.getInstalledShopVersion = exports.installShopInEmulator = exports.maybeLaunchEmulator = exports.promptForAndroidDevices = exports.androidHomeExists = exports.getEmulators = exports.getDevices = void 0;
+const child_process_1 = __importDefault(require("child_process"));
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+const lodash_1 = __importDefault(require("lodash"));
+const prompts_1 = __importDefault(require("prompts"));
+const exec_async_child_process_1 = require("../../utils/exec-async-child-process");
+const with_retries_1 = require("./with-retries");
+const binaries_1 = require("./binaries");
+const DEFAULT_ANDROID_HOME_MACOS = `${process.env.HOME}/Library/Android/sdk`;
+function whichAndroidHome() {
+    if (process.env.ANDROID_HOME) {
+        return process.env.ANDROID_HOME;
+    }
+    if (fs_1.default.existsSync(DEFAULT_ANDROID_HOME_MACOS)) {
+        return DEFAULT_ANDROID_HOME_MACOS;
+    }
+    return null;
+}
+function whichEmulator() {
+    return `${whichAndroidHome()}/emulator/emulator`;
+}
+function whichAdb() {
+    return `${whichAndroidHome()}/platform-tools/adb`;
+}
+async function getDevices() {
+    const { stdout: devicesList } = await (0, exec_async_child_process_1.execAsync)(`${whichAdb()} devices -l`);
+    return devicesList
+        .slice(1)
+        .filter(name => !name.includes('emulator'))
+        .map(name => ({
+        name: name.split(' ')[0],
+        description: `${name.split(' ')[0]} (device)`,
+        type: 'device',
+        isBooted: true,
+        isAuthorized: true,
+    }));
+}
+exports.getDevices = getDevices;
+async function getEmulators() {
+    const { stdout: devicesList } = await (0, exec_async_child_process_1.execAsync)(`${whichEmulator()} -list-avds`);
+    return devicesList.map(name => ({
+        name,
+        description: `${name} (emulator)`,
+        type: 'emulator',
+        isBooted: false,
+        isAuthorized: true,
+    }));
+}
+exports.getEmulators = getEmulators;
+function androidHomeExists() {
+    return Boolean(whichAndroidHome());
+}
+exports.androidHomeExists = androidHomeExists;
+async function promptForAndroidDevices() {
+    const devices = await getDevices();
+    const emulators = await getEmulators();
+    const androidDevices = devices.concat(emulators);
+    if (!androidDevices.length) {
+        return null;
+    }
+    const { value } = await (0, prompts_1.default)({
+        type: 'autocomplete',
+        name: 'value',
+        limit: 11,
+        message: 'Select a device',
+        choices: androidDevices.map(item => {
+            return {
+                title: item.description,
+                value: item,
+            };
+        }),
+        suggest: (input, choices) => {
+            const regex = new RegExp(input, 'i');
+            return choices.filter((choice) => regex.test(choice.title));
+        },
+    });
+    return value;
+}
+exports.promptForAndroidDevices = promptForAndroidDevices;
+async function maybeLaunchEmulator(emulatorName) {
+    let emulatorId = await getIdForEmulatorWithName(emulatorName); // if emulatorId is defined the emulator is already running
+    if (!emulatorId) {
+        emulatorId = await doLaunchEmulator(emulatorName);
+    }
+    if (emulatorId) {
+        await waitForEmulatorToBoot(emulatorId);
+    }
+    return emulatorId;
+}
+exports.maybeLaunchEmulator = maybeLaunchEmulator;
+async function installShopInEmulator(emulatorId, version) {
+    const fileName = (0, binaries_1.versionToBinaryFileName)(version, 'android');
+    const binaryPath = path_1.default.join(binaries_1.BINARIES_PATH, fileName);
+    await (0, exec_async_child_process_1.execAsync)(`${whichAdb()} -s ${emulatorId} install -r "${binaryPath}"`);
+}
+exports.installShopInEmulator = installShopInEmulator;
+async function getInstalledShopVersion(emulatorId) {
+    try {
+        const { stdout } = await (0, exec_async_child_process_1.execAsync)(`${whichAdb()} -s ${emulatorId} shell dumpsys package com.shopify.arrive.internal | grep versionName`);
+        // stdout: ["versionName=2.86.0"]
+        return lodash_1.default.last(stdout?.[0]?.split('='));
+    }
+    catch {
+        return null;
+    }
+}
+exports.getInstalledShopVersion = getInstalledShopVersion;
+async function connectDevelopmentServer(emulatorId) {
+    await (0, exec_async_child_process_1.execAsync)(`${whichAdb()} -s ${emulatorId} reverse tcp:8082 tcp:8082`);
+}
+exports.connectDevelopmentServer = connectDevelopmentServer;
+async function deeplinkToEmulator(emulatorId, deeplink) {
+    await (0, exec_async_child_process_1.execAsync)(`${whichAdb()} -s ${emulatorId} shell am start -a android.intent.action.VIEW -d ${deeplink}`);
+}
+exports.deeplinkToEmulator = deeplinkToEmulator;
+async function getNameForEmulatorWithId(emulatorId) {
+    const { stdout } = await (0, exec_async_child_process_1.execAsync)(`${whichAdb()} -s ${emulatorId} emu avd name`);
+    return stdout[0];
+}
+async function getIdForEmulatorWithName(emulatorName) {
+    const { stdout } = await (0, exec_async_child_process_1.execAsync)(`${whichAdb()} devices`);
+    const emulatorIds = stdout.filter(result => result.startsWith('emulator-'));
+    for (const emulatorId of emulatorIds) {
+        const name = await getNameForEmulatorWithId(emulatorId);
+        if (name === emulatorName) {
+            return emulatorId;
+        }
+    }
+    return null;
+}
+async function waitForEmulatorToBoot(emulatorId, timeout = 60 * 2 * 1000 // 2 minutes
+) {
+    await (0, exec_async_child_process_1.execAsync)(`${whichAdb()} -s ${emulatorId} wait-for-device shell 'while [[ -z $(getprop sys.boot_completed) ]]; do sleep 1; done;'`, { timeout });
+}
+function doLaunchEmulator(emulatorName) {
+    const emulatorProcess = child_process_1.default.spawn(whichEmulator(), [`@${emulatorName}`], {
+        stdio: 'ignore',
+        detached: true,
+    });
+    emulatorProcess.unref();
+    return new Promise((resolve, reject) => {
+        (0, with_retries_1.withRetries)(() => getIdForEmulatorWithName(emulatorName))
+            .then(resolve)
+            .catch(reject)
+            .finally(() => {
+            emulatorProcess.removeAllListeners();
+        })
+            .catch(() => { });
+        emulatorProcess.on('error', ({ message }) => {
+            reject(new Error(message));
+            emulatorProcess.removeAllListeners();
+        });
+        emulatorProcess.on('exit', () => {
+            reject(new Error('Emulator closed before booting up'));
+            emulatorProcess.removeAllListeners();
+        });
+    });
+}
+//# sourceMappingURL=android.js.map

package/build/commands/dev/utils/android.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"android.js","sourceRoot":"","sources":["../../../../src/commands/dev/utils/android.ts"],"names":[],"mappings":";;;;;;AAAA,kEAAyC;AACzC,gDAAuB;AACvB,4CAAmB;AAEnB,oDAAsB;AACtB,sDAA6B;AAE7B,mFAA8D;AAE9D,iDAA0C;AAC1C,yCAAiE;AAEjE,MAAM,0BAA0B,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,sBAAsB,CAAA;AAU5E,SAAS,gBAAgB;IACvB,IAAI,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE;QAC5B,OAAO,OAAO,CAAC,GAAG,CAAC,YAAY,CAAA;KAChC;IAED,IAAI,YAAE,CAAC,UAAU,CAAC,0BAA0B,CAAC,EAAE;QAC7C,OAAO,0BAA0B,CAAA;KAClC;IAED,OAAO,IAAI,CAAA;AACb,CAAC;AAED,SAAS,aAAa;IACpB,OAAO,GAAG,gBAAgB,EAAE,oBAAoB,CAAA;AAClD,CAAC;AAED,SAAS,QAAQ;IACf,OAAO,GAAG,gBAAgB,EAAE,qBAAqB,CAAA;AACnD,CAAC;AAEM,KAAK,UAAU,UAAU;IAC9B,MAAM,EAAC,MAAM,EAAE,WAAW,EAAC,GAAG,MAAM,IAAA,oCAAS,EAAC,GAAG,QAAQ,EAAE,aAAa,CAAC,CAAA;IAEzE,OAAO,WAAW;SACf,KAAK,CAAC,CAAC,CAAC;SACR,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;SAC1C,GAAG,CACF,IAAI,CAAC,EAAE,CACL,CAAC;QACC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACxB,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW;QAC7C,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;QACd,YAAY,EAAE,IAAI;KACD,CAAA,CACtB,CAAA;AACL,CAAC;AAhBD,gCAgBC;AAEM,KAAK,UAAU,YAAY;IAChC,MAAM,EAAC,MAAM,EAAE,WAAW,EAAC,GAAG,MAAM,IAAA,oCAAS,EAAC,GAAG,aAAa,EAAE,aAAa,CAAC,CAAA;IAE9E,OAAO,WAAW,CAAC,GAAG,CACpB,IAAI,CAAC,EAAE,CACL,CAAC;QACC,IAAI;QACJ,WAAW,EAAE,GAAG,IAAI,aAAa;QACjC,IAAI,EAAE,UAAU;QAChB,QAAQ,EAAE,KAAK;QACf,YAAY,EAAE,IAAI;KACD,CAAA,CACtB,CAAA;AACH,CAAC;AAbD,oCAaC;AAED,SAAgB,iBAAiB;IAC/B,OAAO,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;AACpC,CAAC;AAFD,8CAEC;AAEM,KAAK,UAAU,uBAAuB;IAC3C,MAAM,OAAO,GAAG,MAAM,UAAU,EAAE,CAAA;IAClC,MAAM,SAAS,GAAG,MAAM,YAAY,EAAE,CAAA;IAEtC,MAAM,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;IAChD,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE;QAC1B,OAAO,IAAI,CAAA;KACZ;IAED,MAAM,EAAC,KAAK,EAAC,GAAG,MAAM,IAAA,iBAAO,EAAC;QAC5B,IAAI,EAAE,cAAc;QACpB,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,EAAE;QACT,OAAO,EAAE,iBAAiB;QAC1B,OAAO,EAAE,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;YACjC,OAAO;gBACL,KAAK,EAAE,IAAI,CAAC,WAAW;gBACvB,KAAK,EAAE,IAAI;aACZ,CAAA;QACH,CAAC,CAAC;QACF,OAAO,EAAE,CAAC,KAAU,EAAE,OAAY,EAAE,EAAE;YACpC,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;YACpC,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,MAAW,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;QAClE,CAAC;KACF,CAAC,CAAA;IAEF,OAAO,KAAK,CAAA;AACd,CAAC;AA3BD,0DA2BC;AAEM,KAAK,UAAU,mBAAmB,CAAC,YAAoB;IAC5D,IAAI,UAAU,GAAG,MAAM,wBAAwB,CAAC,YAAY,CAAC,CAAA,CAAC,2DAA2D;IACzH,IAAI,CAAC,UAAU,EAAE;QACf,UAAU,GAAG,MAAM,gBAAgB,CAAC,YAAY,CAAC,CAAA;KAClD;IACD,IAAI,UAAU,EAAE;QACd,MAAM,qBAAqB,CAAC,UAAU,CAAC,CAAA;KACxC;IACD,OAAO,UAAU,CAAA;AACnB,CAAC;AATD,kDASC;AAEM,KAAK,UAAU,qBAAqB,CACzC,UAAkB,EAClB,OAAe;IAEf,MAAM,QAAQ,GAAG,IAAA,kCAAuB,EAAC,OAAO,EAAE,SAAS,CAAC,CAAA;IAC5D,MAAM,UAAU,GAAG,cAAI,CAAC,IAAI,CAAC,wBAAa,EAAE,QAAQ,CAAC,CAAA;IACrD,MAAM,IAAA,oCAAS,EAAC,GAAG,QAAQ,EAAE,OAAO,UAAU,gBAAgB,UAAU,GAAG,CAAC,CAAA;AAC9E,CAAC;AAPD,sDAOC;AAEM,KAAK,UAAU,uBAAuB,CAAC,UAAkB;IAC9D,IAAI;QACF,MAAM,EAAC,MAAM,EAAC,GAAG,MAAM,IAAA,oCAAS,EAC9B,GAAG,QAAQ,EAAE,OAAO,UAAU,uEAAuE,CACtG,CAAA;QACD,iCAAiC;QACjC,OAAO,gBAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAA;KACvC;IAAC,MAAM;QACN,OAAO,IAAI,CAAA;KACZ;AACH,CAAC;AAVD,0DAUC;AAEM,KAAK,UAAU,wBAAwB,CAAC,UAAkB;IAC/D,MAAM,IAAA,oCAAS,EAAC,GAAG,QAAQ,EAAE,OAAO,UAAU,4BAA4B,CAAC,CAAA;AAC7E,CAAC;AAFD,4DAEC;AAEM,KAAK,UAAU,kBAAkB,CAAC,UAAkB,EAAE,QAAgB;IAC3E,MAAM,IAAA,oCAAS,EACb,GAAG,QAAQ,EAAE,OAAO,UAAU,oDAAoD,QAAQ,EAAE,CAC7F,CAAA;AACH,CAAC;AAJD,gDAIC;AAED,KAAK,UAAU,wBAAwB,CAAC,UAAkB;IACxD,MAAM,EAAC,MAAM,EAAC,GAAG,MAAM,IAAA,oCAAS,EAC9B,GAAG,QAAQ,EAAE,OAAO,UAAU,eAAe,CAC9C,CAAA;IACD,OAAO,MAAM,CAAC,CAAC,CAAC,CAAA;AAClB,CAAC;AAED,KAAK,UAAU,wBAAwB,CAAC,YAAoB;IAC1D,MAAM,EAAC,MAAM,EAAC,GAAG,MAAM,IAAA,oCAAS,EAAC,GAAG,QAAQ,EAAE,UAAU,CAAC,CAAA;IACzD,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAA;IAC3E,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;QACpC,MAAM,IAAI,GAAG,MAAM,wBAAwB,CAAC,UAAU,CAAC,CAAA;QACvD,IAAI,IAAI,KAAK,YAAY,EAAE;YACzB,OAAO,UAAU,CAAA;SAClB;KACF;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAED,KAAK,UAAU,qBAAqB,CAClC,UAAkB,EAClB,UAAkB,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC,YAAY;;IAE5C,MAAM,IAAA,oCAAS,EACb,GAAG,QAAQ,EAAE,OAAO,UAAU,0FAA0F,EACxH,EAAC,OAAO,EAAC,CACV,CAAA;AACH,CAAC;AAED,SAAS,gBAAgB,CAAC,YAAoB;IAC5C,MAAM,eAAe,GAAG,uBAAa,CAAC,KAAK,CACzC,aAAa,EAAE,EACf,CAAC,IAAI,YAAY,EAAE,CAAC,EACpB;QACE,KAAK,EAAE,QAAQ;QACf,QAAQ,EAAE,IAAI;KACf,CACF,CAAA;IACD,eAAe,CAAC,KAAK,EAAE,CAAA;IAEvB,OAAO,IAAI,OAAO,CAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACpD,IAAA,0BAAW,EAAC,GAAG,EAAE,CAAC,wBAAwB,CAAC,YAAY,CAAC,CAAC;aACtD,IAAI,CAAC,OAAO,CAAC;aACb,KAAK,CAAC,MAAM,CAAC;aACb,OAAO,CAAC,GAAG,EAAE;YACZ,eAAe,CAAC,kBAAkB,EAAE,CAAA;QACtC,CAAC,CAAC;aACD,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAA;QAElB,eAAe,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,EAAC,OAAO,EAAC,EAAE,EAAE;YACxC,MAAM,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAA;YAC1B,eAAe,CAAC,kBAAkB,EAAE,CAAA;QACtC,CAAC,CAAC,CAAA;QAEF,eAAe,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE;YAC9B,MAAM,CAAC,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC,CAAA;YACtD,eAAe,CAAC,kBAAkB,EAAE,CAAA;QACtC,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC"}

package/build/commands/dev/utils/binaries.d.ts

@@ -0,0 +1,83 @@
+export declare const BINARIES_PATH: string;
+type Platform = 'ios' | 'android';
+/**
+ * Returns the file extension used for each platform.
+ * android: .apk
+ * ios: .zip (we intentionally compress .app files before uploading them to the cloud storage)
+ */
+export declare function getBinaryFileExtensionForPlatform(platform: Platform): ".zip" | ".apk";
+/**
+ * @example
+ * platform android
+ * version 2.76.0
+ * returns "2-76-0.apk"
+ *
+ * platform ios
+ * version 2.55.0+4
+ * returns "2-55-0+4.zip"
+ */
+export declare function versionToBinaryFileName(version: string, platform: Platform): string;
+/**
+ * @example
+ * binaryFileName "2-76-0.apk"
+ * returns "2.76.0"
+ *
+ * binaryFileName "2-16-0+3.zip"
+ * returns "2.16.0+3"
+ */
+export declare function binaryFileNameToVersion(binaryFileName: string): string;
+/**
+ * @example
+ * filenames ["2-76-0+3.apk", "2-76-0+3.zip", "2-77-0.apk", "2-77-0.zip", "2-77-0+1.apk", "2-77-0+1.zip"]
+ * returns "2.77.0+1"
+ */
+export declare function getLatestVersionFromFilesList(filenames: string[]): string | null;
+/**
+ * Returns a boolean indicating if the binary for the given version and platform is already downloaded in the system
+ */
+export declare function isVersionAvailableLocally(platform: Platform, version: string): Promise<boolean>;
+/**
+ * Gets the biggest version in the downloads folder for the given platform.
+ */
+export declare function getLatestDownloadedVersion(platform: Platform): Promise<string | null>;
+/**
+ * Returns the latest version that's present in the remote storage of binaries
+ * TODO: this won't handle a bucket that has more than 50 files.
+ */
+export declare function getLatestRemoteVersion(platform: Platform): Promise<string>;
+/**
+ * Downloads a binary from the remote storage
+ * @returns Promise that resolves to the downloaded version
+ */
+export declare function downloadBinary(platform: Platform, { onProgress, version, }?: {
+    /**
+     * Download progress callback
+     */
+    onProgress?: (progress: number) => void;
+    /**
+     * Version to download. Defaults to latest version available
+     */
+    version?: string;
+}): Promise<string>;
+/**
+ * Compares the current version against the latest available version.
+ *
+ * Does nothing if the current version is already the latest.
+ * Otherwise prompts the user to download the new version.
+ */
+export declare function maybePromptBinaryUpgrade(platform: Platform, { currentVersion, onProgress, onDownloadStart, }?: {
+    /**
+     * The version that's currently being used.
+     * Defaults to the bigger version in the downloads folder.
+     */
+    currentVersion?: string;
+    /**
+     * Download progress callback
+     */
+    onProgress?: (progress: number) => void;
+    /**
+     * Callback executed if the user agrees to update, before starting the download.
+     */
+    onDownloadStart?: (version: string) => void;
+}): Promise<string | null>;
+export {};