Rename extension-to-toml → extension-config-builder

[ryancbahan]

Summary

Renames files and functions to reflect that extension builders now return config objects, not TOML strings:

• extension-to-toml.ts → extension-config-builder.ts (all 5 extension types)
• buildTomlObject() → buildExtensionConfig() across all callsites

Test plan

• All affected tests pass

[ryancbahan]

• Add declaredKeys property to extension specifications #6980
• Remove dead defaultAppConfigReverseTransform and add round-trip fidelity tests #6953
• Extract mergeAllWebhooks transform from Zod schema into breakdown-extensions #6952
• Extract scopes transforms from Zod schemas into accessor functions #6951
• Extract extension_directories transforms from Zod schema #6950
• Extract path from AppConfiguration into App.configPath #6949
• Add config pipeline snapshot tests #6947
• Rename extension-to-toml → extension-config-builder #6945 👈 (View in Graphite)
• Migrate all TOML I/O callsites to TomlFile #6944
• Introduce TomlFile abstraction for TOML file I/O #6943
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[github-actions]

Coverage report

St.❔	Category	Percentage	Covered / Total
🟡	Statements	78.86%	14504/18391
🟡	Branches	73.18%	7198/9836
🟡	Functions	79.06%	3697/4676
🟡	Lines	79.19%	13704/17305

Test suite run success

3802 tests passing in 1453 suites.

Report generated by 🧪jest coverage report action from eefb2a9

[github-actions]

We detected some changes at packages/*/src and there are no updates in the .changeset.
If the changes are user-facing, run pnpm changeset add to track your changes and include them in the next release CHANGELOG.

Caution

DO NOT create changesets for features which you do not wish to be included in the public changelog of the next CLI release.

[binks-code-reviewer]

🤖 Code Review · #projects-dev-ai for questions
React with 👍/👎 or reply — all feedback helps improve the agent.

✅ Complete - No issues

📋 History

✅ No issues

[dmerand]

This looks good! AI and I had the same nits about naming/conventions.

---

Review assisted by pair-review

[dmerand]

⭐ Praise: The renaming from buildTomlObject to buildExtensionConfig has been applied consistently across function definitions, interface properties, and all callsites throughout the codebase. The new import aliases (buildPaymentsConfig, buildFlowConfig, etc.) are more concise and clearly convey that these functions build configuration objects. This is solid refactoring work.

[dmerand]

🎨 Code Style: Multiple test descriptions in this file state 'correctly builds a toml object' (lines 6, 48, 88, 128). The function being tested now builds and returns a configuration object, not TOML. The test descriptions should be updated to say 'correctly builds a config object' or 'correctly builds an extension config' to align with the rename from buildTomlObject to buildExtensionConfig.

Suggestion: Update all test descriptions from 'correctly builds a toml object for...' to 'correctly builds a config object for...' to maintain consistency with the refactoring's stated goal.

[ryancbahan]

mirroring existing behavior -- happy to change as separate pr, but I'm trying to reduce surface area given this is a large change. the syntax here is pre-existing pattern

[dmerand]

🎨 Code Style: The comment states 'convert it to toml' but this function returns a configuration object. The TOML conversion is handled by the caller via TomlFile, not by this function. The comment should align with the refactored function naming.

Suggestion:

Suggested change

	* Given a flow extension config file, convert it to toml
	* Given a flow extension config file, builds the extension configuration object

[dmerand]

🎨 Code Style: Multiple test descriptions in this file state 'correctly builds a toml object' (lines 57, 153, 200, 255, 309, 367, 420). The function being tested returns a configuration object, not TOML. These descriptions should be updated to align with the renamed function and the PR's stated purpose.

Suggestion: Update all test descriptions from 'correctly builds a toml object for...' to 'correctly builds a config object for...' to maintain terminology consistency throughout the test suite.

[dmerand]

(Ref Line 107) 💡 Improvement: The internal helper function is still named buildPaymentsToml despite the exported function being renamed to buildExtensionConfig. For consistency with the PR's goal of reflecting that builders return config objects (not TOML), this helper should also be renamed. This will require updating all 6 callsites (lines 65, 71, 77, 83, 89, 95).

Suggestion:

Suggested change

	function buildPaymentsConfig<T extends BasePaymentsAppExtensionDeployConfigType>(

[github-actions]

Differences in type declarations

We detected differences in the type declarations generated by Typescript for this branch compared to the baseline ('main' branch). Please, review them to ensure they are backward-compatible. Here are some important things to keep in mind:

• Some seemingly private modules might be re-exported through public modules.
• If the branch is behind main you might see odd diffs, rebase main into this branch.

New type declarations

packages/cli-kit/dist/public/node/toml/codec.d.ts

import { JsonMap } from '../../../private/common/json.js';
export type JsonMapType = JsonMap;
/**
 * Given a TOML string, it returns a JSON object.
 *
 * @param input - TOML string.
 * @returns JSON object.
 */
