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

package/dist/app-command.d.ts

@@ -14,8 +14,8 @@ export declare abstract class AppCommand extends SwellCommand {
     static baseFlags: {
         'app-path': import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
     };
-    appConfig: any;
     appPath: string;
+    swellConfig: any;
     constructor(argv: string[], config: Config);
     init(): Promise<void>;
     protected initBaseFlags(): Promise<void>;

package/dist/app-command.js

@@ -1,5 +1,6 @@
 import { Flags } from '@oclif/core';
-import { default as appConfig } from './lib/app-config.js';
+import * as path from 'node:path';
+import { default as swellConfig } from './lib/app-config.js';
 import { SwellCommand } from './swell-command.js';
 /**
  * A base class for Swell CLI commands that do not require an app to be saved
@@ -16,17 +17,17 @@ export class AppCommand extends SwellCommand {
     // needs to be in a ES2021 format: https://github.com/oclif/oclif/issues/1100
     static baseFlags = {
         'app-path': Flags.string({
-            description: 'path to the app directory',
+            description: 'path to your app directory',
         }),
     };
-    // local app configuration, what developers define
-    appConfig;
     // the local path to the app directory
     appPath = '';
+    // local app configuration, what developers define
+    swellConfig;
     constructor(argv, config) {
         super(argv, config);
-        this.appConfig = appConfig();
-        this.appPath = this.appConfig.swDirPath;
+        this.swellConfig = swellConfig();
+        this.appPath = path.resolve(this.swellConfig.swDirPath);
     }
     async init() {
         await super.init();
@@ -38,8 +39,7 @@ export class AppCommand extends SwellCommand {
         klass.flags = { ...klass.flags, ...AppCommand.baseFlags };
         const { flags } = await this.parse(klass);
         // if the user passed an app path, use it: reload the app config
-        this.appConfig = appConfig(flags['app-path']);
-        this.appPath = this.appConfig.swDirPath;
-        this.debug(`config path loaded: ${this.appConfig.path}`);
+        this.swellConfig = swellConfig(flags['app-path']);
+        this.appPath = path.resolve(this.swellConfig.swDirPath);
     }
 }

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

@@ -0,0 +1,16 @@
+import { PushAppCommand } from '../../push-app-command.js';
+export default class AppDev extends PushAppCommand {
+    static delayOrientation: boolean;
+    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>;
+        'no-push': import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
+        port: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<number | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    };
+    static orientation: {
+        env: string;
+    };
+    static summary: string;
+    run(): Promise<void>;
+}

package/dist/commands/app/dev.js

@@ -0,0 +1,28 @@
+import { Flags } from '@oclif/core';
+import { PushAppCommand } from '../../push-app-command.js';
+import AppFrontendDev from './frontend/dev.js';
+export default class AppDev extends PushAppCommand {
+    static delayOrientation = true;
+    static examples = [
+        'swell app dev',
+        'swell app dev --storefront-id <id>',
+        'swell app dev --port 3000',
+    ];
+    static flags = {
+        ...AppFrontendDev.flags,
+        'storefront-id': Flags.string({
+            description: 'for storefront apps, identify a storefront to preview and push theme files to',
+        }),
+        'storefront-select': Flags.boolean({
+            default: false,
+            description: 'for storefront apps, prompt to select a storefront to preview',
+        }),
+    };
+    static orientation = {
+        env: 'test',
+    };
+    static summary = `Run an app in dev mode from your local machine.`;
+    async run() {
+        await this.config.runCommand('app:frontend:dev', this.argv);
+    }
+}

package/dist/commands/app/frontend/deploy.d.ts

@@ -0,0 +1,15 @@
+import { PushAppCommand } from '../../../push-app-command.js';
+export default class AppFrontendDeploy extends PushAppCommand {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        force: 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;
+    };
+    static summary: string;
+    run(): Promise<void>;
+}

package/dist/commands/app/frontend/deploy.js

@@ -0,0 +1,41 @@
+import { Flags } from '@oclif/core';
+import { PushAppCommand } from '../../../push-app-command.js';
+export default class AppFrontendDeploy extends PushAppCommand {
+    static description = `Creates a new build using the relevant command depending on your frontend framework.
+Once the build succeeds, this command will invoke Cloudflare Wrangler to upload
+build assets using your own Cloudflare account. Once complete, Swell will update
+the app's deployment URL and push the updated frontend files.`;
+    static examples = [
+        'swell app frontend deploy',
+        'swell app frontend deploy --force',
+        'swell app frontend deploy --storefront-select',
+        'swell app frontend deploy --storefront-id <id>',
+    ];
+    static flags = {
+        force: Flags.boolean({
+            description: 'force push and build all frontend files',
+        }),
+        'storefront-id': Flags.string({
+            description: 'identify a storefront to preview deployment with',
+        }),
+        'storefront-select': Flags.boolean({
+            default: false,
+            description: 'prompt to select a storefront to preview deployment with',
+        }),
+    };
+    static orientation = {
+        env: 'test',
+    };
+    static summary = `Push frontend files to your Swell app.`;
+    async run() {
+        const { flags } = await this.parse(AppFrontendDeploy);
+        const { force } = flags;
+        if (!(await this.ensureAppExists())) {
+            return;
+        }
+        if (this.app.type === 'storefront') {
+            await this.getStorefrontToPush(flags);
+        }
+        await this.deployAppFrontend(force);
+    }
+}

package/dist/commands/app/frontend/dev.d.ts

@@ -0,0 +1,19 @@
+import { FrontendProjectType } from '../../../lib/apps/index.js';
+import { PushAppCommand } from '../../../push-app-command.js';
+export default class AppFrontendDev extends PushAppCommand {
+    static examples: string[];
+    static flags: {
+        'no-push': import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
+        port: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<number | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        '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;
+    };
+    static summary: string;
+    logAppLocalUrl(storeId: string, sessionId: string): void;
+    run(): Promise<void>;
+    startDevServer(projectType: FrontendProjectType, port?: number): Promise<void>;
+    updateLocalProxy(proxyUrl: string, spinner: any, storefrontId?: string): Promise<void>;
+}

package/dist/commands/app/frontend/dev.js

@@ -0,0 +1,108 @@
+import { Flags } from '@oclif/core';
+import getPort, { portNumbers } from 'get-port';
+import ngrok from 'ngrok';
+import ora from 'ora';
+import { default as localConfig } from '../../../lib/config.js';
+import style from '../../../lib/style.js';
+import { PushAppCommand } from '../../../push-app-command.js';
+const FALLBACK_PORT = 3000;
+export default class AppFrontendDev extends PushAppCommand {
+    static examples = [
+        'swell app frontend dev',
+        'swell app frontend dev --no-push',
+        'swell app frontend dev --port 3000',
+        'swell app frontend dev --storefront-select',
+        'swell app frontend dev --storefront-id <id>',
+    ];
+    static flags = {
+        'no-push': Flags.boolean({
+            description: 'skip pushing app files initially',
+        }),
+        port: Flags.integer({
+            char: 'p',
+            description: 'override the default port to run the app locally',
+        }),
+        'storefront-id': Flags.string({
+            description: 'identify a storefront to preview with and push theme files to',
+        }),
+        'storefront-select': Flags.boolean({
+            default: false,
+            description: 'prompt to select a storefront to preview with',
+        }),
+    };
+    static orientation = {
+        env: 'test',
+    };
+    static summary = `Run a frontend app in dev mode from your local machine.`;
+    logAppLocalUrl(storeId, sessionId) {
+        const frontendAppRoute = this.app.type === 'storefront' && this.app.storefront?.external
+            ? `/${this.app.private_id}`
+            : '';
+        this.log(`View it at ${style.link(`${this.localFrontendUrl(storeId, sessionId)}${frontendAppRoute}`)}\n`);
+    }
+    async run() {
+        const { flags } = await this.parse(AppFrontendDev);
+        const { port } = flags;
+        const noPush = flags['no-push'];
+        if (!(await this.ensureAppExists(undefined, false))) {
+            return;
+        }
+        if (!noPush) {
+            await this.pushAppConfigs();
+        }
+        if (this.app.type === 'storefront') {
+            await this.getStorefrontToPush(flags);
+            this.logStorefrontConnected();
+        }
+        this.saveCurrentStorefront();
+        const projectType = this.getFrontendProjectType();
+        await this.startDevServer(projectType, port);
+    }
+    async startDevServer(projectType, port) {
+        const currentStore = localConfig.getDefaultStore();
+        const spinner = ora();
+        // Find an open port starting at 3000
+        const freePort = port ||
+            (await getPort({ port: portNumbers(3000, 3100) })) ||
+            FALLBACK_PORT;
+        this.log(`Starting ${projectType.name} dev server...\n`);
+        // Start ngrok proxy
+        const proxyUrl = await ngrok.connect({
+            addr: freePort,
+            region: 'us', // TODO: make it configurable
+        });
+        await this.updateLocalProxy(proxyUrl, spinner, this.storefront?.id);
+        return this.exec(projectType.devCommand.replace('${PORT}', String(freePort)), (string) => {
+            // Hide useless astro warning about image optimization
+            if (string.includes('The current configuration does not support image optimization')) {
+                return false;
+            }
+            // Hide useless astro warning about .dev.vars
+            if (string.includes('There is no `.dev.vars` file')) {
+                return false;
+            }
+            // Hide astro localhost URL/network as it can confuse the user
+            if (string.includes('┃ Local') || string.includes('┃ Network')) {
+                return false;
+            }
+            // Started, show app url (TODO for nextjs)
+            if (string.includes('watching for file changes')) {
+                spinner.succeed(`Started ${projectType.name} dev server on port ${freePort}.\n`);
+                const sessionId = localConfig.getSessionId(currentStore);
+                setTimeout(() => this.logAppLocalUrl(currentStore, sessionId), 100);
+                this.watchForChanges();
+            }
+        });
+    }
+    async updateLocalProxy(proxyUrl, spinner, storefrontId) {
+        const storefront = this.app.type === 'storefront' &&
+            (await this.getAppStorefront({ storefront_id: storefrontId }));
+        await this.handleRequestErrors(async () => this.api.put({ adminPath: `/client/apps/${this.app.id}/local-proxy` }, {
+            body: {
+                proxy_url: proxyUrl,
+                storefront_id: storefront?.id || null,
+                storefront_slug: storefront?.slug || null,
+            },
+        }), () => spinner.fail('Error starting local proxy'));
+    }
+}

package/dist/commands/app/info.js

@@ -13,7 +13,6 @@ const FIELDS_TO_DISPLAY = [
     'published',
     'date_created',
     'date_updated',
-    'installed',
     'client',
 ];
 export default class AppInfo extends RemoteAppCommand {
@@ -46,25 +45,31 @@ it will output all versions of the app instead.`;
     async showAppInfo() {
         const spinner = ora();
         spinner.start('Retrieving app info...');
-        this.app = await this.getAppWithConfig().catch((error) => {
-            spinner.fail(`Error fetching app info:`);
-            throw error;
-        });
+        const app = await this.getAppWithConfig().catch(() => null);
+        this.app = app || this.swellConfig.store;
+        if (!this.app) {
+            spinner.fail('App not found');
+            return;
+        }
         if (spinner.isSpinning) {
             spinner.stop();
         }
         // we pull versions to make sure that what is displayed is the latest
-        const versions = await this.getVersions();
+        const versions = app ? await this.getVersions() : [];
         // Output the app field information, e.g.:
         //    Name: My App
         const fieldDefinitions = new FieldDefinitions(this.app, versions);
         for (const field of FIELDS_TO_DISPLAY) {
             const fieldDef = fieldDefinitions.getFieldDefinition(field);
-            this.log(style.appConfigName(`${fieldDef.label}:`), fieldDef.value);
+            if (fieldDef.value) {
+                this.log(style.appConfigName(`${fieldDef.label}:`), fieldDef.value);
+            }
         }
         // dashboard url is built, not part of the app object
         // we display it at the end for better readability and simplicity
-        this.log(style.appConfigName('Dashboard:'), style.link(this.dashboardUrl({}, this.app.client_id)));
+        if (this.app.client_id) {
+            this.log(style.appConfigName('Dashboard:'), style.link(this.dashboardUrl({}, this.app.client_id)));
+        }
     }
     async showVersions() {
         const spinner = ora();
@@ -81,7 +86,7 @@ it will output all versions of the app instead.`;
         spinner.succeed(`${this.app.name} app versions:\n`);
         const displayData = versions.map((appVersion) => [
             style.appConfigValue(appVersion.version),
-            appVersion.notes,
+            appVersion.description,
             new Date(appVersion.date_created).toUTCString(),
         ]);
         this.log(table(displayData, {

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

@@ -0,0 +1,12 @@
+import CreateApp from '../create/app.js';
+export default class InitApp extends CreateApp {
+    static description: string;
+    static examples: {
+        command: string;
+        description: string;
+    }[];
+    static flags: {
+        yes: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/app/init.js

@@ -0,0 +1,34 @@
+import { Flags } from '@oclif/core';
+import path from 'node:path';
+import CreateApp from '../create/app.js';
+export default class InitApp extends CreateApp {
+    static description = 'Initialize app swell.json in the current directory.';
+    static examples = [
+        {
+            command: 'swell app init',
+            description: 'Initialize app following command prompts.',
+        },
+        {
+            command: 'swell app init -y',
+            description: 'Initialize app and accept all default values.',
+        },
+    ];
+    static flags = {
+        yes: Flags.boolean({
+            char: 'y',
+            description: `accept all default values`,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(InitApp);
+        const { yes: confirmYes } = flags;
+        const id = process.cwd().split(path.sep).pop() || 'Swell App';
+        await this.createSwellConfig({
+            allowOverwrite: false,
+            inputId: id,
+            inputType: this.appType,
+            inputYes: confirmYes,
+            nestedPath: false,
+        });
+    }
+}

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

@@ -13,8 +13,5 @@ export default class AppInstall extends RemoteAppCommand {
     static summary: string;
     run(): Promise<void>;
     private confirmRemoveDevelopmentApp;
-    private getInstalledApp;
-    private installApp;
     private installConfirmationMessage;
-    private updateApp;
 }

package/dist/commands/app/install.js

@@ -11,9 +11,9 @@ export default class AppInstall extends RemoteAppCommand {
 
 Without a store specified, install the app in the Live environment of the current store.`;
     static examples = [
-        'swell install',
-        'swell install -v 3.2.7',
-        'swell install -v 1.0.0 -s my-store-id',
+        'swell app install',
+        'swell app install -v 3.2.7',
+        'swell app install -v 1.0.0 -s my-store-id',
     ];
     static flags = {
         env: Flags.string({
@@ -102,25 +102,28 @@ Without a store specified, install the app in the Live environment of the curren
             return;
         }
         const spinner = ora();
+        this.log();
         // install or update app depending on whether it's already installed
         let request;
         if (existingInstalledApp?.id) {
-            spinner.start(`Updating${extraMessage}...`);
-            request = async () => this.updateApp(versionToInstall);
+            spinner.start(`Updating${extraMessage}`);
+            request = async () => this.updateInstalledApp(versionToInstall, spinner);
         }
         else {
-            spinner.start(`Installing${extraMessage}...`);
-            request = async () => this.installApp(versionToInstall);
+            spinner.start(`Installing${extraMessage}`);
+            request = async () => this.installApp(versionToInstall, spinner);
         }
         const response = await this.handleRequestErrors(request, () => spinner.fail('Something went wrong.'));
         if (response?.errors) {
             spinner.fail(`Error installing app: ${JSON.stringify(response.errors)}`);
         }
-        spinner.succeed(`Install complete. Manage app settings in your dashboard at ${style.link(this.dashboardUrl({ flags: { env: envToInstall } }, storeToInstall))}.`);
+        else {
+            spinner.succeed(`${existingInstalledApp?.id ? 'Update' : 'Install'} complete.\n`);
+            this.log(`Manage app settings in your dashboard at ${style.link(this.dashboardUrl({ flags: { env: envToInstall } }, storeToInstall))}.`);
+        }
     }
     async confirmRemoveDevelopmentApp(storeToInstall) {
         const existingSourcedApps = await this.api.get({ adminPath: `/client/apps` }, {
-            // eslint-disable-next-line camelcase
             query: { source_id: this.app.id },
         });
         if (existingSourcedApps.results[0]?.id) {
@@ -150,15 +153,6 @@ Without a store specified, install the app in the Live environment of the curren
         }
         return true;
     }
-    async getInstalledApp() {
-        // check if app is already installed on store
-        return this.api.get({ adminPath: `/client/apps/${this.app.id}` }, {});
-    }
-    async installApp(version) {
-        return this.api.post({ adminPath: `/client/apps` }, 
-        // eslint-disable-next-line camelcase
-        { body: { app_id: this.app.id, version } });
-    }
     installConfirmationMessage(storeToInstall, envToInstall, versionToInstall, existingVersion) {
         const message = [];
         if (existingVersion && semver.gt(versionToInstall, existingVersion)) {
@@ -176,7 +170,4 @@ Without a store specified, install the app in the Live environment of the curren
         message.push(style.appConfigValue(this.app.name), `v${versionToShow}`, `on ${style.storeId(storeToInstall)} [${envToInstall || 'live'}]?`);
         return message.join(' ');
     }
-    async updateApp(version) {
-        await this.api.put({ adminPath: `/client/apps/${this.app.id}` }, { body: { version } });
-    }
 }

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

@@ -0,0 +1,15 @@
+import { PushAppCommand } from '../../push-app-command.js';
+export default class AppPull extends PushAppCommand {
+    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 description: string;
+    static examples: string[];
+    static flags: {
+        force: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
+    };
+    static summary: string;
+    logPulledChanges(pulled: string[], removed: string[]): void;
+    run(): Promise<void>;
+}

package/dist/commands/app/pull.js

@@ -0,0 +1,50 @@
+import { Args, Flags } from '@oclif/core';
+import * as path from 'node:path';
+import { ConfigPaths } from '../../lib/apps/index.js';
+import style from '../../lib/style.js';
+import { PushAppCommand } from '../../push-app-command.js';
+export default class AppPull extends PushAppCommand {
+    static args = {
+        appId: Args.string({ default: '', description: 'app id to pull' }),
+        targetPath: Args.string({
+            default: '',
+            description: 'path to download app files into',
+        }),
+    };
+    static description = `Pull all app files, a specific file, or a specific configuration
+type from an app in your store's test environment to your local machine.
+
+If APPID is not specified, you will be prompted with a list of apps to choose from.
+
+App file directories:
+${Object.values(ConfigPaths)
+        .map((dir) => style.path(`${dir}/`))
+        .join('\n')}\n${style.path(`frontend/`)}`;
+    static examples = [
+        'swell app pull',
+        'swell app pull example_app',
+        'swell app pull example_app example-folder',
+        'swell app pull --force',
+    ];
+    static flags = {
+        force: Flags.boolean({
+            default: false,
+            description: 'force pull all files',
+        }),
+    };
+    static summary = 'Pull app files from Swell to your local machine.';
+    logPulledChanges(pulled, removed) {
+        const typeLabel = this.appType === 'theme' ? 'theme' : 'app';
+        const changeCount = pulled.length + removed.length;
+        const pluralFiles = changeCount === 1 ? 'file' : 'files';
+        this.log(`Pulled ${changeCount} ${pluralFiles} from ${style.appConfigValue(this.app.name)} ${typeLabel} in ${style.path(path.resolve(this.appPath))}.`);
+    }
+    async run() {
+        const { args, flags } = await this.parse(AppPull);
+        const { force } = flags;
+        await this.ensureLoggedIn();
+        this.app = (await this.getAppToPull(args));
+        const { pulled, removed } = await this.pullAppConfigs(force);
+        this.logPulledChanges(pulled, removed);
+    }
+}

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

@@ -1,20 +1,17 @@
-import { RemoteAppCommand } from '../../remote-app-command.js';
-export default class AppPush extends RemoteAppCommand {
+import { PushAppCommand } from '../../push-app-command.js';
+export default class AppPush extends PushAppCommand {
     static args: {
         file: import("@oclif/core/lib/interfaces/parser.js").Arg<string | undefined, Record<string, unknown>>;
     };
+    static delayOrientation: boolean;
     static description: string;
     static examples: string[];
-    static flags: {
-        file: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
-    };
-    static orientation: {
-        env: string;
-    };
+    static flags: any;
+    static orientation: any;
     static summary: string;
+    resolvePushPaths(file: string): {
+        filePath: string;
+        relativePath: string;
+    };
     run(): Promise<void>;
-    private confirmRemoveInstalledApp;
-    private logDashboardUrl;
-    private pushConfigPath;
-    private pushFile;
 }