@swell/cli 2.9.4 → 2.9.6

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

@@ -1,193 +1 @@
-/**
- * Handle a function request.
- * @param {Request} originalRequest from cloudflare
- * @param {*} _env cloudflare environment vars
- * @param {*} context cloudflare conttext
- * @returns {Promise<SwellResponse>}
- */
-declare function request(originalRequest: Request, _env: any, context: any): Promise<SwellResponse>;
-/**
- * Invokes one of the function types that are available.
- *
- * Type-1: Named export function handlers
- * ```
- * export function post (req) {
- *
- * }
- * ```
- *
- * Important note:
- * - `delete` func cannot be implemented in Type-1 since it's a reserved name. So, consider using Type-3.
- *
- * Type-2: Default export function handlers
- * ```
- * export default function (req) {
- *
- * }
- * ```
- *
- * Type-3: Default object with named function handlers
- * ```
- * export default {
- *   delete(req) {
- *
- *   },
- *   post(req) {
- *
- *   },
- * }
- * ```
- *
- * @param {SwellRequest} req
- * @param {Event} context
- */
-declare function executeModuleHandler(req: SwellRequest, context: Event): Promise<any>;
-/**
- * Helper to determine if a value is an ordinary object.
- * @param {any} obj
- * @returns {boolean}
- */
-declare function isOrdinaryObject(val: any): boolean;
-declare function validateWorkflowParams(params: any): any;
-declare function validateWorkflowParamValue(value: any, seen?: WeakSet<object>): void;
-declare function validateWorkflowParamArray(value: any, seen: any): void;
-declare function validateWorkflowParamObject(value: any, seen: any): void;
-declare function createWorkflowParamsError(code: any, message: any): SwellError;
-declare namespace originalConsole {
-    let log: {
-        (...data: any[]): void;
-        (message?: any, ...optionalParams: any[]): void;
-    };
-    let info: {
-        (...data: any[]): void;
-        (message?: any, ...optionalParams: any[]): void;
-    };
-    let debug: {
-        (...data: any[]): void;
-        (message?: any, ...optionalParams: any[]): void;
-    };
-    let warn: {
-        (...data: any[]): void;
-        (message?: any, ...optionalParams: any[]): void;
-    };
-    let error: {
-        (...data: any[]): void;
-        (message?: any, ...optionalParams: any[]): void;
-    };
-}
-declare const WORKFLOW_PARAMS_MAX_BYTES: number;
-/**
- * Class representing a Swell request.
- */
-declare class SwellRequest {
-    constructor(req: any, context: any);
-    originalRequest: any;
-    context: any;
-    appId: any;
-    storeId: any;
-    accessToken: any;
-    publicKey: any;
-    store: any;
-    session: any;
-    logParams: any;
-    apiHost: any;
-    id: any;
-    isLocalDev: boolean;
-    swell: SwellAPI;
-    rawBody: string;
-    body: {};
-    query: {};
-    data: {};
-    _logs: any[];
-    assignRequestProps(req: any): void;
-    initialize(): Promise<void>;
-    url: URL | undefined;
-    parseJson(input: any): any;
-    log(level: any, ...line: any[]): void;
-    getIngestableLogs(response: any): {
-        params: any;
-    } | undefined;
-    formatRequestData(): string;
-    ingestLogs(response: any): Promise<void>;
-    /**
-     * Merge values into app data for the current request.
-     * @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} existing app data merged with values
-     * @throws {Error} if app id is missing or values is not a plain object
-     */
-    appValues(idOrValues: object | string, values: object | undefined): object;
-}
-/**
- * Class representing the Swell backend API.
- */
-declare class SwellAPI {
-    constructor(req: any, context: any);
-    request: any;
-    baseUrl: any;
-    basicAuth: string;
-    context: any;
-    workflows: {
-        create: (name: any, params: any) => Promise<any>;
-    };
-    toBase64(inputString: any): string;
-    stringifyQuery(queryObject: any, prefix: any): any;
-    makeRequest(method: any, url: any, data: any): Promise<any>;
-    get(url: any, query: any): Promise<any>;
-    put(url: any, data: any): Promise<any>;
-    post(url: any, data: any): Promise<any>;
-    delete(url: any, data: any): Promise<any>;
-    settings(id?: any): Promise<any>;
-    createWorkflow(name: any, params: any): Promise<any>;
-    /**
-     * Atomic multi-op write. Throws SwellError with a stable `error.code`
-     * (transaction_conflict | transaction_timeout | transaction_throttled
-     *  | transaction_op_failed | transaction_error). Retry is off by
-     * default — opt in with `{ retry: true }` or pass overrides.
-     *
-     * @param {Array<{method: string, url: string, data?: any}>} ops
-     * @param {{ retry?: true | { limit?: number, base?: number, max?: number, jitter?: boolean } }} [opts]
-     * @returns {Promise<any[]>}
-     */
-    transaction(ops: Array<{
-        method: string;
-        url: string;
-        data?: any;
-    }>, opts?: {
-        retry?: true | {
-            limit?: number | undefined;
-            base?: number | undefined;
-            max?: number | undefined;
-            jitter?: boolean | undefined;
-        } | undefined;
-    } | undefined): Promise<any[]>;
-}
-declare const DEFAULT_RETRY: Readonly<{
-    limit: 3;
-    base: 100;
-    max: 5000;
-    jitter: true;
-}>;
-declare const RETRYABLE_CODES: Set<string>;
-/**
- * Class representing a Swell error.
- */
-declare class SwellError extends Error {
-    constructor(message: any, options?: {});
-    status: any;
-    body: any;
-    code: any;
-    retry: any;
-    get isRetryable(): boolean;
-}
-/**
- * Class representing a Swell response.
- */
-declare class SwellResponse extends Response {
-    static _respond(req: any, response: any, context: any): Promise<any>;
-    static _consumeNativeResponse(response: any): Promise<SwellResponse>;
-    static _respondWithLogs(response: any, req: any): SwellResponse;
-    constructor(data: any, options?: {});
-    _swellData: any;
-    _swellOptions: {};
-}
+export {};

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

