Support assets for admin links app intents

Author: vividviolet

packages/app/src/cli/models/extensions/load-specifications.ts

@@ -28,6 +28,7 @@ import webPixelSpec from './specifications/web_pixel_extension.js'
 import editorExtensionCollectionSpecification from './specifications/editor_extension_collection.js'
 import channelSpecificationSpec from './specifications/channel.js'
 import adminSpecificationSpec from './specifications/admin.js'
+import adminLinkSpec from './specifications/admin_link.js'
 
 const SORTED_CONFIGURATION_SPEC_IDENTIFIERS = [
   BrandingSpecIdentifier,
@@ -80,6 +81,7 @@ function loadSpecifications() {
     webPixelSpec,
     editorExtensionCollectionSpecification,
     channelSpecificationSpec,
+    adminLinkSpec,
   ]
 
   return [...configModuleSpecs, ...moduleSpecs] as ExtensionSpecification[]

packages/app/src/cli/models/extensions/specifications/admin_link.test.ts

@@ -0,0 +1,114 @@
+import * as loadLocales from '../../../utilities/extensions/locales-configuration.js'
+import {ExtensionInstance} from '../extension-instance.js'
+import {loadLocalExtensionsSpecifications} from '../load-specifications.js'
+import {placeholderAppConfiguration} from '../../app/app.test-data.js'
+import {inTemporaryDirectory} from '@shopify/cli-kit/node/fs'
+import {joinPath} from '@shopify/cli-kit/node/path'
+import {describe, expect, test, vi} from 'vitest'
+
+describe('admin_link', async () => {
+  async function getTestAdminLink(directory: string, configuration: Record<string, unknown> = {}) {
+    const configurationPath = joinPath(directory, 'shopify.extension.toml')
+    const allSpecs = await loadLocalExtensionsSpecifications()
+    const specification = allSpecs.find((spec) => spec.identifier === 'admin_link')!
+    const parsed = specification.parseConfigurationObject(configuration)
+    if (parsed.state !== 'ok') {
+      throw new Error("Couldn't parse configuration")
+    }
+
+    return new ExtensionInstance({
+      configuration: parsed.data,
+      directory,
+      specification,
+      configurationPath,
+      entryPath: '',
+    })
+  }
+
+  test('has the correct identifier', async () => {
+    await inTemporaryDirectory(async (tmpDir) => {
+      const extension = await getTestAdminLink(tmpDir)
+      expect(extension.specification.identifier).toBe('admin_link')
+    })
+  })
+
+  test('has localization in appModuleFeatures', async () => {
+    await inTemporaryDirectory(async (tmpDir) => {
+      const extension = await getTestAdminLink(tmpDir)
+      expect(extension.specification.appModuleFeatures()).toContain('localization')
+    })
+  })
+
+  test('has include_assets client step with generateManifest enabled', async () => {
+    await inTemporaryDirectory(async (tmpDir) => {
+      const extension = await getTestAdminLink(tmpDir)
+      const clientSteps = extension.specification.clientSteps!
+      expect(clientSteps).toHaveLength(1)
+      expect(clientSteps[0]!.lifecycle).toBe('deploy')
+
+      const steps = clientSteps[0]!.steps
+      expect(steps).toHaveLength(1)
+      expect(steps[0]).toMatchObject({
+        id: 'copy-admin-link-assets',
+        name: 'Copy Admin Link Assets',
+        type: 'include_assets',
+        config: {
+          generateManifest: true,
+          inclusions: [
+            {type: 'configKey', key: 'targeting[].tools'},
+            {type: 'configKey', key: 'targeting[].instructions'},
+            {type: 'configKey', key: 'targeting[].intents[].schema'},
+          ],
+        },
+      })
+    })
+  })
+
+  describe('deployConfig()', () => {
+    test('includes localization in deploy config', async () => {
+      await inTemporaryDirectory(async (tmpDir) => {
+        const localization = {
+          default_locale: 'en',
+          translations: {title: 'Hello!'},
+        }
+        vi.spyOn(loadLocales, 'loadLocalesConfig').mockResolvedValue(localization)
+
+        const extension = await getTestAdminLink(tmpDir, {
+          name: 'My Admin Link',
+          targeting: [{url: 'https://example.com'}],
+        })
+
+        const deployConfig = await extension.deployConfig({
+          apiKey: 'apiKey',
+          appConfiguration: placeholderAppConfiguration,
+        })
+
+        expect(deployConfig).toMatchObject({localization})
+        expect(loadLocales.loadLocalesConfig).toHaveBeenCalledWith(tmpDir, 'admin_link')
+      })
+    })
+
+    test('strips first-class fields from deploy config', async () => {
+      await inTemporaryDirectory(async (tmpDir) => {
+        vi.spyOn(loadLocales, 'loadLocalesConfig').mockResolvedValue({})
+
+        const extension = await getTestAdminLink(tmpDir, {
+          type: 'admin_link',
+          handle: 'my-link',
+          name: 'My Admin Link',
+          targeting: [{url: 'https://example.com'}],
+        })
+
+        const deployConfig = await extension.deployConfig({
+          apiKey: 'apiKey',
+          appConfiguration: placeholderAppConfiguration,
+        })
+
+        expect(deployConfig).not.toHaveProperty('type')
+        expect(deployConfig).not.toHaveProperty('handle')
+        expect(deployConfig).toHaveProperty('name', 'My Admin Link')
+        expect(deployConfig).toHaveProperty('targeting')
+      })
+    })
+  })
+})

packages/app/src/cli/models/extensions/specifications/admin_link.ts

@@ -0,0 +1,47 @@
+import {createContractBasedModuleSpecification} from '../specification.js'
+
+const adminLinkSpec = createContractBasedModuleSpecification({
+  identifier: 'admin_link',
+  buildConfig: {
+    mode: 'copy_files',
+    filePatterns: [],
+  },
+  clientSteps: [
+    {
+      lifecycle: 'deploy',
+      steps: [
+        {
+          id: 'include-admin-link-assets',
+          name: 'Include Admin Link Assets',
+          type: 'include_assets',
+          config: {
+            generatesAssetsManifest: true,
+            inclusions: [
+              {
+                type: 'configKey',
+                anchor: 'extensions[].targeting[]',
+                groupBy: 'target',
+                key: 'tools',
+              },
+              {
+                type: 'configKey',
+                anchor: 'extensions[].targeting[]',
+                groupBy: 'target',
+                key: 'instructions',
+              },
+              {
+                type: 'configKey',
+                anchor: 'extensions[].targeting[]',
+                groupBy: 'target',
+                key: 'intents[].schema',
+              },
+            ],
+          },
+        },
+      ],
+    },
+  ],
+  appModuleFeatures: () => ['localization'],
+})
+
+export default adminLinkSpec