@swell/cli 2.9.31 → 2.9.33

package/dist/lib/inspect/extensions.d.ts

@@ -24,7 +24,7 @@ export interface ManifestEntry {
 }
 /** CLI-resolved type. Diverges from raw manifest `type` for payment (card vs alt). */
 export type ExtensionType = 'card' | 'alt' | 'shipping' | 'tax';
-export type ExtensionStatus = 'not deployed' | 'not activated' | 'app id mismatch' | 'id mismatch' | 'not selected' | 'gateway missing' | 'not enabled' | 'no handler' | 'handler mismatch' | 'activated';
+export type ExtensionStatus = 'not deployed' | 'settings unavailable' | 'not activated' | 'app id mismatch' | 'id mismatch' | 'not selected' | 'gateway missing' | 'not enabled' | 'no handler' | 'handler mismatch' | 'activated';
 export type ActionOwner = 'dev' | 'merchant' | null;
 export interface FunctionRecord {
     id?: string;
@@ -163,8 +163,6 @@ export declare function formatExtensionKey(slug: string, extId: string): string;
  * resolves to `card` even with no explicit `method`.
  */
 export declare function resolveExtensionType(entry: Pick<ManifestEntry, 'type' | 'method' | 'id'>): ExtensionType;
-/** Apply the platform's `if(method, method, id)` formula. */
-export declare function paymentMethodIdFor(entry: Pick<ManifestEntry, 'method' | 'id'>): string;
 /** Shipping records use `app_<appId>_<extId>` as both the row id and the carrier id. */
 export declare function shippingBindId(appId: string, extId: string): string;
 /** Card-gateway records use the same id form as shipping rows. */
@@ -229,12 +227,15 @@ export interface BuildDetailInput {
     payments?: PaymentSettings | null;
     shipments?: ShippingSettings | null;
     taxes?: TaxSettingsRecord | null;
+    /** Why each settings record could not be read, if it could not. */
+    unavailableSettings?: UnavailableSettings;
     /** Functions in the same app whose top-level `extension` matches this extId. */
     functions: FunctionRecord[];
     /** Components in the same app whose `values.extension` matches this extId. */
     components: ComponentRecord[];
     localDiff?: LocalDiff | null;
 }
+export type UnavailableSettings = Partial<Record<'payments' | 'shipments' | 'taxes', string>>;
 export interface BuildOrphanInput {
     appId: string;
     appSlug: string;

package/dist/lib/inspect/extensions.js

@@ -42,10 +42,6 @@ export function resolveExtensionType(entry) {
     const method = entry.method ?? entry.id;
     return method === 'card' ? 'card' : 'alt';
 }
-/** Apply the platform's `if(method, method, id)` formula. */
-export function paymentMethodIdFor(entry) {
-    return entry.method ?? entry.id;
-}
 /** Shipping records use `app_<appId>_<extId>` as both the row id and the carrier id. */
 export function shippingBindId(appId, extId) {
     return `app_${appId}_${extId}`;
@@ -200,7 +196,9 @@ function findShippingCarrier(shipments, carrierId) {
  * gate on `enabled`) is intentional.
  */
 function deriveAltDispatch(ctx) {
-    const methodId = paymentMethodIdFor(ctx.manifest);
+    // The dashboard keys an extension's method by the extension's id, whatever
+    // its `method`, and checkout dispatches on that id
+    const methodId = ctx.extId;
     const expectedGatewayId = gatewayBindId(ctx.appId, ctx.extId);
     const method = findPaymentMethod(ctx.payments, methodId);
     const gateway = findPaymentGateway(ctx.payments, expectedGatewayId);
@@ -254,8 +252,11 @@ function deriveCardDispatch(ctx) {
     const expectedGatewayId = gatewayBindId(ctx.appId, ctx.extId);
     const cardMethod = findPaymentMethod(ctx.payments, 'card');
     const gateway = findPaymentGateway(ctx.payments, expectedGatewayId);
+    // Charges and refunds go to the app and extension the card method names
     const methodChecks = {
         gateway: cardMethod?.gateway === expectedGatewayId,
+        extension_app_id: cardMethod?.extension_app_id === ctx.appId,
+        extension_config_id: cardMethod?.extension_config_id === ctx.extId,
     };
     const gatewayChecks = {
         extension_app_id: gateway?.extension_app_id === ctx.appId,
@@ -285,6 +286,12 @@ function deriveCardDispatch(ctx) {
     if (cardMethod?.gateway !== expectedGatewayId) {
         return { status: 'not activated', native_bindings };
     }
+    if (cardMethod.extension_app_id !== ctx.appId) {
+        return { status: 'app id mismatch', native_bindings };
+    }
+    if (cardMethod.extension_config_id !== ctx.extId) {
+        return { status: 'id mismatch', native_bindings };
+    }
     return { status: 'activated', native_bindings };
 }
 /**
@@ -401,6 +408,26 @@ export function buildExtensionDetail(input) {
         throw new Error('buildExtensionDetail: missing manifest for a deployed extension');
     }
     const type = resolveExtensionType(input.manifest);
+    // Without the settings the activation cannot be told
+    const settingsRecord = type === 'shipping' ? 'shipments' : type === 'tax' ? 'taxes' : 'payments';
+    const unavailable = input.unavailableSettings?.[settingsRecord];
+    if (unavailable) {
+        return {
+            status: 'settings unavailable',
+            action_owner: 'dev',
+            action: `Could not read /settings/${settingsRecord}: ${unavailable}`,
+            type,
+            manifest: input.manifest,
+            native_bindings: [],
+            bound: {
+                functions: input.functions.map((f) => liftBoundFunction(f)),
+                components: input.components.map((c) => liftBoundComponent(c)),
+            },
+            required_events: requiredEventsFor(type),
+            missing_required_events: missingRequiredEvents(type, input.functions),
+            local_diff: input.localDiff ?? null,
+        };
+    }
     const dispatch = deriveDispatch(type, {
         appId: input.appId,
         extId: input.extId,
@@ -487,6 +514,10 @@ function describeAction(status, ctx) {
         case 'not deployed': {
             return { action: 'swell app push', action_owner: 'dev' };
         }
+        // buildExtensionDetail names the settings it could not read
+        case 'settings unavailable': {
+            return { action: null, action_owner: 'dev' };
+        }
         case 'not activated': {
             return {
                 action: `Open Settings → ${section} → ${label} → Save`,

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

@@ -30,7 +30,13 @@ async function request(originalRequest, _env, context) {
             ...(error.body ?? { error: error.message }),
             retry: error.retry === false ? false : undefined,
         };
-        response = new SwellResponse(errorBody, { status: error.status || 500 });
+        const retryAfter = Number(error.retryAfter);
+        response = new SwellResponse(errorBody, {
+            status: error.status || 500,
+            ...(retryAfter > 0
+                ? { headers: { 'Retry-After': String(Math.ceil(retryAfter)) } }
+                : {}),
+        });
     }
     return SwellResponse._respond(req, response, context);
 }
@@ -118,9 +124,9 @@ class SwellRequest {
         this.swell = new SwellAPI(this, context);
         // URL of the original request
         this.url;
-        // Request body text. On a route called through the storefront gateway with
-        // a JSON body, this is the exact text the caller sent, so verify HMAC/webhook
-        // signatures against it. Other bodies arrive re-serialized as JSON.
+        // Request body text. On a route called through the storefront gateway, this
+        // is the exact body the caller sent, so verify HMAC/webhook signatures
+        // against it. Form-encoded bodies arrive re-serialized as JSON.
         this.rawBody = '';
         // Parsed JSON body as object, or raw text string when body isn't JSON.
         this.body = {};
@@ -447,6 +453,7 @@ class SwellError extends Error {
         this.body = body;
         this.code = options.code || body?.error?.code;
         this.retry = options.retry;
+        this.retryAfter = options.retryAfter;
     }
     get isRetryable() {
         return RETRYABLE_CODES.has(this.code);
@@ -501,7 +508,8 @@ class SwellResponse extends Response {
     }
     static async _respond(req, response, context) {
         let finalResponse = response;
-        const isHook = Boolean(req.data?.$event?.hook);
+        // Only the platform marks a hook's call: a route's data comes from its caller
+        const isHook = Boolean(req.headers.get('Swell-Event-Hook'));
         if (finalResponse instanceof Response &&
             !(finalResponse instanceof SwellResponse)) {
             // Non-hook responses pass through unchanged so the handler's body,

package/dist/lib/swell-workflow-request.d.ts

@@ -0,0 +1,34 @@
+export function runtimeEnvironmentId(runtime: any): any;
+export function buildWorkflowRequest(invocation: any, proxy: any): {
+    id: any;
+    appId: any;
+    environmentId: any;
+    store: {
+        id: any;
+    };
+    app: {
+        admin_url: any;
+        frontend_url: any;
+    };
+    data: any;
+    workflow: {
+        workflow_id: any;
+        workflow_name: any;
+        workflow_instance_id: any;
+        trigger: any;
+        request_id: any;
+    };
+    isLocalDev: boolean;
+    swell: {
+        get: (path: any, data: any) => any;
+        post: (path: any, data: any) => any;
+        put: (path: any, data: any) => any;
+        delete: (path: any, data: any) => any;
+        settings: () => any;
+    };
+    appValues(idOrValues: any, values: any): {
+        $app: {
+            [x: number]: any;
+        };
+    };
+};

package/dist/lib/swell-workflow-request.js

@@ -0,0 +1,58 @@
+// The request a workflow's run(req, step) gets, built from the invocation the
+// platform starts the run with. Every workflow bundle includes this module.
+// 'test' in the test environment, null in live
+export function runtimeEnvironmentId(runtime) {
+    return runtime.environment_id || null;
+}
+export function buildWorkflowRequest(invocation, proxy) {
+    const { data, runtime } = invocation;
+    const appId = runtime.app_slug || runtime.app_id;
+    return {
+        id: runtime.request_id,
+        appId,
+        environmentId: runtimeEnvironmentId(runtime),
+        store: {
+            id: runtime.store_id,
+        },
+        app: {
+            admin_url: runtime.app_admin_url,
+            frontend_url: runtime.app_frontend_url,
+        },
+        data,
+        workflow: {
+            workflow_id: runtime.workflow_id,
+            workflow_name: runtime.workflow_name,
+            workflow_instance_id: runtime.workflow_instance_id,
+            trigger: runtime.trigger,
+            request_id: runtime.request_id,
+        },
+        isLocalDev: false,
+        swell: {
+            get: (path, data) => proxy.api('get', path, data),
+            post: (path, data) => proxy.api('post', path, data),
+            put: (path, data) => proxy.api('put', path, data),
+            delete: (path, data) => proxy.api('delete', path, data),
+            settings: () => proxy.settings(),
+        },
+        appValues(idOrValues, values) {
+            const targetAppId = typeof idOrValues === 'string' ? idOrValues : appId;
+            const appValues = typeof idOrValues === 'string' ? values : idOrValues;
+            if (!targetAppId) {
+                throw new Error('appValues: missing app id (req.appId is empty)');
+            }
+            if (!isOrdinaryObject(appValues)) {
+                throw new Error('appValues: values must be a plain object (arrays, class instances, null, and primitives are not allowed)');
+            }
+            return {
+                $app: {
+                    [targetAppId]: appValues,
+                },
+            };
+        },
+    };
+}
+function isOrdinaryObject(val) {
+    return (typeof val === 'object' &&
+        val !== null &&
+        Object.getPrototypeOf(val) === Object.prototype);
+}

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

@@ -21,13 +21,14 @@ export declare abstract class PushAppCommand extends RemoteAppCommand {
     watchingIgnoreFilter: GlobbyFilterFunction | null;
     watchingTimer: NodeJS.Timeout | null;
     watchListener: (eventType: fs.WatchEventType, filename: null | string) => Promise<void>;
+    protected pushesSwellJson(file?: string): boolean;
     protected showFrontendMigrationError(): never;
     buildFrontend(projectType?: FrontendProjectType): Promise<void>;
     chooseAppToPull(query?: any): Promise<App>;
     createAppStorefront(hasOtherStorefronts?: boolean, nonInteractive?: boolean): Promise<any>;
     deployAppFrontend(force?: boolean, log?: boolean): Promise<void>;
     deployFrontend(projectType: FrontendProjectType): Promise<string>;
-    ensureAppExists(file?: string, shouldCreate?: boolean, force?: boolean): Promise<boolean>;
+    ensureAppExists(file?: string, shouldCreate?: boolean): Promise<boolean>;
     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>;

package/dist/push-app-command.js

@@ -7,10 +7,12 @@ import Stream from 'node:stream';
 import ora from 'ora';
 import { default as swellConfig } from './lib/app-config.js';
 import { componentsToRebuild } from './lib/apps/components.js';
+import { extensionManifestWarnings } from './lib/apps/extension-manifest.js';
 import { buildFrontendPackage, getManagedFrontendFramework, } from './lib/apps/frontend-package.js';
 import { warnFrontendRouteCollisions } from './lib/apps/frontend-routes.js';
 import { ConfigType, getFrontendProjectValidValues, allConfigFilesInDir, CUSTOM_FRAMEWORK_SLUG, appConfigFromFile, filePathExistsAsync, findAppConfig, getConfigTypeFromPath, getConfigTypeKeyFromValue, getFrontendProjectType, getProjectCommands, globAllFilesByPath, hashFile, hashString, isPathDirectory, toPosixPath, } from './lib/apps/index.js';
-import { getGlobIgnorePathsChecker } from './lib/apps/paths.js';
+import { warnListingSources } from './lib/apps/listing.js';
+import { getGlobIgnorePathsChecker, globFrontendEnvFiles, isCredentialFile, } from './lib/apps/paths.js';
 import { slugFromApp } from './lib/apps/slug.js';
 import { getLocalInputs } from './lib/bundle.js';
 import { default as localConfig } from './lib/config.js';
@@ -119,6 +121,10 @@ export class PushAppCommand extends RemoteAppCommand {
             }
         }
     };
+    // The platform applies the listing in swell.json when the file is pushed
+    pushesSwellJson(file) {
+        return !file;
+    }
     showFrontendMigrationError() {
         return this.error(style.funcWarn(`⚠️  Your frontend directory exists but appears to use an older structure.\n` +
             `Swell CLI v2.1.0+ requires a Workers-based frontend with package.json.\n\n` +
@@ -330,7 +336,7 @@ export class PushAppCommand extends RemoteAppCommand {
             this.error(`Error deploying frontend: ${error.message}`);
         }
     }
-    async ensureAppExists(file, shouldCreate = true, force = false) {
+    async ensureAppExists(file, shouldCreate = true) {
         const klass = this.ctor;
         const currentStore = localConfig.getDefaultStore();
         await this.ensureLoggedIn();
@@ -356,15 +362,21 @@ export class PushAppCommand extends RemoteAppCommand {
             this.app = app;
             return true;
         }
+        if (this.pushesSwellJson(file)) {
+            warnListingSources(this.appPath, this.swellConfig.store, (message) => this.warn(message));
+            for (const message of extensionManifestWarnings(this.swellConfig.get('extensions'))) {
+                this.warn(message);
+            }
+        }
         // If app exists but owned by another client, create a new instance
         if (app?.client_id && app.client_id !== currentStore) {
             // Create a new app
-            this.app = await this.getCreateUpdateApp(undefined, force);
+            this.app = await this.getCreateUpdateApp();
             if (!this.app) {
                 return false;
             }
         }
-        else if (file) {
+        else if (file && !this.pushesSwellJson(file)) {
             // Targeting a file: don't update the app from swell.json, but keep the
             // remote one to diff config hashes and the frontend deployment hash
             if (app) {
@@ -372,8 +384,9 @@ export class PushAppCommand extends RemoteAppCommand {
             }
         }
         else {
-            // Update existing app if not targeting a file
-            this.app = await this.getCreateUpdateApp(app, force);
+            // The app takes its details from swell.json before any upload, so that
+            // details the app refuses fail the push first
+            this.app = await this.getCreateUpdateApp(app);
         }
         return true;
     }
@@ -493,8 +506,12 @@ export class PushAppCommand extends RemoteAppCommand {
         if (frontendHashes.length > 0) {
             const packageHash = localConfigs.find((config) => config.filePath === 'package.json')?.hash;
             frontendHashes += `|${packageHash}`;
-            // Shared code the worker imports from outside frontend/, e.g. functions/lib
-            for (const input of await this.getFrontendSharedInputs()) {
+            // Shared code the worker imports from outside frontend/, e.g.
+            // functions/lib, and the .env files its build reads
+            for (const input of [
+                ...(await this.getFrontendSharedInputs()),
+                ...(await globFrontendEnvFiles(this.appPath)),
+            ]) {
                 frontendHashes += `|${hashFile(path.join(this.appPath, input), undefined, input)}`;
             }
         }
@@ -787,6 +804,11 @@ export class PushAppCommand extends RemoteAppCommand {
     }
     async pushFile(relativePath) {
         const relativePathPosix = toPosixPath(relativePath);
+        if (isCredentialFile(relativePathPosix)) {
+            ora().fail(`${relativePathPosix} is never pushed: .env and .dev.vars files can hold credentials`);
+            this.failedFiles.push(relativePathPosix);
+            return;
+        }
         const basePath = relativePathPosix.split('/')[0];
         const configType = getConfigTypeFromPath(basePath) || ConfigType.FILE;
         const config = await appConfigFromFile(relativePathPosix, configType, this.appPath);
@@ -817,7 +839,7 @@ export class PushAppCommand extends RemoteAppCommand {
             const pushConcurrency = configTypeKey === 'ASSET' ? 1 : PUSH_CONCURRENCY;
             while (pushFiles.length > 0) {
                 // eslint-disable-next-line no-await-in-loop
-                await Promise.all(pushFiles
+                await this.runTogether(pushFiles
                     .splice(0, pushConcurrency)
                     .map((appConfig) => this.pushRemoteFile(appConfig)));
             }
@@ -826,7 +848,7 @@ export class PushAppCommand extends RemoteAppCommand {
         if (filesToRemove.length > 0) {
             while (filesToRemove.length > 0) {
                 // eslint-disable-next-line no-await-in-loop
-                await Promise.all(filesToRemove
+                await this.runTogether(filesToRemove
                     .splice(0, PUSH_CONCURRENCY)
                     .map((appConfig) => this.removeRemoteFile(appConfig)));
             }
@@ -862,18 +884,17 @@ export class PushAppCommand extends RemoteAppCommand {
         // Process queue in batches with concurrency control
         /* eslint-disable no-await-in-loop */
         while (queue.length > 0) {
-            try {
-                await Promise.all(queue
-                    .splice(0, PUSH_CONCURRENCY)
-                    .map(async ({ action, appConfig }) => {
-                    const result = await (action === 'remove'
-                        ? this.removeRemoteFile(appConfig, this.logWatchChanges)
-                        : this.pushRemoteFile(appConfig, this.logWatchChanges));
-                    this.onWatchChange?.(appConfig, action, result);
-                }));
-            }
-            catch {
-                // TODO: Ignore only some errors
+            const results = await Promise.allSettled(queue.splice(0, PUSH_CONCURRENCY).map(async ({ action, appConfig }) => {
+                const result = await (action === 'remove'
+                    ? this.removeRemoteFile(appConfig, this.logWatchChanges)
+                    : this.pushRemoteFile(appConfig, this.logWatchChanges));
+                this.onWatchChange?.(appConfig, action, result);
+            }));
+            // A failed change ends no watch: its reasons show, and watching goes on
+            for (const result of results) {
+                if (result.status === 'rejected') {
+                    this.logError(result.reason?.message ?? String(result.reason));
+                }
             }
         }
         /* eslint-enable no-await-in-loop */

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

@@ -26,7 +26,7 @@ export declare abstract class RemoteAppCommand extends AppCommand {
     protected getApp(id?: string): Promise<App>;
     protected getAppWithConfig(id?: string): Promise<App>;
     getConfigData(configId: string): Promise<any>;
-    protected getCreateUpdateApp(updateApp?: App | null, force?: boolean): Promise<App>;
+    protected getCreateUpdateApp(updateApp?: App | null): Promise<App>;
     protected getInstalledApp(): Promise<any>;
     /**
      * Anything on the target store already using the services named by
@@ -88,9 +88,9 @@ export declare abstract class RemoteAppCommand extends AppCommand {
         removed: string[];
     }>;
     protected pushRemoteFile(config: AppConfig, log?: boolean): Promise<any>;
+    protected runTogether(tasks: Promise<unknown>[]): Promise<void>;
     protected removeLocalFile(config: AppConfig, log?: boolean): Promise<any>;
     protected removeRemoteFile(config: AppConfig, log?: boolean): Promise<any>;
-    protected showErrors(errors: any, spinnerError?: () => void): void;
     storefrontFrontendUrl(storeId: string, storefront?: any, branchId?: string, preview?: boolean): string;
     protected swellRcPath(): string;
     protected timestampStyled(): string;