@@ -1,4 +1,3 @@
-"use strict";
 const originalConsole = {
     log: console.log,
     info: console.info,
@@ -231,6 +230,9 @@ class SwellRequest {
             },
         };
     }
+    reject(code, message, options = {}) {
+        return new SwellRejection(code, message, options);
+    }
 }
 /**
  * Class representing the Swell backend API.
@@ -415,6 +417,26 @@ class SwellError extends Error {
         return RETRYABLE_CODES.has(this.code);
     }
 }
+class SwellRejection extends Error {
+    constructor(code, message, options = {}) {
+        const status = typeof options.status === 'number' &&
+            options.status >= 400 &&
+            options.status < 500
+            ? options.status
+            : 422;
+        super(message || 'Request rejected by function');
+        this.name = 'SwellRejection';
+        this.status = status;
+        this.code = code;
+        this.body = {
+            $reject: {
+                code,
+                message: this.message,
+                status,
+            },
+        };
+    }
+}
 /**
  * Class representing a Swell response.
  */
@@ -598,3 +620,4 @@ function createWorkflowParamsError(code, message) {
         status: 400,
     });
 }
+export {};

package/dist/lib/theme-sync.js

@@ -1,13 +1,8 @@
 import getPort, { portNumbers } from 'get-port';
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore - http-proxy has incomplete TypeScript definitions
 import httpProxy from 'http-proxy';
 import http from 'node:http';
 import util from 'node:util';
 import zlib from 'node:zlib';
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore - ws library uses named exports differently
-// eslint-disable-next-line import/no-named-as-default
 import WebSocket, { WebSocketServer } from 'ws';
 const gunzipAsync = util.promisify(zlib.gunzip);
 const inflateAsync = util.promisify(zlib.inflate);

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

