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

package/dist/create-command.js

@@ -44,14 +44,16 @@ export class CreateCommand extends AppCommand {
     async getCollectionOptions() {
         const models = await this.api.post({ adminPath: `/data/$get/:models` }, {
             body: {
-                limit: 1000,
-                client_id: null,
-                app_id: null,
                 abstract: { $ne: true },
+                // eslint-disable-next-line camelcase
+                app_id: null,
+                // eslint-disable-next-line camelcase
+                client_id: null,
                 deprecated: { $ne: true },
+                fields: 'name, namespace',
+                limit: 1000,
                 name: { $nin: ['events', 'notifications', 'settings'] },
                 sort: 'namespace asc, name asc',
-                fields: 'name, namespace',
             },
         });
         return (models?.results?.map((model) => model.namespace ? `${model.namespace}/${model.name}` : model.name) || []);

package/dist/lib/api.d.ts

@@ -1,13 +1,14 @@
 export default class Api {
+    private envId;
     private secretKey;
     private storeId;
-    private envId;
     constructor(storeId?: string, envId?: string, secretKey?: string);
-    setStoreEnv(storeId: string, envId?: string): void;
     api(pathOpts: Api.Paths, options: Api.RequestOptions): Promise<any>;
     delete(pathOpts: Api.Paths, options?: Api.RequestOptions): Promise<any>;
     get(pathOpts: Api.Paths, options?: Api.RequestOptions): Promise<any>;
     isAdmin(): boolean;
     post(pathOpts: Api.Paths, options?: Api.RequestOptions): Promise<any>;
     put(pathOpts: Api.Paths, options?: Api.RequestOptions): Promise<any>;
+    setStoreEnv(storeId: string, envId?: string): void;
+    truncatePath(path: string | undefined): string | undefined;
 }

package/dist/lib/api.js

@@ -1,6 +1,6 @@
 import fetch from 'node-fetch';
 import config from './config.js';
-import { getAdminApiBaseUrl, API_BASE_URL } from './constants.js';
+import { API_BASE_URL, getAdminApiBaseUrl } from './constants.js';
 const defaultHeaders = (opts) => ({
     'Content-Type': 'application/json',
     ...opts,
@@ -23,18 +23,14 @@ const authenticatedHeaders = (storeId, opts = {}) => {
     return defaultHeaders(moreOpts);
 };
 export default class Api {
+    envId;
     secretKey;
     storeId;
-    envId;
     constructor(storeId, envId, secretKey) {
         this.storeId = storeId;
         this.envId = envId;
         this.secretKey = secretKey;
     }
-    setStoreEnv(storeId, envId) {
-        this.storeId = storeId;
-        this.envId = envId;
-    }
     async api(pathOpts, options) {
         const storeId = this.storeId || config.getDefaultStore();
         let path;
@@ -51,8 +47,8 @@ export default class Api {
             },
         };
         path = this.isAdmin()
-            ? `${getAdminApiBaseUrl(storeId)}/${pathOpts.adminPath}`
-            : `${API_BASE_URL}/${pathOpts.backendPath}`;
+            ? `${getAdminApiBaseUrl(storeId)}/${this.truncatePath(pathOpts.adminPath)}`
+            : `${API_BASE_URL}/${this.truncatePath(pathOpts.backendPath)}`;
         if (options.query) {
             const query = new URLSearchParams(options.query);
             path += `?${query.toString()}`;
@@ -123,4 +119,11 @@ export default class Api {
             ...options,
         });
     }
+    setStoreEnv(storeId, envId) {
+        this.storeId = storeId;
+        this.envId = envId;
+    }
+    truncatePath(path) {
+        return path?.startsWith('/') ? path.slice(1) : path;
+    }
 }

package/dist/lib/app-config.d.ts

@@ -23,6 +23,7 @@ declare function config(configDirPath?: string): LocalApp;
 /**
  * Returns a new configuration instance in the current working directory only.
  *
+ * @param path Path of the current working directory
  * @returns Conf
  */
 declare function newConfig(path?: string): any;

package/dist/lib/app-config.js

@@ -5,12 +5,13 @@ import Conf from 'conf';
 import * as fs from 'node:fs';
 import * as path from 'node:path';
 const schema = {
+    description: { type: 'string' },
     id: { type: 'string' },
-    version: { type: 'string' },
+    integrations: { type: 'array' },
     name: { type: 'string' },
-    description: { type: 'string' },
-    type: { type: 'string' },
     permissions: { type: 'array' },
+    type: { type: 'string' },
+    version: { type: 'string' },
 };
 const APP_FILE_NAME = 'swell';
 const APP_FILE_EXT = 'json';
@@ -115,6 +116,7 @@ function config(configDirPath = '') {
 /**
  * Returns a new configuration instance in the current working directory only.
  *
+ * @param path Path of the current working directory
  * @returns Conf
  */
 function newConfig(path) {

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

@@ -64,4 +64,4 @@ declare function findAppConfig(app: App, file: string, configType: ConfigType):
 declare function batchAppConfigsByType(appConfigs: AppConfig[]): Array<any>;
 export { App, AppVersion, ConfigInputFields, ConfigPaths, ConfigPathsType, ConfigType, appConfigFromFile, appLogoIcon, batchAppConfigsByType, fileExists, findAppConfig, getConfigTypeFromPath, getConfigTypeKeyFromValue, hasAllowedFileExtension, isAppLogoIcon, writeFile, writeJsonFile, };
 export { AppConfig, FunctionProcessingError, IgnoringFileError, } from './app-config.js';
-export { allConfigDirsPaths, allConfigFilesPaths, allConfigFilesPathsByType, getAllConfigPaths, configFilePath, } from './paths.js';
+export { allConfigDirsPaths, allConfigFilesPaths, allConfigFilesPathsByType, configFilePath, getAllConfigPaths, } from './paths.js';

package/dist/lib/apps/index.js

@@ -164,4 +164,4 @@ export { ConfigInputFields, ConfigPaths, ConfigType,
 // functions
 appConfigFromFile, appLogoIcon, batchAppConfigsByType, fileExists, findAppConfig, getConfigTypeFromPath, getConfigTypeKeyFromValue, hasAllowedFileExtension, isAppLogoIcon, writeFile, writeJsonFile, };
 export { AppConfig, FunctionProcessingError, IgnoringFileError, } from './app-config.js';
-export { allConfigDirsPaths, allConfigFilesPaths, allConfigFilesPathsByType, getAllConfigPaths, configFilePath, } from './paths.js';
+export { allConfigDirsPaths, allConfigFilesPaths, allConfigFilesPathsByType, configFilePath, getAllConfigPaths, } from './paths.js';

package/dist/lib/apps/paths.d.ts

@@ -15,4 +15,4 @@ declare function allConfigFilesPathsByType(appPath: string, configTypeKey: strin
 }, void, unknown>;
 declare function configFilePath(appPath: string, config: AppConfig): string;
 declare function getAllConfigPaths(): Array<string>;
-export { allConfigDirsPaths, allConfigFilesPaths, allConfigFilesPathsByType, getAllConfigPaths, configFilePath, };
+export { allConfigDirsPaths, allConfigFilesPaths, allConfigFilesPathsByType, configFilePath, getAllConfigPaths, };

package/dist/lib/apps/paths.js

@@ -51,4 +51,4 @@ function getAllConfigPaths() {
     }
     return configPaths;
 }
-export { allConfigDirsPaths, allConfigFilesPaths, allConfigFilesPathsByType, getAllConfigPaths, configFilePath, };
+export { allConfigDirsPaths, allConfigFilesPaths, allConfigFilesPathsByType, configFilePath, getAllConfigPaths, };

package/dist/lib/bundle.js

@@ -24,7 +24,7 @@ export async function bundleFunction(filePath) {
             .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, '');
+        code = code.replaceAll(/^\n?\/\/.*/gm, '');
         // eslint-disable-next-line no-new-func
         const evalFn = new Function(`${code}\nreturn { ...moduleExports }`);
         const { config, ...moduleExports } = evalFn();
@@ -32,7 +32,6 @@ export async function bundleFunction(filePath) {
         return { code, config, dependencies, moduleExports };
     }
     catch (error) {
-        console.log(error);
         throw new Error(`Unable to compile function ${filePath}: ${error.message}`);
     }
 }
@@ -44,13 +43,13 @@ function getSwellFunctionWrapper() {
 async function minifyCode(code) {
     try {
         const result = await esbuild.transform(code, {
-            minifyWhitespace: true,
             minifyIdentifiers: false,
             minifySyntax: false,
+            minifyWhitespace: true,
         });
         return result.code;
     }
-    catch (err) {
-        throw new Error('Compilation error:', err.message);
+    catch (error) {
+        throw new Error('Compilation error:', error.message);
     }
 }

package/dist/lib/constants.js

@@ -1,11 +1,10 @@
+/* eslint-disable no-template-curly-in-string */
 import { env } from './config.js';
 // note: env values stored in ~/.swell/env.json
 // url for backend api calls
 export const API_BASE_URL = env.get('API_BASE_URL') || 'https://api.swell.store';
 // url for admin api calls
-export const ADMIN_API_BASE_URL = 
-// eslint-disable-next-line no-template-curly-in-string
-env.get('ADMIN_API_BASE_URL') || 'https://${STORE_ID}.swell.store/admin/api';
+export const ADMIN_API_BASE_URL = env.get('ADMIN_API_BASE_URL') || 'https://${STORE_ID}.swell.store/admin/api';
 // url host for admin login
 export const LOGIN_HOST = env.get('LOGIN_HOST') || 'https://${STORE_ID}.swell.store';
 // helpers to get constants with replacements

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

@@ -1,8 +1,8 @@
 interface CreateContentFileBody {
     collection: string;
-    label?: string;
     description?: string;
     fields?: ContentFieldProps[];
+    label?: string;
     views?: ContentViewProps[];
 }
 interface ContentViewProps {

package/dist/lib/create/content.js

@@ -8,8 +8,8 @@ const parseViews = (views) => {
         viewResponse.push({
             id: viewId,
             ...(viewId === 'list' ? { nav: {} } : {}),
-            tabs: [],
             fields: [],
+            tabs: [],
         });
     }
     return viewResponse;

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

@@ -7,11 +7,11 @@ interface CreateFunctionArgs {
 interface WriteFunctionFileParams {
     description: string;
     events: string;
-    route: string;
     functionName: string;
     language: FunctionLanguage;
+    route: string;
     schedule: string;
     trigger: FunctionType;
 }
-declare const getFunctionTemplate: ({ description, events, route, schedule, language, trigger, }: WriteFunctionFileParams) => string;
+declare const getFunctionTemplate: ({ description, events, language, route, schedule, trigger, }: WriteFunctionFileParams) => string;
 export { CreateFunctionArgs, FunctionLanguage, FunctionType, WriteFunctionFileParams, getFunctionTemplate, };

package/dist/lib/create/function.js

@@ -1,9 +1,9 @@
-const getFunctionTemplate = ({ description, events, route, schedule, language, trigger, }) => {
+const getFunctionTemplate = ({ description, events, language, route, schedule, trigger, }) => {
     let typeAppend = ``;
     if (trigger === 'model') {
         const eventsList = events
             .split(/\s*,\s*/g)
-            .filter((e) => e)
+            .filter(Boolean)
             .map((eventName) => `'${eventName}'`)
             .join(', ');
         typeAppend = `,

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

@@ -10,4 +10,4 @@ declare const toFunctionFileName: (value: string) => string;
 declare const toCollectionName: (value: string) => string;
 declare const toCollectionLabel: (value: string) => string;
 declare const toNotificationLabel: (value: string) => string;
-export { CreateFileParams, toFileName, toAppName, toAppId, toFunctionFileName, toCollectionName, toCollectionLabel, toNotificationLabel, };
+export { CreateFileParams, toAppId, toAppName, toCollectionLabel, toCollectionName, toFileName, toFunctionFileName, toNotificationLabel, };

package/dist/lib/create/index.js

@@ -1,14 +1,14 @@
-import { dasherize, pluralize, underscore, titleize } from 'inflection';
+import { dasherize, pluralize, titleize, underscore } from 'inflection';
 // Example: 'My Thing' => 'my-thing'
 const toFileName = (value) => dasherize(underscore(value.split('.')[0].replace(' ', '_'))).toLowerCase();
 // Example: 'my-things' => 'My Things'
 const toAppName = (value) => pluralize(titleize(value).replace('-', ' '));
 // Example: 'My App' => 'my_app'
 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')
+    .replaceAll(/[^\s\w./:-]/g, '')
+    .replaceAll(/[_\s-:./]+/g, '_')
+    .replaceAll(/^_+|_+$/g, '')
+    .replaceAll(/([a-z])([A-Z])/g, '$1_$2')
     .toLowerCase();
 // Example: 'My Thing' => 'my-thing'
 // And: 'myThing' => 'myThing'
@@ -19,4 +19,4 @@ const toCollectionName = (value) => pluralize(value.replaceAll(/[^A-Za-z]/g, '-'
 const toCollectionLabel = (value) => pluralize(titleize(value).replace('-', ' '));
 // Example: 'order-receipt' => 'Order Receipt'
 const toNotificationLabel = (value) => titleize(value).replace('-', ' ');
-export { toFileName, toAppName, toAppId, toFunctionFileName, toCollectionName, toCollectionLabel, toNotificationLabel, };
+export { toAppId, toAppName, toCollectionLabel, toCollectionName, toFileName, toFunctionFileName, toNotificationLabel, };

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

@@ -1,9 +1,9 @@
 interface CreateModelFileBody {
-    label?: string;
     collection?: string;
     description?: string;
-    fields?: ModelFieldResponse;
     events?: ModelEventObject;
+    fields?: ModelFieldResponse;
+    label?: string;
 }
 interface ModelEventObject {
     types?: ModelEvent[];

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

@@ -1,11 +1,11 @@
 interface WriteNotificationsFileParams {
+    admin?: boolean;
     description: string;
     event: string;
     model: string;
     name: string;
-    subject: string;
-    admin?: boolean;
     once?: boolean;
+    subject: string;
 }
 interface CreateNotificationFileBody {
     admin?: boolean;

package/dist/lib/sessions.js

@@ -20,7 +20,6 @@ function createServer(onSessionId, storeId) {
     // the spinner is used to show progress while waiting for the browser
     const spinner = ux.action;
     serverForLogin({
-        storeId,
         onPost(req) {
             // we received the session id from the browser so we can move on
             const sessionId = req.headers['x-session'];
@@ -37,6 +36,7 @@ function createServer(onSessionId, storeId) {
             ].join(' '));
             await open(loginUrl);
         },
+        storeId,
     });
 }
 /**
@@ -52,7 +52,7 @@ function createServer(onSessionId, storeId) {
  * from the browser
  * @returns void
  */
-function serverForLogin({ storeId, onPost, onStart, }) {
+function serverForLogin({ onPost, onStart, storeId, }) {
     // flag to track if the POST and GET requests have been handled
     // we only want to handle them once
     let postHandled = false;

package/dist/lib/stores.d.ts

@@ -35,6 +35,7 @@ declare function selectStoreId({ authorizations, currentStoreId, force, }: {
  * Select the store to switch to from a CLI prompt from the list of
  * already logged in stores.
  *
+ * @param message Store selection message
  * @returns The store ID to switch to
  * @throws CLIError - If there are no stores to switch to
  */
@@ -42,6 +43,8 @@ declare function selectLoggedInStoreId(message?: string): Promise<string>;
 /**
  * Select an environment.
  *
+ * @param message Environment selection message
+ * @returns Environment to switch to
  * @throws CLIError - If there are no stores to switch to
  */
 declare function selectEnvironmentId(message?: string): Promise<string>;
@@ -60,4 +63,4 @@ declare function modifyDefaultStore({ currentStoreId, storeId, }: {
     currentStoreId: string;
     storeId: string;
 }): Promise<void>;
-export { modifyDefaultStore, selectLoggedInStoreId, selectStoreId, selectEnvironmentId, showStores, };
+export { modifyDefaultStore, selectEnvironmentId, selectLoggedInStoreId, selectStoreId, showStores, };

package/dist/lib/stores.js

@@ -101,6 +101,7 @@ async function selectStoreId({ authorizations, currentStoreId, force = false, })
  * Select the store to switch to from a CLI prompt from the list of
  * already logged in stores.
  *
+ * @param message Store selection message
  * @returns The store ID to switch to
  * @throws CLIError - If there are no stores to switch to
  */
@@ -123,14 +124,16 @@ async function selectLoggedInStoreId(message) {
             new Separator(),
             { name: 'Login to another account', value: '' },
         ],
+        loop: false,
         message: message || 'Which store do you want to switch to?',
         pageSize: 25,
-        loop: false,
     });
 }
 /**
  * Select an environment.
  *
+ * @param message Environment selection message
+ * @returns Environment to switch to
  * @throws CLIError - If there are no stores to switch to
  */
 async function selectEnvironmentId(message) {
@@ -145,7 +148,7 @@ async function selectEnvironmentId(message) {
                 value: 'test',
             },
         ],
-        message: message || 'Which envoronment?',
+        message: message || 'Which environment?',
     });
 }
 /**
@@ -170,4 +173,4 @@ async function modifyDefaultStore({ currentStoreId, storeId, }) {
         config.setDefaultStore(storeId);
     }
 }
-export { modifyDefaultStore, selectLoggedInStoreId, selectStoreId, selectEnvironmentId, showStores, };
+export { modifyDefaultStore, selectEnvironmentId, selectLoggedInStoreId, selectStoreId, showStores, };

package/dist/lib/swell-function-wrapper.d.ts

@@ -84,11 +84,11 @@ declare class SwellRequest {
     ingestLogs(response: any): Promise<void>;
     /**
      * Merge values into app data for the current request.
-     * @param {object|string|undefined} idOrValues string to indicate app ID, or values to merge
+     * @param {object|string} idOrValues string to indicate app ID, or values to merge
      * @param {object|undefined} values values to merge into app data
      * @returns {object|undefined} existing app data merged with values if passed
      */
-    appValues(idOrValues?: object | string | undefined, values?: object | undefined): object | undefined;
+    appValues(idOrValues: object | string, values?: object | undefined): object | undefined;
 }
 /**
  * Class representing the Swell backend API.

package/dist/lib/swell-function-wrapper.js

@@ -182,11 +182,11 @@ class SwellRequest {
     }
     /**
      * Merge values into app data for the current request.
-     * @param {object|string|undefined} idOrValues string to indicate app ID, or values to merge
+     * @param {object|string} idOrValues string to indicate app ID, or values to merge
      * @param {object|undefined} values values to merge into app data
      * @returns {object|undefined} existing app data merged with values if passed
      */
-    appValues(idOrValues = undefined, values = undefined) {
+    appValues(idOrValues, values = undefined) {
         const appId = typeof idOrValues === 'string' ? appIdOrValues : this.appId;
         const appValues = typeof idOrValues === 'string' ? values : idOrValues;
         if (!appId || !isOrdinaryObject(appValues)) {

package/dist/remote-app-command.d.ts

@@ -14,12 +14,14 @@ export declare abstract class RemoteAppCommand extends AppCommand {
     protected getApp(id?: string): Promise<App>;
     protected getAppWithConfig(id?: string): Promise<App>;
     protected getCreateUpdateApp(updateApp?: App): Promise<App>;
+    protected getVersions(version?: null | string | undefined): Promise<AppVersion[]>;
     protected handleRequestErrors(request: () => any, spinnerError?: () => void): Promise<any>;
     init(): Promise<void>;
     protected postConfig(configJson: any): Promise<any>;
     protected pushConfigFile(appConfig: AppConfig): Promise<any>;
     protected removeConfig(config: AppConfig): Promise<any>;
     protected showErrors(errors: any, spinnerError?: () => void): void;
+    protected swellRcPath(): string;
     protected syncAppConfigs(): Promise<{
         installed: string[];
         removed: string[];
@@ -31,6 +33,4 @@ export declare abstract class RemoteAppCommand extends AppCommand {
      */
     private initApp;
     private showOrientation;
-    protected getVersions(version?: string | undefined | null): Promise<AppVersion[]>;
-    protected swellRcPath(): string;
 }

package/dist/remote-app-command.js

@@ -5,9 +5,9 @@ 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 { toAppId } from './lib/create/index.js';
 import style from './lib/style.js';
 /**
  * Extends the AppCommand with methods that ease managing remote apps and
@@ -22,7 +22,7 @@ export class RemoteAppCommand extends AppCommand {
     dashboardUrl(flags = {}, storeId) {
         const { env } = flags;
         const envFlag = env || this.ctor.orientation?.env;
-        const outputEnv = envFlag === 'live' ? '' : !envFlag ? '' : 'test';
+        const outputEnv = envFlag === 'live' ? '' : envFlag ? 'test' : '';
         return `${getLoginHost(storeId)}/admin/${outputEnv ? `${outputEnv}/` : ''}apps/${this.app.id}`;
     }
     async deleteConfig(configId) {
@@ -142,7 +142,7 @@ export class RemoteAppCommand extends AppCommand {
                     adminPath: `/apps/${this.appConfig.store.id}`,
                 });
             }
-            catch (err) {
+            catch {
                 // noop
             }
             spinner.start(`Creating app...`);
@@ -180,6 +180,17 @@ export class RemoteAppCommand extends AppCommand {
         }
         return {};
     }
+    async getVersions(version) {
+        const versionsResponse = await this.api.get({ adminPath: `/apps/${this.app.id}/versions` }, {
+            query: {
+                limit: 1000,
+                sort: 'version desc',
+                ...(version ? { version } : undefined),
+            },
+        });
+        this.debugJson('getApp: versionsResponse', versionsResponse);
+        return versionsResponse.results || [];
+    }
     async handleRequestErrors(request, spinnerError) {
         try {
             const response = await request();
@@ -291,6 +302,9 @@ export class RemoteAppCommand extends AppCommand {
                 .join(' '));
         }
     }
+    swellRcPath() {
+        return path.join(this.appPath, '.swellrc');
+    }
     async syncAppConfigs() {
         const configsToPush = [];
         const installed = [];
@@ -306,8 +320,8 @@ export class RemoteAppCommand extends AppCommand {
         const batches = batchAppConfigsByType(configsToPush);
         for (const batch of batches) {
             this.log(style.appConfigName(batch.label));
-            // eslint-disable-next-line no-await-in-loop
             for (const appConfig of batch.configs) {
+                // eslint-disable-next-line no-await-in-loop
                 const installedConfig = await this.pushConfigFile(appConfig);
                 if (installedConfig)
                     installed.push(installedConfig.id);
@@ -375,18 +389,4 @@ export class RemoteAppCommand extends AppCommand {
         this.log(orientationOutput.join(' '));
         this.log();
     }
-    async getVersions(version) {
-        const versionsResponse = await this.api.get({ adminPath: `/apps/${this.app.id}/versions` }, {
-            query: {
-                limit: 1000,
-                sort: 'version desc',
-                ...(version ? { version } : undefined),
-            },
-        });
-        this.debugJson('getApp: versionsResponse', versionsResponse);
-        return versionsResponse.results || [];
-    }
-    swellRcPath() {
-        return path.join(this.appPath, '.swellrc');
-    }
 }