@swell/cli 2.0.1-alpha.17 → 2.0.1-alpha.18

package/dist/commands/app/version.js

@@ -34,19 +34,6 @@ export default class AppVersion extends PushAppCommand {
             },
         }),
     };
-    static flags = {
-        message: Flags.string({
-            char: 'm',
-            description: 'description of the changes in this version for internal use',
-        }),
-        amend: Flags.boolean({
-            description: 'amend the description an existing version',
-        }),
-        'no-git-tag': Flags.boolean({
-            description: 'do not create a git tag for this version',
-        }),
-    };
-    static summary = 'Increment the version of your Swell app.';
     static description = `When executed without specifying NEXTVERSION, the command will display the current
 version of your app.
 
@@ -63,6 +50,19 @@ behavior by using the --no-git-tag option.`;
         'swell app version minor',
         'swell app version 1.0.0 -m "First release"',
     ];
+    static flags = {
+        amend: Flags.boolean({
+            description: 'amend the description an existing version',
+        }),
+        message: Flags.string({
+            char: 'm',
+            description: 'description of the changes in this version for internal use',
+        }),
+        'no-git-tag': Flags.boolean({
+            description: 'do not create a git tag for this version',
+        }),
+    };
+    static summary = 'Increment the version of your Swell app.';
     async run() {
         const { args, flags } = await this.parse(AppVersion);
         const { amend, 'no-git-tag': noGitTag } = flags;
@@ -128,6 +128,21 @@ behavior by using the --no-git-tag option.`;
         }
         spinner.succeed(`${style.appConfigValue(this.app.name)} version ${nextVersion} created.`);
     }
+    async createRemoteVersion(nextVersion, message, spinner) {
+        // update the version on the remote
+        const versionResponse = await this.api.post({ adminPath: `/apps/${this.app.id}/versions` }, {
+            body: { description: message, version: nextVersion },
+            onAsyncGetPath: (response) => ({
+                adminPath: `/apps/${this.app.id}/versions/${response.id}`,
+            }),
+            spinner,
+        });
+        if (!versionResponse || !versionResponse.version) {
+            spinner.fail('Something went wrong.');
+        }
+        // update the local app config file since remote was successful
+        this.swellConfig.set('version', nextVersion);
+    }
     async gitCommit(message) {
         // check if there are changes in the app config file
         // if there are no changes, there is nothing to commit
@@ -147,21 +162,6 @@ behavior by using the --no-git-tag option.`;
         // tag the version in git
         await git.spawn(['tag', tag], { cwd: process.cwd() });
     }
