feat(app-config): add app config pull command

Author: anakafeel

packages/app/src/cli/commands/app/config/pull.ts

@@ -0,0 +1,55 @@
+import {appFlags} from '../../../flags.js'
+import {localAppContext} from '../../../services/app-context.js'
+import pull from '../../../services/app/config/pull.js'
+import AppUnlinkedCommand, {AppUnlinkedCommandOutput} from '../../../utilities/app-unlinked-command.js'
+import {renderSuccess} from '@shopify/cli-kit/node/ui'
+import {formatPackageManagerCommand} from '@shopify/cli-kit/node/output'
+import {globalFlags} from '@shopify/cli-kit/node/cli'
+
+export default class ConfigPull extends AppUnlinkedCommand {
+  static summary = 'Refresh an already-linked app configuration without prompts.'
+
+  static descriptionWithMarkdown = `Pulls the latest configuration from the already-linked Shopify app and updates the selected configuration file.
+
+This command reuses the existing linked app and organization and skips all interactive prompts. Use \`--config\` to target a specific configuration file, or omit it to use the default one.`
+
+  static description = this.descriptionWithoutMarkdown()
+
+  static flags = {
+    ...globalFlags,
+    ...appFlags,
+  }
+
+  public async run(): Promise<AppUnlinkedCommandOutput> {
+    const {flags} = await this.parse(ConfigPull)
+
+    // Run the pull service (no prompts)
+    const {configuration, remoteApp} = await pull({
+      directory: flags.path,
+      configName: flags.config,
+    })
+
+    // Get local app context so the return type matches other commands
+    const app = await localAppContext({
+      directory: flags.path,
+      userProvidedConfigName: flags.config,
+    })
+
+    renderSuccess({
+      headline: `Pulled latest configuration for "${configuration.name}"`,
+      body: `Updated ${configuration.path ?? flags.config ?? 'app configuration'} using the already-linked app "${
+        remoteApp.title
+      }".`,
+      nextSteps: [
+        [
+          'To deploy your updated configuration, run',
+          {
+            command: formatPackageManagerCommand(app.packageManager, 'shopify app deploy'),
+          },
+        ],
+      ],
+    })
+
+    return {app}
+  }
+}

packages/app/src/cli/index.ts

@@ -1,6 +1,7 @@
 import Build from './commands/app/build.js'
 import ConfigLink from './commands/app/config/link.js'
 import ConfigUse from './commands/app/config/use.js'
+import ConfigPull from './commands/app/config/pull.js'
 import DemoWatcher from './commands/app/demo/watcher.js'
 import Deploy from './commands/app/deploy.js'
 import Dev from './commands/app/dev.js'
@@ -47,6 +48,7 @@ export const commands: {[key: string]: typeof AppLinkedCommand | typeof AppUnlin
   'app:release': Release,
   'app:config:link': ConfigLink,
   'app:config:use': ConfigUse,
+  'app:config:pull': ConfigPull,
   'app:env:pull': EnvPull,
   'app:env:show': EnvShow,
   'app:execute': Execute,

packages/app/src/cli/services/app/config/pull.ts

@@ -0,0 +1,96 @@
+// packages/app/src/cli/services/app/config/pull.ts
+
+import {LinkOptions, loadLocalAppOptions, overwriteLocalConfigFileWithRemoteAppConfiguration} from './link.js'
+import {CurrentAppConfiguration, isCurrentAppSchema} from '../../../models/app/app.js'
+import {OrganizationApp} from '../../../models/organization.js'
+import {loadApp, AppConfigurationFileName, getAppConfigurationFileName} from '../../../models/app/loader.js'
+import {configurationFileNames} from '../../../constants.js'
+import {appFromIdentifiers} from '../../context.js'
+import {fetchSpecifications} from '../../generate/fetch-extension-specifications.js'
+import {RemoteAwareExtensionSpecification} from '../../../models/extensions/specification.js'
+import {Flag} from '../../../utilities/developer-platform-client.js'
+import {loadLocalExtensionsSpecifications} from '../../../models/extensions/load-specifications.js'
+import {AbortError} from '@shopify/cli-kit/node/error'
+import {basename} from '@shopify/cli-kit/node/path'
+
+export interface PullOptions {
+  directory: string
+  configName?: string
+}
+
+export interface PullOutput {
+  configuration: CurrentAppConfiguration
+  remoteApp: OrganizationApp
+}
+
+/**
+ * Refresh an already-linked app configuration without prompting for org/app.
+ */
+export default async function pull(options: PullOptions): Promise<PullOutput> {
+  const {directory, configName} = options
+
+  // 1) Load the current config (default, or the one passed with --config)
+  const app = await loadApp({
+    specifications: await loadLocalExtensionsSpecifications(),
+    directory,
+    mode: 'report',
+    userProvidedConfigName: configName,
+    remoteFlags: undefined,
+  })
+
+  const configuration = app.configuration
+
+  if (!isCurrentAppSchema(configuration) || !configuration.client_id) {
+    throw new AbortError(
+      'The selected configuration is not linked to a remote app.',
+      'Run `shopify app config link` first to link this configuration to a Shopify app.',
+    )
+  }
+
+  // 2) Resolve remote app from the client_id in the config
+  const remoteApp = await appFromIdentifiers({apiKey: configuration.client_id})
+  if (!remoteApp) {
+    throw new AbortError(
+      'Could not find the remote app linked in this configuration.',
+      'Try linking the configuration again with `shopify app config link`.',
+    )
+  }
+
+  const developerPlatformClient = remoteApp.developerPlatformClient
+
+  // 3) Fetch remote specs/flags for that app
+  const specifications: RemoteAwareExtensionSpecification[] = await fetchSpecifications({
+    developerPlatformClient,
+    app: remoteApp,
+  })
+  const flags: Flag[] = remoteApp.flags
+
+  // 4) Reuse helpers from link.ts to build and write the file
+  const linkOptions: LinkOptions = {
+    directory,
+    configName,
+    developerPlatformClient,
+    apiKey: configuration.client_id,
+  }
+
+  const localAppOptions = await loadLocalAppOptions(linkOptions, specifications, flags, remoteApp.apiKey)
+
+  // Decide which config file to overwrite:
+  // - if config has a path, reuse that file
+  // - otherwise, fallback to --config or default app config name
+  const configFileName: AppConfigurationFileName =
+    (configuration.path && (basename(configuration.path) as AppConfigurationFileName)) ||
+    getAppConfigurationFileName(configName ?? configurationFileNames.app)
+
+  const mergedConfiguration = await overwriteLocalConfigFileWithRemoteAppConfiguration({
+    remoteApp,
+    developerPlatformClient,
+    specifications,
+    flags,
+    configFileName,
+    appDirectory: localAppOptions.appDirectory ?? directory,
+    localAppOptions,
+  })
+
+  return {configuration: mergedConfiguration, remoteApp}
+}