@@ -1,4 +1,5 @@
-/// <reference types="node" />
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
 import type { GlobbyFilterFunction } from 'globby';
 import * as fs from 'node:fs';
 import { App, AppConfig, ConfigType, FrontendProjectType } from './lib/apps/index.js';
@@ -26,7 +27,7 @@ export declare abstract class PushAppCommand extends RemoteAppCommand {
     deployAppFrontend(force?: boolean, log?: boolean): Promise<void>;
     deployFrontend(projectType: FrontendProjectType): Promise<string>;
     ensureAppExists(file?: string, shouldCreate?: boolean): Promise<boolean>;
-    ensureLoggedIn(): Promise<true | undefined>;
+    ensureLoggedIn(): Promise<void>;
     exec(command: string, cwd?: string, onOutput?: (string: string) => any | false): Promise<void>;
     execFrontend(command: string, onOutput?: (string: string) => any | false): Promise<void>;
     getAllAppStorefronts(params?: {
@@ -46,8 +47,8 @@ export declare abstract class PushAppCommand extends RemoteAppCommand {
         targetPath?: string;
     }, shouldChoose?: boolean): Promise<App | undefined>;
     getExistingApp(appId: string): Promise<App>;
-    getFrontendDeploymentHash(): string | undefined;
-    getFrontendProjectType(required?: boolean): FrontendProjectType | null;
+    getFrontendDeploymentHash(): Promise<string | undefined>;
+    getFrontendProjectType(required?: boolean): Promise<FrontendProjectType | null>;
     getStorefrontToPull(args?: {
         appId?: string;
         targetPath?: string;
@@ -77,7 +78,7 @@ export declare abstract class PushAppCommand extends RemoteAppCommand {
     logStorefrontFrontendUrl(storefront?: any, branchId?: string): void;
     pushFile(relativePath: string): Promise<void>;
     pushFilePath(relativePath: string, force?: boolean): Promise<void>;
-    resolveAppPath(appId?: string, targetPath?: string): string;
+    resolveAppPath(appId?: string, targetPath?: string): Promise<string>;
     runWatchChangeQueue(): Promise<void>;
     saveCurrentStorefront(): void;
     logLocalPreviewUrl(): void;
@@ -89,7 +90,7 @@ export declare abstract class PushAppCommand extends RemoteAppCommand {
         logChanges?: boolean;
         onChange?: (appConfig?: AppConfig, result?: any) => void;
         syncAll?: boolean;
-    }): Promise<void>;
+    }): Promise<fs.FSWatcher>;
     wranglerDeployFrontend(_projectType: FrontendProjectType): Promise<string>;
     private confirmRemoveInstalledApp;
 }

package/dist/push-app-command.js

@@ -6,7 +6,7 @@ import * as path from 'node:path';
 import Stream from 'node:stream';
 import ora from 'ora';
 import { default as swellConfig } from './lib/app-config.js';
-import { ConfigType, getFrontendProjectValidValues, allConfigFilesInDir, CUSTOM_FRAMEWORK_SLUG, appConfigFromFile, filePathExists, filePathExistsAsync, findAppConfig, getConfigTypeFromPath, getConfigTypeKeyFromValue, getFrontendProjectType, getProjectCommands, globAllFilesByPath, hashString, isPathDirectory, } from './lib/apps/index.js';
+import { ConfigType, getFrontendProjectValidValues, allConfigFilesInDir, CUSTOM_FRAMEWORK_SLUG, appConfigFromFile, filePathExistsAsync, findAppConfig, getConfigTypeFromPath, getConfigTypeKeyFromValue, getFrontendProjectType, getProjectCommands, globAllFilesByPath, hashString, isPathDirectory, } from './lib/apps/index.js';
 import { getGlobIgnorePathsChecker } from './lib/apps/paths.js';
 import { slugFromApp } from './lib/apps/slug.js';
 import { default as localConfig } from './lib/config.js';
@@ -121,7 +121,7 @@ export class PushAppCommand extends RemoteAppCommand {
             return;
         }
         // Get commands transformed for the detected package manager
-        const { buildCommand } = getProjectCommands(this.appPath, projectType);
+        const { buildCommand } = await getProjectCommands(this.appPath, projectType);
         if (!buildCommand) {
             // No build command needed for this framework
             return;
@@ -251,11 +251,11 @@ export class PushAppCommand extends RemoteAppCommand {
     }
     async deployAppFrontend(force, log) {
         const currentStore = localConfig.getDefaultStore();
-        const projectType = this.getFrontendProjectType(false);
+        const projectType = await this.getFrontendProjectType(false);
         if (!projectType) {
             return;
         }
-        const deploymentHash = this.getFrontendDeploymentHash();
+        const deploymentHash = await this.getFrontendDeploymentHash();
         // Build and deploy only if there are files to push
         if (deploymentHash &&
             (force || deploymentHash !== this.app.frontend?.deployment_hash)) {
@@ -335,7 +335,6 @@ export class PushAppCommand extends RemoteAppCommand {
             this.log('Logging in...\n');
             await this.config.runCommand('login');
             this.log();
-            return true;
         }
     }
     async exec(command, cwd, onOutput) {
@@ -395,8 +394,8 @@ export class PushAppCommand extends RemoteAppCommand {
         const klass = this.ctor;
         const currentStore = localConfig.getDefaultStore();
         await this.api.setStoreEnv(currentStore, klass.orientation?.env);
-        this.resolveAppPath(appId, targetPath);
-        if (isPathDirectory(this.appPath)) {
+        await this.resolveAppPath(appId, targetPath);
+        if (await isPathDirectory(this.appPath)) {
             this.swellConfig = await swellConfig(this.appPath);
             const localAppId = String(this.swellConfig.get('id'));
             const localAppType = String(this.swellConfig.get('type'));
@@ -431,8 +430,8 @@ export class PushAppCommand extends RemoteAppCommand {
             }
         }
     }
-    getFrontendDeploymentHash() {
-        const localConfigs = this.getLocalAppConfigs();
+    async getFrontendDeploymentHash() {
+        const localConfigs = await this.getLocalAppConfigs();
         let frontendHashes = localConfigs
             .filter((config) => config.filePath?.startsWith(`frontend${path.sep}`))
             .map((config) => config.hash)
@@ -444,13 +443,13 @@ export class PushAppCommand extends RemoteAppCommand {
         }
         return frontendHashes.length > 0 ? hashString(frontendHashes) : undefined;
     }
-    getFrontendProjectType(required = true) {
+    async getFrontendProjectType(required = true) {
         this.frontendPath = path.join(this.appPath, 'frontend');
-        const frontendExists = filePathExists(this.frontendPath);
+        const frontendExists = await filePathExistsAsync(this.frontendPath);
         if (!required && !frontendExists) {
             return null;
         }
-        const projectType = getFrontendProjectType(this.appPath);
+        const projectType = await getFrontendProjectType(this.appPath);
         if (!projectType) {
             // If frontend not required, just return null (don't error)
             if (!required) {
@@ -470,10 +469,10 @@ export class PushAppCommand extends RemoteAppCommand {
         const { appId, targetPath } = args;
         const targetStorefront = flags['storefront-id'];
         const targetApp = await this.getAppToPull(args, false);
-        this.resolveAppPath(appId, targetPath);
+        await this.resolveAppPath(appId, targetPath);
         // Only use default if path exists
         let defaultStorefront;
-        if (isPathDirectory(this.appPath)) {
+        if (await isPathDirectory(this.appPath)) {
             defaultStorefront = localConfig.getDefaultStorefront(this.appPath);
         }
         await this.setStorefrontEnv(flags, defaultStorefront);
@@ -496,7 +495,7 @@ export class PushAppCommand extends RemoteAppCommand {
                 const appId = this.appType === 'theme'
                     ? this.storefront.theme_app_id
                     : this.storefront.app_id;
-                this.resolveAppPath(this.storefront.name, targetPath);
+                await this.resolveAppPath(this.storefront.name, targetPath);
                 this.app = await this.getApp(appId);
             }
             else {
@@ -504,7 +503,7 @@ export class PushAppCommand extends RemoteAppCommand {
                 // However it's a good fallback in case the storefront was deleted
                 // Choosing a theme app will proceed to pull app files
                 this.app = await this.chooseAppToPull();
-                this.resolveAppPath(this.app.name, targetPath);
+                await this.resolveAppPath(this.app.name, targetPath);
             }
         }
         else {
@@ -632,7 +631,7 @@ export class PushAppCommand extends RemoteAppCommand {
                 break;
             }
             default: {
-                config = appConfigFromFile(configFile, configType, this.appPath);
+                config = await appConfigFromFile(configFile, configType, this.appPath);
                 this.watchingChangeQueue.set(configFile, {
                     action: 'push',
                     appConfig: config,
@@ -678,19 +677,21 @@ export class PushAppCommand extends RemoteAppCommand {
     async pushFile(relativePath) {
         const basePath = relativePath.split(path.sep)[0];
         const configType = getConfigTypeFromPath(basePath) || ConfigType.FILE;
-        const config = appConfigFromFile(relativePath, configType, this.appPath);
+        const config = await appConfigFromFile(relativePath, configType, this.appPath);
         await this.pushRemoteFile(config);
     }
     async pushFilePath(relativePath, force) {
         const topDir = relativePath.split(path.sep)[0];
-        const configType = (getConfigTypeFromPath(topDir) || 'file');
-        const configTypeKey = getConfigTypeKeyFromValue(configType) || 'file';
+        const configType = getConfigTypeFromPath(topDir) || ConfigType.FILE;
+        const configTypeKey = getConfigTypeKeyFromValue(configType) || ConfigType.FILE;
         const exAppConfigs = (this.app?.configs || []).filter((config) => config.filePath?.startsWith(`${relativePath}/`));
-        const allFiles = [];
-        const pushFiles = [];
+        const promises = [];
         for (const { configFile } of allConfigFilesInDir(this.appPath, relativePath, configTypeKey)) {
-            const config = appConfigFromFile(configFile, configType, this.appPath);
-            allFiles.push(config);
+            promises.push(appConfigFromFile(configFile, configType, this.appPath));
+        }
+        const allFiles = await Promise.all(promises);
+        const pushFiles = [];
+        for (const config of allFiles) {
             const exConfig = exAppConfigs.find((exConfig) => config.filePath === exConfig.filePath);
             if (!force && exConfig && exConfig.hash === config.hash) {
                 continue;
@@ -705,18 +706,16 @@ export class PushAppCommand extends RemoteAppCommand {
                 // eslint-disable-next-line no-await-in-loop
                 await Promise.all(pushFiles
                     .splice(0, pushConcurrency)
-                    .map(async (appConfig) => {
-                    await this.pushRemoteFile(appConfig);
-                }));
+                    .map((appConfig) => this.pushRemoteFile(appConfig)));
             }
         }
         // Remove any deleted files
         if (filesToRemove.length > 0) {
             while (filesToRemove.length > 0) {
                 // eslint-disable-next-line no-await-in-loop
-                await Promise.all(filesToRemove.splice(0, PUSH_CONCURRENCY).map(async (appConfig) => {
-                    await this.removeRemoteFile(appConfig);
-                }));
+                await Promise.all(filesToRemove
+                    .splice(0, PUSH_CONCURRENCY)
+                    .map((appConfig) => this.removeRemoteFile(appConfig)));
             }
         }
         if (!hasChanges && !force) {
@@ -727,12 +726,12 @@ export class PushAppCommand extends RemoteAppCommand {
             this.log(`${style.success('✔')} Pushed ${style.path(relativePath)} to ${style.appConfigValue(this.app.name)}.`);
         }
     }
-    resolveAppPath(appId, targetPath) {
+    async resolveAppPath(appId, targetPath) {
         const resolvedAppId = appId || '';
         let resolvedPath = targetPath || resolvedAppId;
         // If app_id matches directory, use it as target path
         if (!targetPath &&
-            isPathDirectory(path.resolve(process.cwd(), resolvedAppId))) {
+            (await isPathDirectory(path.resolve(process.cwd(), resolvedAppId)))) {
             resolvedPath = resolvedAppId;
         }
         // Reset app path if appId is provided
@@ -761,7 +760,7 @@ export class PushAppCommand extends RemoteAppCommand {
                 }));
             }
             catch {
-                // noop
+                // TODO: Ignore only some errors
             }
         }
         /* eslint-enable no-await-in-loop */
@@ -844,13 +843,12 @@ export class PushAppCommand extends RemoteAppCommand {
         await this.setWatchingFiles();
         if (syncAll) {
             await this.pushAppConfigs();
-            fs.watch(this.appPath, { recursive: true }, async (_eventType, _filename) => {
+            return fs.watch(this.appPath, { recursive: true }, async (_eventType, _filename) => {
                 await this.pushAppConfigs();
                 await this.setWatchingFiles();
             });
-            return;
         }
-        fs.watch(this.appPath, { recursive: true }, this.watchListener);
+        return fs.watch(this.appPath, { recursive: true }, this.watchListener);
     }
     async wranglerDeployFrontend(_projectType) {
         let deploymentUrl;
@@ -859,7 +857,7 @@ export class PushAppCommand extends RemoteAppCommand {
         let outputBuffer = '';
         this.log(`\nDeploying to Cloudflare...\n`);
         // Get the wrangler deploy command for the detected package manager
-        const pm = detectPackageManager(this.appPath);
+        const pm = await detectPackageManager(this.appPath);
         const deployCommand = transformCommand('npx wrangler deploy', pm);
         try {
             await this.execFrontend(deployCommand, (string) => {

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

@@ -1,3 +1,5 @@
+import { type Ora } from 'ora';
+import type { AppCommandOrientation } from './types/index.js';
 import { AppCommand } from './app-command.js';
 import { App, AppConfig, AppVersion } from './lib/apps/index.js';
 /**
@@ -24,12 +26,12 @@ export declare abstract class RemoteAppCommand extends AppCommand {
     getConfigData(configId: string): Promise<any>;
     protected getCreateUpdateApp(updateApp?: App | null): Promise<App>;
     protected getInstalledApp(): Promise<any>;
-    protected getLocalAppConfigs(): AppConfig[];
+    protected getLocalAppConfigs(): Promise<AppConfig[]>;
     protected getVersion(version?: null | string | undefined): Promise<AppVersion>;
     protected getVersions(version?: null | string | undefined): Promise<AppVersion[]>;
     protected handleRequestErrors(request: () => any, spinnerError?: () => void): Promise<any>;
     init(): Promise<void>;
-    protected installApp(version: string, spinner?: any): Promise<any>;
+    protected installApp(version: string, spinner?: Ora): Promise<any>;
     isConfigDeprecated(config: AppConfig): boolean;
     localFrontendUrl(storeId: string, localId: string): string;
     logOrientation(orientation?: AppCommandOrientation): Promise<void>;
@@ -51,8 +53,8 @@ export declare abstract class RemoteAppCommand extends AppCommand {
     storefrontFrontendUrl(storeId: string, storefront?: any, branchId?: string, preview?: boolean): string;
     protected swellRcPath(): string;
     protected timestampStyled(): string;
-    protected updateInstalledApp(version: string, spinner?: any): Promise<void>;
-    protected updateVersion(version: string, body: any, spinner?: any): Promise<void>;
+    protected updateInstalledApp(version: string, spinner?: Ora): Promise<void>;
+    protected updateVersion(version: string, body: any, spinner?: Ora): Promise<void>;
     /**
      * Reads the .swellrc file and sets up the remote app configuration.
      *