@swell/cli 2.0.1-alpha.0 → 2.0.1-alpha.11

package/README.md

@@ -1,141 +1,3 @@
-# @swell/cli
+# @swell/cli 2 alpha
 
-#We're in beta: commands and arguments can still change.#
-
-Install with:
-
-```sh
-npm install -g @swell/cli
-```
-
-If you are using tools for version managing like [asdf](https://asdf-vm.com/), make sure you [reshim](https://asdf-vm.com/manage/core.html#reshim) after install:
-
-```sh
-asdf reshim
-```
-
-# Commands
-
-## General options
-
-Commands tend to support the following helper options:
-
-- --quiet (-q): Boolean, quiets the progress indicator and output of intermediary commands
-- --verbose (-v): Boolean, outputs all commands
-- --dry-run: Boolean, dry runs requests that delete data, but doesn't run them
-- --yes (-y): Boolean, answers all confirmation questions with **yes**.
-
-## Login
-
-The `admin login` command authenticates and stores a user's session locally. Saved sessions can/will be used by other commands, unless a secret key is specified.
-
-```sh
-swell login [--username (-u) String] [--password (-p) String] [--set-default Boolean]
-```
-
-### Examples
-
-```sh
-swell login
-swell login --set-default
-```
-
-## Storefronts
-
-List all storefronts associated to logged in user:
-
-```sh
-swell storefronts list
-```
-
-Retrieves storefront configuration data from the server and writes it to a file if specified or stdout by default. It requires a type to run. Configuration types allowed are "editor", "menus" and "settings":
-```sh
-swell storefronts pull --id String --type (-t) String [--file (-f) String]
-```
-
-Send storefront configuration data to the server. Configuration types allowed are "editor", "menus" and "settings":
-```sh
-swell storefronts push --id String --type (-t) String [--file (-f) String] [--strategy (-i) String]
-```
-
-### Examples
-
-```sh
-swell storefronts pull --id P5OzfzLD -t editor
-swell storefronts pull --id P5OzfzLD -t menus -f menus.json
-swell storefronts push --id P5OzfzLD -t editor -s set -f ../origin-storefront/config/editor.json
-```
-
-### Without logging in
-
-```sh
-swell storefronts pull --id P5OzfzLD -t editor --store my-test-store --secret-key my-dev-secret-key
-swell storefronts pull --id P5OzfzLD -t menus -f menus.json --store my-test-store --secret-key my-dev-secret-key
-swell storefronts push --id P5OzfzLD -t editor -s set -f ../origin-storefront/config/editor.json --store my-test-store --secret-key my-dev-secret-key
-```
-
-## Model
-
-Push or pull model definitions, including namespaced models (e.g. content models), abstract content models and content fields.
-
-```sh
-# pull => retrieves a model from the server and tries to merge and/or write to a specified JSON file or stdout (by default)
-# --content flag toggles between base models and abstract content models or content fields
-swell model pull -m MODEL_ID [--file (-f) String] [--strategy (-s) String] [--content Boolean]
-
-# push => send a model definition from a JSON file or stdin to the server
-swell model push [--file (-f) String] [--input (-i) stdin] [--content Boolean]
-```
-
-It is important that the model definition includes some fields depending on the type/source of the model.
-
-#### Basic model
-
-```json
-{
-    "name": "Test", // slug will be assumed from this field
-    "slug": "test_model", // or you can define one explicitly
-    "fields": { ... }
-}
-```
-
-#### Namespaced model
-
-```json
-{
-    "name": "Page", // slug will be assumed from this field
-    "namespace": "content",
-    "fields": { ... }
-}
-```
-
-#### Theme content (abstract) model/fields (use with --content flag)
-
-```json
-{
-    "name": "Test", // slug will be assumed from this field
-    "fields": { ... },
-    "source_type": "theme",
-    "source_id": "origin"
-}
-```
-
-### Examples
-
-```sh
-swell model pull -m products # pull products model and display in stdout
-swell model pull -m theme.origin.page --content -f models/page.json # pull a content model and save it to a file
-
-swell model push -f models/orders.json
-swell model push -c -f models/page.json # push a content model
-```
-
-### Without logging in
-
-```sh
-swell model pull -m products --store my-test-store --secret-key my-dev-secret-key
-swell model pull -m theme.origin.page --content -f models/page.json --store my-test-store --secret-key my-dev-secret-key
-
-swell model push -f models/orders.json --store my-test-store --secret-key my-dev-secret-key
-swell model push -c -f models/page.json --store my-test-store --secret-key my-dev-secret-key
-```
+Find the alpha docs at https://www.notion.so/swellcorp/CLI-reference-c3553ebb3de24d94becbedf95a5a25d8?pvs=4

package/dist/commands/app/_pull.js

@@ -1,9 +1,9 @@
 import { Args } from '@oclif/core';
 import { dasherize, pluralize, underscore } from 'inflection';
-import snakeCase from 'lodash/snakeCase.js';
 import * as path from 'node:path';
 import { newConfig } from '../../lib/app-config.js';
 import { ConfigPaths, writeJsonFile, } from '../../lib/apps/index.js';
+import { toAppId } from '../../lib/create/index.js';
 import style from '../../lib/style.js';
 import { RemoteAppCommand } from '../../remote-app-command.js';
 export default class AppPull extends RemoteAppCommand {
@@ -25,7 +25,7 @@ export default class AppPull extends RemoteAppCommand {
         const config = newConfig();
         const appConfigJson = {
             description: this.app.description || '',
-            id: snakeCase(this.app.name),
+            id: toAppId(this.app.name),
             name: this.app.name,
             version: this.app.version,
         };

package/dist/commands/app/info.js

@@ -47,7 +47,7 @@ it will output all versions of the app instead.`;
         const spinner = ora();
         spinner.start('Retrieving app info...');
         this.app = await this.getAppWithConfig().catch((error) => {
-            spinner.fail(`Error fetching app info: ${JSON.stringify(this.app)}`);
+            spinner.fail(`Error fetching app info:`);
             throw error;
         });
         if (spinner.isSpinning) {

package/dist/commands/app/install.js

@@ -93,7 +93,8 @@ Without a store specified, install the app in the Live environment of the curren
         else {
             extraMessage = ` ${style.appConfigValue(this.app.name)} v${versionToInstall} on ${style.storeId(storeToInstall)} [${envToInstall ? envToInstall : 'live'}]`;
         }
-        const shouldContinue = await this.confirmRemoveDevelopmentApp(storeToInstall);
+        const shouldContinue = existingVersion ||
+            (await this.confirmRemoveDevelopmentApp(storeToInstall));
         if (!shouldContinue) {
             return;
         }
@@ -148,6 +149,7 @@ Without a store specified, install the app in the Live environment of the curren
             query: { source_id: this.app.id },
         });
         if (existingSourcedApps.results[0]?.id) {
+            console.log(existingSourcedApps.results[0]);
             const continueInstall = await confirm({
                 message: `${style.storeId(storeToInstall)} has a development version of ${style.appConfigValue(this.app.name)}. Do you want to replace it with an installed instance?`,
                 default: false,

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

@@ -2,6 +2,9 @@ import { RemoteAppCommand } from '../../remote-app-command.js';
 export default class AppPush extends RemoteAppCommand {
     static description: string;
     static examples: string[];
+    static args: {
+        file: import("@oclif/core/lib/interfaces/parser.js").Arg<string | undefined, Record<string, unknown>>;
+    };
     static flags: {
         file: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
     };

package/dist/commands/app/push.js

@@ -1,5 +1,5 @@
 import { confirm } from '@inquirer/prompts';
-import { Flags } from '@oclif/core';
+import { Flags, Args } from '@oclif/core';
 import * as path from 'node:path';
 import ora from 'ora';
 import { appConfigFileExists } from '../../lib/app-config.js';
@@ -26,6 +26,13 @@ ${Object.values(ConfigPaths)
         'swell app push -f content',
         'swell app push -f models/products.json',
     ];
+    static args = {
+        file: Args.string({
+            char: 'f',
+            description: 'relative path to a configuration file or directory to push',
+        }),
+    };
+    // Deprecating the flags in favor of args
     static flags = {
         file: Flags.string({
             char: 'f',
@@ -37,20 +44,25 @@ ${Object.values(ConfigPaths)
     };
     static summary = 'Push configuration files to your Swell app.';
     async run() {
-        const { flags } = await this.parse(AppPush);
-        const { file } = flags;
+        const { args, flags } = await this.parse(AppPush);
+        const { file: fileArg } = args;
+        const { file: fileFlag } = flags;
+        const file = fileArg || fileFlag;
         const currentStore = swellConfig.getDefaultStore();
         this.api.setStoreEnv(currentStore, 'test');
-        this.app = await this.getAppWithConfig(undefined, false);
+        this.app = await this.getAppWithConfig('', false);
         const confirmExistingApp = await this.confirmRemoveInstalledApp(currentStore);
         if (confirmExistingApp === false) {
             return;
         }
         // If app exists but owned by another client, offer to create a new instance
-        if (this.app.client_id !== currentStore) {
+        if (this.app.client_id && this.app.client_id !== currentStore) {
             if (!confirmExistingApp?.id) {
+                const otherAppName = this.app.name || this.appConfig.get('name');
                 const confirmPushNew = await confirm({
-                    message: `${style.appConfigValue(this.app.name)} has a dev version in another store (${style.storeId(this.app.client_id)}). Do you want to create a new development instance in ${style.storeId(currentStore)}?`,
+                    message: `${style.appConfigValue(otherAppName)} has a dev version in another ${this.app.client_id
+                        ? `store ${style.dim(`(${this.app.client_id})`)}`
+                        : 'environment'}. Do you want to create a new development instance in ${style.storeId(currentStore)}?`,
                     default: false,
                 });
                 if (!confirmPushNew) {

package/dist/commands/logs.d.ts

@@ -18,6 +18,7 @@ export default class Logs extends SwellCommand {
     static summary: string;
     private output;
     run(): Promise<void>;
+    __run(): Promise<void>;
     private getLogs;
     private getLogsAndWriteToStream;
 }

package/dist/commands/logs.js

@@ -1,4 +1,5 @@
 import { Flags } from '@oclif/core';
+import ora from 'ora';
 import { LineOutput, LoggedItem, TableOutput } from '../lib/logs/index.js';
 import { SwellCommand } from '../swell-command.js';
 // the columns available to display in the table
@@ -162,6 +163,10 @@ export default class Logs extends SwellCommand {
     static summary = 'Output or stream store logs to the terminal.';
     output;
     async run() {
+        const spinner = ora();
+        spinner.fail('This command is temporarily disabled. Check back soon.');
+    }
+    async __run() {
         const { flags } = await this.parse(Logs);
         // indentify the columns to display
         const columns = flags.columns.split(',');

package/dist/lib/api.js

@@ -65,8 +65,17 @@ export default class Api {
             throw new Error('Operation not supported.');
         const resp = await fetch(path, fetchOptions);
         const respData = await resp.text();
-        if (!resp.ok)
-            throw new Error(respData);
+        if (!resp.ok) {
+            // Try to parse error message
+            let errorJson;
+            try {
+                errorJson = JSON.parse(respData);
+            }
+            catch {
+                // ignore
+            }
+            throw new Error(errorJson?.error?.message || errorJson?.error || respData);
+        }
         try {
             return JSON.parse(respData);
         }

package/dist/lib/apps/app-config.js

@@ -68,9 +68,12 @@ class AppConfig {
         }
     }
     async postData() {
-        if (!this.localPath || !this.fileData) {
+        if (!this.localPath) {
             throw new Error('Missing local config path');
         }
+        if (!this.fileData) {
+            return;
+        }
         if (this.localPath.endsWith('.json')) {
             try {
                 this.values = JSON.parse(this.fileData);

package/dist/lib/bundle.js

@@ -22,6 +22,9 @@ export async function bundleFunction(filePath) {
             ? line.replace('module.exports', 'var moduleExports')
             : line)
             .join('\n');
+        // Remove comments with to get a unique hash in the API
+        // Because esbuild puts the file name as a comment
+        code = code.replace(/^[\n]?\/\/.*/gm, '');
         // eslint-disable-next-line no-new-func
         const evalFn = new Function(`${code}\nreturn { ...moduleExports }`);
         const { config, ...moduleExports } = evalFn();

package/dist/lib/constants.js

@@ -13,5 +13,5 @@ export function getAdminApiBaseUrl(storeId) {
     return ADMIN_API_BASE_URL.replace('${STORE_ID}', storeId);
 }
 export function getLoginHost(storeId) {
-    return LOGIN_HOST.replace('${STORE_ID}', storeId || 'app');
+    return LOGIN_HOST.replace('${STORE_ID}', storeId || 'login');
 }

package/dist/lib/create/index.d.ts

@@ -5,7 +5,7 @@ interface CreateFileParams {
 }
 declare const toFileName: (value: string) => string;
 declare const toAppName: (value: string) => string;
-declare const toAppId: (value: string) => string;
+declare const toAppId: (value: string | undefined) => string;
 declare const toFunctionFileName: (value: string) => string;
 declare const toCollectionName: (value: string) => string;
 declare const toCollectionLabel: (value: string) => string;

package/dist/lib/create/index.js

@@ -4,9 +4,11 @@ const toFileName = (value) => dasherize(underscore(value.split('.')[0].replace('
 // Example: 'my-things' => 'My Things'
 const toAppName = (value) => pluralize(titleize(value).replace('-', ' '));
 // Example: 'My App' => 'my_app'
-const toAppId = (value) => value
-    .replace(/[^a-z0-9]+/gi, '_')
-    .replace(/^\_|\_$/g, '')
+const toAppId = (value) => String(value || '')
+    .replace(/[^a-zA-Z0-9\-_\s:\.\/]/g, '')
+    .replace(/[_\s-:\.\/]+/g, '_')
+    .replace(/^[_]+|[_]+$/g, '')
+    .replace(/([a-z])([A-Z])/g, '$1_$2')
     .toLowerCase();
 // Example: 'My Thing' => 'my-thing'
 // And: 'myThing' => 'myThing'

package/dist/remote-app-command.js

@@ -1,11 +1,11 @@
 import { inflect } from 'inflection';
-import snakeCase from 'lodash/snakeCase.js';
 import * as fs from 'node:fs';
 import * as path from 'node:path';
 import ora from 'ora';
 import { AppCommand } from './app-command.js';
 import { appConfigFileExists, readRcFile, writeRcFile, } from './lib/app-config.js';
 import { FunctionProcessingError, IgnoringFileError, allConfigFilesPaths, appConfigFromFile, appLogoIcon, batchAppConfigsByType, configFilePath, isAppLogoIcon, } from './lib/apps/index.js';
+import { toAppId } from './lib/create/index.js';
 import { default as swellConfig } from './lib/config.js';
 import { getLoginHost } from './lib/constants.js';
 import style from './lib/style.js';
@@ -64,7 +64,7 @@ export class RemoteAppCommand extends AppCommand {
                 this.error(`App ${style.appConfigName('id')} is not defined in swell.json.`);
             }
             if (privateId !== appConfigId) {
-                this.error(`App ${style.appConfigName('id')} must be defined in snake_case: ${style.appConfigValue(appConfigId)}.`);
+                this.error(`App ${style.appConfigName('id')} must be declared in snake_case: ${style.appConfigValue(appConfigId)}.`);
             }
             appId = privateId;
         }
@@ -97,7 +97,7 @@ export class RemoteAppCommand extends AppCommand {
                     : errorJson.error.message;
                 this.error(errorMessage);
             }
-            if (swellId) {
+            if (swellId && swellId !== id && swellId !== this.app?.id) {
                 app = await this.getAppWithConfig(swellId);
             }
         }
@@ -105,7 +105,15 @@ export class RemoteAppCommand extends AppCommand {
     }
     async getCreateUpdateApp(updateApp) {
         const spinner = ora();
-        const remoteApp = await readRcFile(this.swellRcPath());
+        let remoteApp;
+        try {
+            remoteApp = await readRcFile(this.swellRcPath());
+        }
+        catch (error) {
+            if (error.code !== 'ENOENT') {
+                throw error;
+            }
+        }
         /* eslint-disable camelcase */
         const body = {
             ...this.appConfig.store,
@@ -113,7 +121,9 @@ export class RemoteAppCommand extends AppCommand {
             // when posting to the API
             id: undefined,
             logo_icon: null,
-            private_id: this.app?.private_id,
+            ...(this.appConfig.store.id
+                ? { private_id: this.appConfig.store.id }
+                : undefined),
             ...(remoteApp?.id ? { source_id: remoteApp.id } : undefined),
         };
         const logoIcon = appLogoIcon(this.appPath);
@@ -126,17 +136,23 @@ export class RemoteAppCommand extends AppCommand {
         let appCreated = false;
         if (!app.id) {
             // May already have a dev instance
-            const existingDevApp = await this.api.get({
-                adminPath: `/apps/${this.app?.private_id}`,
-            });
+            let existingDevApp;
+            try {
+                existingDevApp = await this.api.get({
+                    adminPath: `/apps/${this.appConfig.store.id}`,
+                });
+            }
+            catch (err) {
+                // noop
+            }
             spinner.start(`Creating app...`);
             if (existingDevApp) {
                 app = await this.handleRequestErrors(async () => this.api.put({ adminPath: `/apps/${existingDevApp.id}` }, { body }), () => spinner.fail('Error creating app'));
             }
             else {
                 app = await this.handleRequestErrors(async () => this.api.post({ adminPath: '/apps' }, { body }), () => spinner.fail('Error creating app'));
+                appCreated = true;
             }
-            appCreated = true;
         }
         else if (app.id) {
             spinner.start(`Updating app...`);
@@ -220,6 +236,10 @@ export class RemoteAppCommand extends AppCommand {
         spinner.start(`Pushing ${pathDesc}`);
         try {
             postData = await appConfig.postData();
+            if (!postData) {
+                spinner.stop();
+                return;
+            }
         }
         catch (error) {
             if (error instanceof IgnoringFileError) {
@@ -327,8 +347,9 @@ export class RemoteAppCommand extends AppCommand {
             }
         }
         if (this.appConfig.get('id')) {
+            // use the same formula as the backend api
             // eslint-disable-next-line camelcase
-            remoteApp.private_id = snakeCase(this.appConfig.get('id'));
+            remoteApp.private_id = toAppId(this.appConfig.get('id'));
         }
         return remoteApp;
     }

package/oclif.manifest.json

@@ -452,7 +452,12 @@
     },
     "app:push": {
       "aliases": [],
-      "args": {},
+      "args": {
+        "file": {
+          "description": "relative path to a configuration file or directory to push",
+          "name": "file"
+        }
+      },
       "description": "Push all app configurations, a specific file, or a specific configuration\ntype to an app in your store's test environment. If the app does not exist yet,\nit will be created and its global ID saved to a .swellrc file.\n\n- If no file is specified, all configuration files will be pushed to the store.\n  This includes the app icon (assets/icon.png) and swell.json.\n- If a file is specified, only that file will be pushed to the store.\n- If a directory is specified, only files in that directory will be pushed.\n\nApp configuration directories:\nassets/\ncontent/\nfunctions/\nmodels/\nnotifications/\nsettings/\nwebhooks/",
       "examples": [
         "swell app push",
@@ -1081,5 +1086,5 @@
       ]
     }
   },
-  "version": "2.0.1-alpha.0"
+  "version": "2.0.1-alpha.11"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@swell/cli",
-  "version": "2.0.1-alpha.0",
+  "version": "2.0.1-alpha.11",
   "type": "module",
   "description": "Swell's command line interface/utility",
   "keywords": [
@@ -26,27 +26,28 @@
     "/oclif.manifest.json"
   ],
   "dependencies": {
+    "@inquirer/prompts": "3.2.0",
     "@npmcli/git": "5.0.3",
     "@oclif/core": "3.7.1",
+    "@oclif/errors": "1.3.6",
     "@oclif/plugin-help": "6.0.4",
     "@oclif/plugin-plugins": "3.9.4",
+    "chalk": "5.3.0",
     "conf": "11.0.2",
     "configstore": "6.0.0",
+    "esbuild": "0.19.5",
     "inflection": "3.0.0",
+    "lodash": "4.17.21",
     "node-fetch": "3.3.2",
     "oclif": "4.0.3",
     "open": "9.1.0",
+    "ora": "7.0.1",
     "semver": "7.5.4",
     "table": "6.8.1"
   },
   "devDependencies": {
-    "@inquirer/prompts": "3.2.0",
     "@inquirer/testing": "2.1.8",
-    "@oclif/errors": "1.3.6",
     "@oclif/test": "3.0.3",
-    "@rollup/plugin-commonjs": "25.0.7",
-    "@rollup/plugin-json": "6.0.1",
-    "@rollup/plugin-node-resolve": "15.2.3",
     "@types/chai": "4.3.9",
     "@types/configstore": "6.0.1",
     "@types/inquirer": "9.0.6",
@@ -54,30 +55,20 @@
     "@types/node": "20.8.8",
     "@typescript-eslint/eslint-plugin": "6.9.0",
     "chai": "4.3.10",
-    "chalk": "5.3.0",
-    "configstore": "6.0.0",
     "dotenv": "16.3.1",
-    "esbuild": "0.19.5",
     "eslint": "8.52.0",
     "eslint-config-oclif": "5.0.0",
     "eslint-config-oclif-typescript": "3.0.8",
     "eslint-config-prettier": "9.0.0",
     "eslint-plugin-prettier": "5.0.1",
     "eslint-plugin-unicorn": "48.0.1",
-    "list-it": "1.3.12",
-    "lodash": "4.17.21",
     "mocha": "10.2.0",
     "nock": "13.3.6",
-    "npm-decode": "1.4.2",
     "oclif": "4.0.3",
-    "ora": "7.0.1",
-    "rollup": "4.1.4",
     "shx": "0.3.4",
     "testdouble": "3.20.0",
     "ts-node": "10.9.1",
-    "tslib": "2.6.2",
-    "typescript": "5.2.2",
-    "uvu": "0.5.6"
+    "typescript": "5.2.2"
   },
   "oclif": {
     "bin": "swell",
@@ -103,7 +94,7 @@
     "posttest": "npm run lint",
     "prepack": "npm run build && oclif manifest && oclif readme",
     "test": "mocha --forbid-only \"test/**/*.test.ts\"",
-    "version": "oclif readme && git add README.md"
+    "publish-alpha": "npm version prerelease --preid=alpha && npm publish --tag alpha"
   },
   "engines": {
     "node": ">= 18.16.1"