-    async createRemoteVersion(nextVersion, message, spinner) {
-        // update the version on the remote
-        const versionResponse = await this.api.post({ adminPath: `/apps/${this.app.id}/versions` }, {
-            body: { description: message, version: nextVersion },
-            spinner,
-            onAsyncGetPath: (response) => ({
-                adminPath: `/apps/${this.app.id}/versions/${response.id}`,
-            }),
-        });
-        if (!versionResponse || !versionResponse.version) {
-            spinner.fail('Something went wrong.');
-        }
-        // update the local app config file since remote was successful
-        this.swellConfig.set('version', nextVersion);
-    }
     validateAndComputeVersion(nextVersion, remoteVersion) {
         let version = nextVersion;
         // compute the value of the next version and check if it's valid

package/dist/commands/create/app.d.ts

@@ -1,6 +1,5 @@
 import { CreateAppCommand } from '../../create-app-command.js';
 export default class CreateApp extends CreateAppCommand {
-    appType: string;
     static args: {
         id: import("@oclif/core/lib/interfaces/parser.js").Arg<string, Record<string, unknown>>;
     };
@@ -10,36 +9,37 @@ export default class CreateApp extends CreateAppCommand {
         description: string;
     }[];
     static flags: any;
-    run(): Promise<void>;
-    createSwellConfig({ inputId, inputYes, inputType, inputStorefrontApp, allowOverwrite, nestedPath, }: {
+    appType: string;
+    createSwellConfig({ allowOverwrite, inputId, inputStorefrontApp, inputType, inputYes, nestedPath, }: {
+        allowOverwrite?: boolean;
         inputId: string;
-        inputYes?: boolean;
-        inputType?: string;
         inputStorefrontApp?: string;
-        allowOverwrite?: boolean;
+        inputType?: string;
+        inputYes?: boolean;
         nestedPath?: boolean;
     }): Promise<{
         appId: string;
+        config: any;
+        installedStorefrontApp: any;
         swellConfigJson: {
-            permissions: never[];
-            id: string;
-            name: string;
-            description: string;
-            type: string;
-            version: string;
-        } | {
             theme: {
                 storefront: {
                     app: string;
                 };
             };
+            description: string;
             id: string;
             name: string;
+            type: string;
+            version: string;
+        } | {
+            permissions: never[];
             description: string;
+            id: string;
+            name: string;
             type: string;
             version: string;
         };
-        config: any;
-        installedStorefrontApp: any;
     } | undefined>;
+    run(): Promise<void>;
 }

package/dist/commands/create/app.js

@@ -2,12 +2,11 @@ import { confirm, input, select } from '@inquirer/prompts';
 import { Args, Flags } from '@oclif/core';
 import path from 'node:path';
 import ora from 'ora';
-import { swellConfigFileExists, newConfig } from '../../lib/app-config.js';
+import { CreateAppCommand } from '../../create-app-command.js';
+import { newConfig, swellConfigFileExists } from '../../lib/app-config.js';
 import { toAppId, toAppName } from '../../lib/create/index.js';
 import style from '../../lib/style.js';
-import { CreateAppCommand } from '../../create-app-command.js';
 export default class CreateApp extends CreateAppCommand {
-    appType = '';
     static args = {
         id: Args.string({
             default: '',
@@ -34,62 +33,20 @@ export default class CreateApp extends CreateAppCommand {
         },
     ];
     static flags = {
-        type: Flags.string({
-            char: 't',
-            description: `create a specific app type`,
-            options: ['admin', 'integration', 'storefront', 'theme'],
-        }),
         pkg: Flags.string({
             char: 'p',
             default: 'npm',
             description: `use npm or yarn to install default dependencies, or none to disable`,
             options: ['npm', 'yarn', 'none'],
         }),
+        type: Flags.string({
+            char: 't',
+            description: `create a specific app type`,
+            options: ['admin', 'integration', 'storefront', 'theme'],
+        }),
     };
-    async run() {
-        const { args, flags } = await this.parse(CreateApp);
-        const { id } = args;
-        const { pkg, yes } = flags;
-        let confirmYes = Boolean(yes && id);
-        const createParams = await this.createSwellConfig({
-            inputId: id,
-            inputYes: confirmYes,
-            inputType: flags['type'],
-            inputStorefrontApp: flags['storefront-app'],
-        });
-        if (!createParams) {
-            return;
-        }
-        const { appId, config, installedStorefrontApp } = createParams;
-        !confirmYes && this.log();
-        const spinner = ora();
-        spinner.start('Creating app...');
-        if (pkg !== 'none') {
-            await this.tryPackageSetup(appId, config, pkg);
-        }
-        await this.createAppConfigFolders(config);
-        spinner.succeed(`${style.appConfigValue(config.get('name'))} app created.\n`);
-        let createdFrontend, createdTheme;
-        if (installedStorefrontApp) {
-            createdTheme = await this.createThemeApp(config, flags, installedStorefrontApp);
-        }
-        else if (config.get('type') === 'storefront') {
-            createdFrontend = await this.createStorefrontApp(config, flags);
-        }
-        else {
-            createdFrontend = await this.createFrontendApp(config, flags);
-        }
-        this.log('\nNext steps:');
-        this.log(`Run ${style.command('swell app push')} to push configurations to your test store.`);
-        this.log(`Run ${style.command('swell app install')} to install the app in another store or environment.`);
-        if (createdFrontend) {
-            this.log(`Run ${style.command('swell app frontend dev')} to start a local dev server for your frontend app.`);
-        }
-        else if (createdTheme) {
-            this.log(`Run ${style.command('swell app theme dev')} to start a local dev server for your theme.`);
-        }
-    }
-    async createSwellConfig({ inputId, inputYes, inputType, inputStorefrontApp, allowOverwrite = true, nestedPath = true, }) {
+    appType = '';
+    async createSwellConfig({ allowOverwrite = true, inputId, inputStorefrontApp, inputType, inputYes, nestedPath = true, }) {
         let confirmYes = inputYes;
         const type = inputType ||
             (confirmYes
@@ -143,17 +100,16 @@ export default class CreateApp extends CreateAppCommand {
                 return;
             }
             storefrontAppId =
-                inputStorefrontApp || (storefrontInstalledApps.length > 1
-                    ? (await select({
-                        choices: [
-                            ...storefrontInstalledApps.map(({ id, app }) => ({
+                inputStorefrontApp ||
+                    (storefrontInstalledApps.length > 1
+                        ? await select({
+                            choices: storefrontInstalledApps.map(({ app, id }) => ({
                                 name: app.name,
                                 value: id,
                             })),
-                        ],
-                        message: `Which storefront app is your theme for?`,
-                    }))
-                    : storefrontInstalledApps[0].id);
+                            message: `Which storefront app is your theme for?`,
+                        })
+                        : storefrontInstalledApps[0].id);
             installedStorefrontApp = storefrontInstalledApps.find((installedApp) => inputStorefrontApp
                 ? inputStorefrontApp === installedApp.app_private_id ||
                     inputStorefrontApp === installedApp.app_public_id ||
@@ -165,21 +121,21 @@ export default class CreateApp extends CreateAppCommand {
             }
         }
         const swellConfigJson = {
+            description,
             id: appId,
             name,
-            description,
             type,
             version,
-            ...(type !== 'theme'
+            ...(type === 'theme'
                 ? {
-                    permissions: [],
-                }
-                : {
                     theme: {
                         storefront: {
                             app: toAppId(installedStorefrontApp.app_private_id),
                         },
                     },
+                }
+                : {
+                    permissions: [],
                 }),
         };
         const appPath = path.join(process.cwd(), appId);
@@ -211,6 +167,50 @@ export default class CreateApp extends CreateAppCommand {
         const config = newConfig(nestedPath ? appId : '');
         config.clear();
         config.set(swellConfigJson);
-        return { appId, swellConfigJson, config, installedStorefrontApp };
+        return { appId, config, installedStorefrontApp, swellConfigJson };
+    }
+    async run() {
+        const { args, flags } = await this.parse(CreateApp);
+        const { id } = args;
+        const { pkg, yes } = flags;
+        const confirmYes = Boolean(yes && id);
+        const createParams = await this.createSwellConfig({
+            inputId: id,
+            inputStorefrontApp: flags['storefront-app'],
+            inputType: flags.type,
+            inputYes: confirmYes,
+        });
+        if (!createParams) {
+            return;
+        }
+        const { appId, config, installedStorefrontApp } = createParams;
+        !confirmYes && this.log();
+        const spinner = ora();
+        spinner.start('Creating app...');
+        if (pkg !== 'none') {
+            await this.tryPackageSetup(appId, config, pkg);
+        }
+        await this.createAppConfigFolders(config);
+        spinner.succeed(`${style.appConfigValue(config.get('name'))} app created.\n`);
+        let createdFrontend;
+        let createdTheme;
+        if (installedStorefrontApp) {
+            createdTheme = await this.createThemeApp(config, flags, installedStorefrontApp);
+        }
+        else if (config.get('type') === 'storefront') {
+            createdFrontend = await this.createStorefrontApp(config, flags);
+        }
+        else {
+            createdFrontend = await this.createFrontendApp(config, flags);
+        }
+        this.log('\nNext steps:');
+        this.log(`Run ${style.command('swell app push')} to push configurations to your test store.`);
+        this.log(`Run ${style.command('swell app install')} to install the app in another store or environment.`);
+        if (createdFrontend) {
+            this.log(`Run ${style.command('swell app frontend dev')} to start a local dev server for your frontend app.`);
+        }
+        else if (createdTheme) {
+            this.log(`Run ${style.command('swell app theme dev')} to start a local dev server for your theme.`);
+        }
     }
 }

package/dist/commands/create/frontend.js

@@ -1,7 +1,7 @@
 import { Flags } from '@oclif/core';
 import ora from 'ora';
-import swellConfig from '../../lib/app-config.js';
 import { CreateAppCommand } from '../../create-app-command.js';
+import swellConfig from '../../lib/app-config.js';
 export default class CreateFrontend extends CreateAppCommand {
     static description = 'Initialize a frontend app framework and folder structure.';
     static examples = [
@@ -31,11 +31,8 @@ export default class CreateFrontend extends CreateAppCommand {
             spinner.fail(`You can't create app frontend in a theme.`);
             return;
         }
-        if (appType === 'storefront') {
-            await this.createStorefrontApp(newSwellConfig, flags, true);
-        }
-        else {
-            await this.createFrontendApp(newSwellConfig, flags, true);
-        }
+        await (appType === 'storefront'
+            ? this.createStorefrontApp(newSwellConfig, flags, true)
+            : this.createFrontendApp(newSwellConfig, flags, true));
     }
 }

package/dist/commands/env.d.ts

@@ -0,0 +1,12 @@
+import { Config } from '@oclif/core';
+import { SwellCommand } from '../swell-command.js';
+export default class Env extends SwellCommand {
+    static args: {
+        name: import("@oclif/core/lib/interfaces/parser.js").Arg<string | undefined, Record<string, unknown>>;
+        reviewBranch: import("@oclif/core/lib/interfaces/parser.js").Arg<string | undefined, Record<string, unknown>>;
+    };
+    static description: string;
+    static hidden: boolean;
+    constructor(argv: string[], config: Config);
+    run(): Promise<void>;
+}

package/dist/commands/env.js

@@ -0,0 +1,31 @@
+import { Args } from '@oclif/core';
+import { env, setEnv } from '../lib/config.js';
+import style from '../lib/style.js';
+import { SwellCommand } from '../swell-command.js';
+export default class Env extends SwellCommand {
+    static args = {
+        name: Args.string({
+            description: 'name of the environment (production, staging, local, review)',
+        }),
+        reviewBranch: Args.string({
+            description: 'name of a review branch',
+        }),
+    };
+    static description = `Internal: Display the current environment configuration.`;
+    static hidden = true;
+    constructor(argv, config) {
+        super(argv, config);
+        this.requiresAuth = false;
+    }
+    async run() {
+        const { args } = await this.parse(Env);
+        const { name, reviewBranch } = args;
+        if (name) {
+            const newEnv = setEnv(name, reviewBranch);
+            this.log(`Environment set to ${style.appEnv(name)}:`, JSON.stringify(newEnv, null, 2));
+        }
+        else {
+            this.log('Current environment:', JSON.stringify(env.store, null, 2));
+        }
+    }
+}

package/dist/commands/login.js

@@ -61,9 +61,7 @@ have available for logging in to.
      * @returns void
      */
     async getAndSetStoreConfig({ sessionId, storeId, }) {
-        const switchResponse = await this.api.post({ adminPath: '/user/switch' }, 
-        // eslint-disable-next-line camelcase
-        { body: { client_id: storeId }, sessionId });
+        const switchResponse = await this.api.post({ adminPath: '/user/switch' }, { body: { client_id: storeId }, sessionId });
         // ensure we have the attribute names as we expect before saving
         switchResponse.sessionId = switchResponse.session_id;
         switchResponse.storeId = switchResponse.client_id;

package/dist/commands/logs.js

@@ -51,12 +51,10 @@ function buildLogRequestBody(flags) {
     }
     const { after, before, env, startPolling } = flags;
     if (env) {
-        // eslint-disable-next-line camelcase
         andConditions.push({ environment_id: env });
     }
     else {
         // Default to test env
-        // eslint-disable-next-line camelcase
         andConditions.push({ environment_id: 'test' });
     }
     // if we are polling, we want to get logs after the last date we received

package/dist/commands/theme/dev.d.ts

@@ -1,23 +1,21 @@
-import { Config } from '@oclif/core';
 import { PushAppCommand } from '../../push-app-command.js';
 export default class AppThemeDev extends PushAppCommand {
-    appType: string;
-    static summary: string;
     static examples: string[];
     static flags: {
-        'storefront-id': import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
-        'storefront-select': import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
-        local: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
         bundle: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
+        local: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
         'no-push': import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
+        'storefront-id': import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        'storefront-select': import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
     };
     static orientation: {
         env: string;
     };
-    constructor(argv: string[], config: Config);
+    static summary: string;
+    appType: string;
+    logAppLocalUrl(storeId: string, sessionId: string): void;
     run(): Promise<void>;
     private findAndInstallDependencies;
     private findAndTryScriptCommands;
     private startThemeDevServer;
-    logAppLocalUrl(storeId: string, sessionId: string): void;
 }

package/dist/commands/theme/dev.js

@@ -1,17 +1,15 @@
-import fs from 'fs';
-import ora from 'ora';
-import BrowserSync from 'browser-sync';
 import { Flags } from '@oclif/core';
-import getPort, { portNumbers } from 'get-port';
-import { spawn, execSync } from 'child_process';
+import BrowserSync from 'browser-sync';
 import { findUp } from 'find-up';
+import getPort, { portNumbers } from 'get-port';
+import { execSync, spawn } from 'node:child_process';
+import fs from 'node:fs';
+import ora from 'ora';
 import { default as localConfig } from '../../lib/config.js';
-import { PushAppCommand } from '../../push-app-command.js';
 import style from '../../lib/style.js';
+import { PushAppCommand } from '../../push-app-command.js';
 const FALLBACK_PORT = 3000;
 export default class AppThemeDev extends PushAppCommand {
-    appType = 'theme';
-    static summary = `Run a theme in dev mode from your local machine.`;
     static examples = [
         'swell theme dev',
         'swell theme dev --local',
@@ -20,28 +18,30 @@ export default class AppThemeDev extends PushAppCommand {
         'swell theme dev --storefront-id <id>',
     ];
     static flags = {
-        'storefront-id': Flags.string({
-            description: 'identify a storefront to preview and push theme files to',
-        }),
-        'storefront-select': Flags.boolean({
-            description: 'prompt to select a storefront to preview and push theme files to',
-            default: false,
+        bundle: Flags.boolean({
+            description: 'bundle assets',
         }),
         local: Flags.boolean({
             description: 'connect to a running local storefront app dev server',
         }),
-        bundle: Flags.boolean({
-            description: 'bundle assets',
-        }),
         'no-push': Flags.boolean({
             description: 'skip pushing theme files initially',
         }),
+        'storefront-id': Flags.string({
+            description: 'identify a storefront to preview and push theme files to',
+        }),
+        'storefront-select': Flags.boolean({
+            default: false,
+            description: 'prompt to select a storefront to preview and push theme files to',
+        }),
     };
     static orientation = {
         env: 'test',
     };
-    constructor(argv, config) {
-        super(argv, config);
+    static summary = `Run a theme in dev mode from your local machine.`;
+    appType = 'theme';
+    logAppLocalUrl(storeId, sessionId) {
+        this.log(`View it at ${style.link(this.localFrontendUrl(storeId, sessionId))}\n`);
     }
     async run() {
         const { flags } = await this.parse(AppThemeDev);
@@ -79,7 +79,7 @@ export default class AppThemeDev extends PushAppCommand {
             spinner.succeed('Dependencies installed');
             return packageJsonPath;
         }
-        catch (error) {
+        catch {
             spinner.fail('Error locating package.json. Skipping bundle process.');
             return null;
         }
@@ -99,18 +99,18 @@ export default class AppThemeDev extends PushAppCommand {
                 return;
             }
             const childProcess = spawn('npm', ['run', scriptName], {
-                stdio: 'pipe',
-                shell: true,
                 env: { ...process.env, BROWSERSLIST_IGNORE_OLD_DATA: 'true' },
+                shell: true,
+                stdio: 'pipe',
             });
             childProcess.stdout.on('data', (data) => {
                 const lines = data.toString().split(/\r?\n/);
-                lines.forEach((line) => {
+                for (const line of lines) {
                     const trimmedLine = line.trim();
                     if (trimmedLine) {
                         console.log(`${style.success('📦')} ${trimmedLine}`);
                     }
-                });
+                }
             });
             childProcess.on('exit', (code) => {
                 if (code === 0) {
@@ -121,8 +121,8 @@ export default class AppThemeDev extends PushAppCommand {
                 }
             });
         }
-        catch (err) {
-            console.error('Error processing package.json:', err);
+        catch (error) {
+            console.error('Error processing package.json:', error);
         }
     }
     async startThemeDevServer(local) {
@@ -142,18 +142,18 @@ export default class AppThemeDev extends PushAppCommand {
             : this.storefrontFrontendUrl(currentStore, this.storefront, undefined, true);
         const bs = BrowserSync.create();
         bs.init({
-            ui: false,
+            logLevel: 'silent',
             notify: false,
+            open: false,
             proxy: {
-                target: storefrontUrl,
                 proxyReq: [
                     (proxyReq) => {
                         proxyReq.setHeader('swell-request-id', `${currentStore}_${Date.now()}`);
                     },
                 ],
+                target: storefrontUrl,
             },
-            logLevel: 'silent',
-            open: false,
+            ui: false,
         });
         await this.watchForChanges({
             onChange: () => bs.reload(),
@@ -161,7 +161,4 @@ export default class AppThemeDev extends PushAppCommand {
         spinner.stop();
         this.log(`Watching for changes. View your theme at ${style.link(`http://localhost:${freePort}`)}\n`);
     }
-    logAppLocalUrl(storeId, sessionId) {
-        this.log(`View it at ${style.link(this.localFrontendUrl(storeId, sessionId))}\n`);
-    }
 }

package/dist/commands/theme/init.d.ts

@@ -1,9 +1,9 @@
 import InitApp from '../app/init.js';
 export default class InitTheme extends InitApp {
-    appType: string;
     static description: string;
     static examples: {
         command: string;
         description: string;
     }[];
+    appType: string;
 }

package/dist/commands/theme/init.js

@@ -1,6 +1,5 @@
 import InitApp from '../app/init.js';
 export default class InitTheme extends InitApp {
-    appType = 'theme';
     static description = 'Initialize theme swell.json in the current directory.';
     static examples = [
         {
@@ -12,4 +11,5 @@ export default class InitTheme extends InitApp {
             description: 'Initialize theme and accept all default values.',
         },
     ];
+    appType = 'theme';
 }

package/dist/commands/theme/pull.d.ts

@@ -1,20 +1,20 @@
 import AppPull from '../app/pull.js';
 export default class AppThemePull extends AppPull {
-    appType: string;
     static args: {
         appId: import("@oclif/core/lib/interfaces/parser.js").Arg<string, Record<string, unknown>>;
         targetPath: import("@oclif/core/lib/interfaces/parser.js").Arg<string, Record<string, unknown>>;
     };
+    static delayOrientation: boolean;
+    static description: string;
+    static examples: string[];
     static flags: {
         force: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
-        'sync-app': import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
-        'storefront-select': import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
         'storefront-id': import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        'storefront-select': import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
+        'sync-app': import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
     };
-    static summary: string;
-    static description: string;
-    static examples: string[];
     static orientation: {};
-    static delayOrientation: boolean;
+    static summary: string;
+    appType: string;
     run(): Promise<void>;
 }