@swell/cli 2.0.1-alpha.17 → 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>;
     };
-    swellConfig: 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,5 @@
-import * as path from 'node:path';
 import { Flags } from '@oclif/core';
+import * as path from 'node:path';
 import { default as swellConfig } from './lib/app-config.js';
 import { SwellCommand } from './swell-command.js';
 /**
@@ -20,10 +20,10 @@ export class AppCommand extends SwellCommand {
             description: 'path to your app directory',
         }),
     };
-    // local app configuration, what developers define
-    swellConfig;
     // the local path to the app directory
     appPath = '';
+    // local app configuration, what developers define
+    swellConfig;
     constructor(argv, config) {
         super(argv, config);
         this.swellConfig = swellConfig();

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

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

package/dist/commands/app/dev.js

@@ -2,7 +2,7 @@ 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 summary = `Run an app in dev mode from your local machine.`;
+    static delayOrientation = true;
     static examples = [
         'swell app dev',
         'swell app dev --storefront-id <id>',
@@ -14,17 +14,14 @@ export default class AppDev extends PushAppCommand {
             description: 'for storefront apps, identify a storefront to preview and push theme files to',
         }),
         'storefront-select': Flags.boolean({
-            description: 'for storefront apps, prompt to select a storefront to preview',
             default: false,
+            description: 'for storefront apps, prompt to select a storefront to preview',
         }),
     };
     static orientation = {
         env: 'test',
     };
-    static delayOrientation = true;
-    constructor(argv, config) {
-        super(argv, config);
-    }
+    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

@@ -1,7 +1,5 @@
-import { Config } from '@oclif/core';
 import { PushAppCommand } from '../../../push-app-command.js';
 export default class AppFrontendDeploy extends PushAppCommand {
-    static summary: string;
     static description: string;
     static examples: string[];
     static flags: {
@@ -12,6 +10,6 @@ export default class AppFrontendDeploy extends PushAppCommand {
     static orientation: {
         env: string;
     };
-    constructor(argv: string[], config: Config);
+    static summary: string;
     run(): Promise<void>;
 }

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

@@ -1,7 +1,6 @@
 import { Flags } from '@oclif/core';
 import { PushAppCommand } from '../../../push-app-command.js';
 export default class AppFrontendDeploy extends PushAppCommand {
-    static summary = `Push frontend files to your Swell app.`;
     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
@@ -20,16 +19,14 @@ the app's deployment URL and push the updated frontend files.`;
             description: 'identify a storefront to preview deployment with',
         }),
         'storefront-select': Flags.boolean({
-            description: 'prompt to select a storefront to preview deployment with',
             default: false,
+            description: 'prompt to select a storefront to preview deployment with',
         }),
     };
     static orientation = {
         env: 'test',
     };
-    constructor(argv, config) {
-        super(argv, config);
-    }
+    static summary = `Push frontend files to your Swell app.`;
     async run() {
         const { flags } = await this.parse(AppFrontendDeploy);
         const { force } = flags;

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

@@ -1,21 +1,19 @@
-import { Config } from '@oclif/core';
-import { PushAppCommand } from '../../../push-app-command.js';
 import { FrontendProjectType } from '../../../lib/apps/index.js';
+import { PushAppCommand } from '../../../push-app-command.js';
 export default class AppFrontendDev extends PushAppCommand {
-    static summary: string;
     static examples: string[];
     static flags: {
-        port: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<number | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
         '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;
     };
-    constructor(argv: string[], config: Config);
+    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>;
-    logAppLocalUrl(storeId: string, sessionId: string): void;
 }

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

@@ -1,13 +1,12 @@
 import { Flags } from '@oclif/core';
-import ngrok from 'ngrok';
 import getPort, { portNumbers } from 'get-port';
+import ngrok from 'ngrok';
 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 AppFrontendDev extends PushAppCommand {
-    static summary = `Run a frontend app in dev mode from your local machine.`;
     static examples = [
         'swell app frontend dev',
         'swell app frontend dev --no-push',
@@ -16,26 +15,30 @@ export default class AppFrontendDev extends PushAppCommand {
         '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',
         }),
-        'no-push': Flags.boolean({
-            description: 'skip pushing app files initially',
-        }),
         'storefront-id': Flags.string({
             description: 'identify a storefront to preview with and push theme files to',
         }),
         'storefront-select': Flags.boolean({
-            description: 'prompt to select a storefront to preview with',
             default: false,
+            description: 'prompt to select a storefront to preview with',
         }),
     };
     static orientation = {
         env: 'test',
     };
-    constructor(argv, config) {
-        super(argv, config);
+    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);
@@ -102,10 +105,4 @@ export default class AppFrontendDev extends PushAppCommand {
             },
         }), () => spinner.fail('Error starting local proxy'));
     }
-    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`);
-    }
 }

package/dist/commands/app/info.js

@@ -45,9 +45,7 @@ it will output all versions of the app instead.`;
     async showAppInfo() {
         const spinner = ora();
         spinner.start('Retrieving app info...');
-        const app = await this.getAppWithConfig().catch((error) => {
-            return null;
-        });
+        const app = await this.getAppWithConfig().catch(() => null);
         this.app = app || this.swellConfig.store;
         if (!this.app) {
             spinner.fail('App not found');

package/dist/commands/app/init.js

@@ -24,10 +24,10 @@ export default class InitApp extends CreateApp {
         const { yes: confirmYes } = flags;
         const id = process.cwd().split(path.sep).pop() || 'Swell App';
         await this.createSwellConfig({
+            allowOverwrite: false,
             inputId: id,
-            inputYes: confirmYes,
             inputType: this.appType,
-            allowOverwrite: false,
+            inputYes: confirmYes,
             nestedPath: false,
         });
     }

package/dist/commands/app/install.js

@@ -124,7 +124,6 @@ Without a store specified, install the app in the Live environment of the curren
     }
     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) {

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

@@ -4,12 +4,12 @@ export default class AppPull extends PushAppCommand {
         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;
-    static description: string;
-    static examples: string[];
-    run(): Promise<void>;
     logPulledChanges(pulled: string[], removed: string[]): void;
+    run(): Promise<void>;
 }

package/dist/commands/app/pull.js

@@ -1,6 +1,6 @@
-import * as path from 'node:path';
 import { Args, Flags } from '@oclif/core';
-import { ConfigPaths, } from '../../lib/apps/index.js';
+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 {
@@ -11,13 +11,6 @@ export default class AppPull extends PushAppCommand {
             description: 'path to download app files into',
         }),
     };
-    static flags = {
-        force: Flags.boolean({
-            description: 'force pull all files',
-            default: false,
-        }),
-    };
-    static summary = 'Pull app files from Swell to your local machine.';
     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.
 
@@ -33,18 +26,25 @@ ${Object.values(ConfigPaths)
         '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);
+        this.app = (await this.getAppToPull(args));
         const { pulled, removed } = await this.pullAppConfigs(force);
         this.logPulledChanges(pulled, removed);
     }
-    logPulledChanges(pulled, removed) {
-        const typeLabel = this.appType === 'theme' ? 'theme' : 'app';
-        const changeCount = pulled.length + removed.length;
-        const pluralFiles = changeCount !== 1 ? 'files' : 'file';
-        this.log(`Pulled ${changeCount} ${pluralFiles} from ${style.appConfigValue(this.app.name)} ${typeLabel} in ${style.path(path.resolve(this.appPath))}.`);
-    }
 }

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

@@ -3,15 +3,15 @@ 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: any;
     static orientation: any;
     static summary: string;
-    static description: string;
-    static examples: string[];
-    static delayOrientation: boolean;
-    run(): Promise<void>;
     resolvePushPaths(file: string): {
         filePath: string;
         relativePath: string;
     };
+    run(): Promise<void>;
 }

package/dist/commands/app/push.js

@@ -1,6 +1,6 @@
 import { Args, Flags } from '@oclif/core';
 import * as path from 'node:path';
-import { ConfigPaths, isPathDirectory, filePathExists, } from '../../lib/apps/index.js';
+import { ConfigPaths, filePathExists, isPathDirectory, } from '../../lib/apps/index.js';
 import style from '../../lib/style.js';
 import { PushAppCommand } from '../../push-app-command.js';
 export default class AppPush extends PushAppCommand {
@@ -10,19 +10,7 @@ export default class AppPush extends PushAppCommand {
             description: 'relative path to a configuration file or directory to push',
         }),
     };
-    static flags = {
-        force: Flags.boolean({
-            description: 'force push all configurations',
-            default: false,
-        }),
-        'no-deploy': Flags.boolean({
-            description: 'skip deploying app frontend',
-        }),
-    };
-    static orientation = {
-        env: 'test',
-    };
-    static summary = 'Push local files to your Swell app.';
+    static delayOrientation = true;
     static description = `Push all app files, a specific file, or a specific configuration
 type to an app in your store's test environment.
 
@@ -42,7 +30,29 @@ ${Object.values(ConfigPaths)
         'swell app push content',
         'swell app push models/products.json',
     ];
-    static delayOrientation = true;
+    static flags = {
+        force: Flags.boolean({
+            default: false,
+            description: 'force push all configurations',
+        }),
+        'no-deploy': Flags.boolean({
+            description: 'skip deploying app frontend',
+        }),
+    };
+    static orientation = {
+        env: 'test',
+    };
+    static summary = 'Push local files to your Swell app.';
+    resolvePushPaths(file) {
+        // Join the appPath and file to get the absolute filePath
+        const filePath = path.resolve(process.cwd(), file);
+        // Check if filePath is outside of appPath
+        const relativePath = path.relative(this.appPath, filePath);
+        if (relativePath.startsWith('..') || path.isAbsolute(relativePath)) {
+            this.error(`Path ${style.path(file)} is outside of the current app directory.`);
+        }
+        return { filePath, relativePath };
+    }
     async run() {
         const { args, flags } = await this.parse(AppPush);
         const { file } = args;
@@ -68,12 +78,9 @@ ${Object.values(ConfigPaths)
                     this.error(`Path ${style.path(file)} does not exist.`);
                 }
                 // Targeting a directory
-                if (isPathDirectory(filePath)) {
-                    await this.pushFilePath(relativePath, force);
-                }
-                else {
-                    await this.pushFile(relativePath);
-                }
+                await (isPathDirectory(filePath)
+                    ? this.pushFilePath(relativePath, force)
+                    : this.pushFile(relativePath));
                 this.log();
                 this.logDashboardUrl(flags);
                 return;
@@ -86,14 +93,4 @@ ${Object.values(ConfigPaths)
         }
         this.logDashboardUrl(flags);
     }
-    resolvePushPaths(file) {
-        // Join the appPath and file to get the absolute filePath
-        const filePath = path.resolve(process.cwd(), file);
-        // Check if filePath is outside of appPath
-        const relativePath = path.relative(this.appPath, filePath);
-        if (relativePath.startsWith('..') || path.isAbsolute(relativePath)) {
-            this.error(`Path ${style.path(file)} is outside of the current app directory.`);
-        }
-        return { filePath, relativePath };
-    }
 }

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

@@ -3,11 +3,11 @@ export default class AppRelease extends PushAppCommand {
     static args: {
         version: import("@oclif/core/lib/interfaces/parser.js").Arg<string | undefined, Record<string, unknown>>;
     };
-    static flags: any;
-    static summary: string;
     static description: string;
     static examples: string[];
+    static flags: any;
+    static summary: string;
     run(): Promise<void>;
-    private validateCreateVersion;
     validateReleaseDetails(): void;
+    private validateCreateVersion;
 }

package/dist/commands/app/release.js

@@ -1,8 +1,8 @@
+import { confirm } from '@inquirer/prompts';
 import { Args, Flags } from '@oclif/core';
 import { CLIError } from '@oclif/errors';
-import { confirm } from '@inquirer/prompts';
-import ora from 'ora';
 import * as fs from 'node:fs';
+import ora from 'ora';
 import * as semver from 'semver';
 import style from '../../lib/style.js';
 import { PushAppCommand } from '../../push-app-command.js';
@@ -19,25 +19,6 @@ export default class AppRelease extends PushAppCommand {
             },
         }),
     };
-    static flags = {
-        'release-notes': Flags.string({
-            description: 'relative path to a file containing release notes',
-        }),
-        message: Flags.string({
-            char: 'm',
-            description: 'description of the changes in this version for internal use',
-        }),
-        amend: Flags.boolean({
-            description: 'amend the description or release notes of an existing release',
-        }),
-        'not-supported': Flags.boolean({
-            description: 'indicates the version is not officially supported by the developer',
-        }),
-        'no-git-tag': Flags.boolean({
-            description: 'if the version is being created, do not create a git tag',
-        }),
-    };
-    static summary = 'Release a new version of your an app for publishing to the App Store.';
     static description = `App released are reviewed by the Swell team for quality and functionality before publishing.
 
 If the version does not exist, you will be prompted to create it.
@@ -52,9 +33,28 @@ The app must be connected to a partner account with access to publish.`;
         'swell app release 2.0.0',
         'swell app release 2.0.0 --amend --release-notes ./releases/v2.0.0.md',
     ];
+    static flags = {
+        amend: Flags.boolean({
+            description: 'amend the description or release notes of an existing release',
+        }),
+        message: Flags.string({
+            char: 'm',
+            description: 'description of the changes in this version for internal use',
+        }),
+        'no-git-tag': Flags.boolean({
+            description: 'if the version is being created, do not create a git tag',
+        }),
+        'not-supported': Flags.boolean({
+            description: 'indicates the version is not officially supported by the developer',
+        }),
+        'release-notes': Flags.string({
+            description: 'relative path to a file containing release notes',
+        }),
+    };
+    static summary = 'Release a new version of your an app for publishing to the App Store.';
     async run() {
         const { args, flags } = await this.parse(AppRelease);
-        const { amend, 'release-notes': releaseNotesFile, 'not-supported': notSupported, } = flags;
+        const { amend, message, 'not-supported': notSupported, 'release-notes': releaseNotesFile, } = flags;
         if (!(await this.ensureAppExists(undefined, false))) {
             return;
         }
@@ -75,7 +75,7 @@ The app must be connected to a partner account with access to publish.`;
             throw new Error(`Version ${appVersion.version} has already been released. Use --amend to update version details.`);
         }
         const releaseData = {
-            description: flags.message ? flags.message : appVersion.description,
+            description: message || appVersion.description,
             release_notes: releaseNotesFile ? releaseNotes : appVersion.release_notes,
             supported: notSupported
                 ? false
@@ -100,6 +100,22 @@ The app must be connected to a partner account with access to publish.`;
         }, spinner);
         spinner.succeed(`${style.appConfigValue(this.app.name)} release ${appVersion.version} ${amend ? 'updated' : 'released'}.`);
     }
+    validateReleaseDetails() {
+        if (!this.app.description) {
+            throw new Error('App must have a description');
+        }
+        const requiresPreviewImages = this.app.type === 'storefront' &&
+            (!this.app.kind || this.app.kind === 'shop') &&
+            this.app.storefront?.theme.provider !== 'app';
+        if (requiresPreviewImages) {
+            if (!this.app.preview_image) {
+                throw new Error('Storefront app must have a preview image to release');
+            }
+        }
+        else if (this.app.type !== 'theme' && !this.app.logo_icon) {
+            throw new Error('App must have a logo icon to release');
+        }
+    }
     async validateCreateVersion(inputVersion, flags) {
         let version = inputVersion;
         if (!version) {
@@ -111,7 +127,10 @@ The app must be connected to a partner account with access to publish.`;
         this.validateReleaseDetails();
         let appVersion = await this.getVersion(version);
         if (!appVersion) {
-            if (!flags.amend) {
+            if (flags.amend) {
+                throw new Error(`Version ${version} does not exist.`);
+            }
+            else {
                 await this.config.runCommand('app:version', [
                     version,
                     ...(flags.message ? [`-m ${JSON.stringify(flags.message)}`] : []),
@@ -123,28 +142,7 @@ The app must be connected to a partner account with access to publish.`;
                     throw new Error(`An error occurred while creating version ${version}.`);
                 }
             }
-            else {
-                throw new Error(`Version ${version} does not exist.`);
-            }
         }
         return appVersion;
     }
-    validateReleaseDetails() {
-        if (!this.app.description) {
-            throw new Error('App must have a description');
-        }
-        const requiresPreviewImages = this.app.type === 'storefront' &&
-            (!this.app.kind || this.app.kind === 'shop') &&
-            this.app.storefront?.theme.provider !== 'app';
-        if (requiresPreviewImages) {
-            if (!this.app.preview_image) {
-                throw new Error('Storefront app must have a preview image to release');
-            }
-        }
-        else {
-            if (this.app.type !== 'theme' && !this.app.logo_icon) {
-                throw new Error('App must have a logo icon to release');
-            }
-        }
-    }
 }

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

@@ -3,17 +3,17 @@ export default class AppVersion extends PushAppCommand {
     static args: {
         nextVersion: import("@oclif/core/lib/interfaces/parser.js").Arg<string | undefined, Record<string, unknown>>;
     };
+    static description: string;
+    static examples: string[];
     static flags: {
-        message: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
         amend: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
+        message: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
         'no-git-tag': import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
     };
     static summary: string;
-    static description: string;
-    static examples: string[];
     run(): Promise<void>;
+    private createRemoteVersion;
     private gitCommit;
     private gitTag;
-    private createRemoteVersion;
     private validateAndComputeVersion;
 }