export declare function decodeToml(input: string): JsonMapType;
/**
 * Given a JSON object, it returns a TOML string.
 *
 * @param content - JSON object.
 * @returns TOML string.
 */
export declare function encodeToml(content: JsonMap | object): string;

packages/cli-kit/dist/public/node/toml/index.d.ts

export type { JsonMapType } from './codec.js';

packages/cli-kit/dist/public/node/toml/toml-file.d.ts

import { JsonMapType } from './codec.js';
/**
 * Thrown when a TOML file cannot be parsed. Includes the file path for context.
 */
export declare class TomlParseError extends Error {
    readonly path: string;
    constructor(path: string, cause: Error);
}
/**
 * General-purpose TOML file abstraction.
 *
 * Provides a unified interface for reading, patching, removing keys from, and replacing
 * the content of TOML files on disk.
 *
 * - `read` populates content from disk
 * - `patch` does surgical WASM-based edits (preserves comments and formatting)
 * - `remove` deletes a key by dotted path (preserves comments and formatting)
 * - `replace` does a full re-serialization (comments and formatting are NOT preserved).
 * - `transformRaw` applies a function to the raw TOML string on disk.
 */
export declare class TomlFile {
    /**
     * Read and parse a TOML file from disk. Throws if the file doesn't exist or contains invalid TOML.
     * Parse errors are wrapped in {@link TomlParseError} with the file path for context.
     *
     * @param path - Absolute path to the TOML file.
     * @returns A TomlFile instance with parsed content.
     */
    static read(path: string): Promise<TomlFile>;
    readonly path: string;
    content: JsonMapType;
    constructor(path: string, content: JsonMapType);
    /**
     * Surgically patch values in the TOML file, preserving comments and formatting.
     *
     * Accepts a nested object whose leaf values are set in the TOML. Intermediate tables are
     * created automatically. Setting a leaf to `undefined` removes it (use `remove()` for a
     * clearer API when deleting keys).
     *
     * @example
     * ```ts
     * await file.patch({build: {dev_store_url: 'my-store.myshopify.com'}})
     * await file.patch({application_url: 'https://example.com', auth: {redirect_urls: ['...']}})
     * ```
     */
    patch(changes: {
        [key: string]: unknown;
    }): Promise<void>;
    /**
     * Remove a key from the TOML file by dotted path, preserving comments and formatting.
     *
     * @param keyPath - Dotted key path to remove (e.g. 'build.include_config_on_deploy').
     * @example
     * ```ts
     * await file.remove('build.include_config_on_deploy')
     * ```
     */
    remove(keyPath: string): Promise<void>;
    /**
     * Replace the entire file content. The file is fully re-serialized — comments and formatting
     * are NOT preserved.
     *
     * @param content - The new content to write.
     * @example
     * ```ts
     * await file.replace({client_id: 'abc', name: 'My App'})
     * ```
     */
    replace(content: JsonMapType): Promise<void>;
    /**
     * Transform the raw TOML string on disk. Reads the file, applies the transform function
     * to the raw text, writes back, and re-parses to keep `content` in sync.
     *
     * Use this for text-level operations that can't be expressed as structured edits —
     * e.g. Injecting comments or positional insertion of keys in arrays-of-tables.
     * Subsequent `patch()` calls will preserve any comments added this way.
     *
     * @param transform - A function that receives the raw TOML string and returns the modified string.
     * @example
     * ```ts
     * await file.transformRaw((raw) => `# Header comment\n${raw}`)
     * ```
     */
    transformRaw(transform: (raw: string) => string): Promise<void>;
    private decode;
}

Existing type declarations

We found no diffs with existing type declarations