Add intents registration for admin_link

Author: vividviolet

packages/app/src/cli/models/app/app.test-data.ts

@@ -1048,6 +1048,23 @@ const testRemoteSpecifications: RemoteSpecification[] = [
         '{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","additionalProperties":false,"properties":{"pattern":{"type":"string"},"name":{"type":"string"}},"required":["pattern"]}',
     },
   },
+  {
+    name: 'Admin Link',
+    externalName: 'Admin Link',
+    identifier: 'admin_link',
+    externalIdentifier: 'admin_link_external',
+    gated: false,
+    experience: 'extension',
+    options: {
+      managementExperience: 'cli',
+      registrationLimit: 10,
+      uidIsClientProvided: true,
+    },
+    validationSchema: {
+      jsonSchema:
+        '{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","additionalProperties":true,"properties":{"name":{"type":"string"},"type":{"type":"string"},"handle":{"type":"string"},"targeting":{"type":"array","items":{"type":"object","properties":{"target":{"type":"string"},"tools":{"type":"string"},"instructions":{"type":"string"},"intents":{"type":"array"},"build_manifest":{"type":"object"}},"additionalProperties":true}}},"required":["name","targeting"]}',
+    },
+  },
 ]
 
 const productSubscriptionUIExtensionTemplate: ExtensionTemplate = {

packages/app/src/cli/models/extensions/extension-instance.ts

@@ -366,6 +366,8 @@ export class ExtensionInstance<TConfiguration extends BaseConfigType = BaseConfi
           this.specification.buildConfig.filePatterns,
           this.specification.buildConfig.ignoredFilePatterns,
         )
+      case 'copy_static_assets':
+        return this.copyStaticAssets()
       case 'none':
         break
     }

packages/app/src/cli/models/extensions/specification.ts

@@ -1,6 +1,7 @@
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
 import {ZodSchemaType, BaseConfigType, BaseSchema} from './schemas.js'
 import {ExtensionInstance} from './extension-instance.js'
+import {adminLinkOverride} from './specifications/remote-overrides/admin_link.js'
 import {blocks} from '../../constants.js'
 
 import {Flag} from '../../utilities/developer-platform-client.js'
@@ -56,7 +57,7 @@ export interface BuildAsset {
 }
 
 type BuildConfig =
-  | {mode: 'ui' | 'theme' | 'function' | 'tax_calculation' | 'none'}
+  | {mode: 'ui' | 'theme' | 'function' | 'tax_calculation' | 'none' | 'copy_static_assets'}
   | {mode: 'copy_files'; filePatterns: string[]; ignoredFilePatterns?: string[]}
 /**
  * Extension specification with all the needed properties and methods to load an extension.
@@ -167,6 +168,11 @@ interface CreateExtensionSpecType<TConfiguration extends BaseConfigType = BaseCo
   schema?: ZodSchemaType<TConfiguration>
 }
 
+export type CreateContractOverrideExtensionSpecType<TConfiguration extends BaseConfigType = BaseConfigType> = Partial<
+  CreateExtensionSpecType<TConfiguration>
+> & {
+  transform?: (config: TConfiguration) => TConfiguration
+}
 /**
  * Create a new ui extension spec.
  *
@@ -269,21 +275,25 @@ export function createConfigExtensionSpecification<TConfiguration extends BaseCo
 }
 
 export function createContractBasedModuleSpecification<TConfiguration extends BaseConfigType = BaseConfigType>(
-  spec: Pick<CreateExtensionSpecType<TConfiguration>, 'identifier' | 'appModuleFeatures' | 'buildConfig'>,
+  spec: Pick<CreateExtensionSpecType<TConfiguration>, 'identifier' | 'appModuleFeatures'> &
+    CreateContractOverrideExtensionSpecType<TConfiguration>,
 ) {
+  const defaultDeployConfig = async (config: TConfiguration, directory: string) => {
+    let parsedConfig = configWithoutFirstClassFields(config)
+    if (spec.appModuleFeatures().includes('localization')) {
+      const localization = await loadLocalesConfig(directory, spec.identifier)
+      parsedConfig = {...parsedConfig, localization}
+    }
+    return parsedConfig
+  }
+
+  const schema = spec.transform ? zod.any({}).transform(spec.transform) : zod.any({})
+
   return createExtensionSpecification({
-    identifier: spec.identifier,
-    schema: zod.any({}) as unknown as ZodSchemaType<TConfiguration>,
-    appModuleFeatures: spec.appModuleFeatures,
+    ...spec,
+    schema,
     buildConfig: spec.buildConfig ?? {mode: 'none'},
-    deployConfig: async (config, directory) => {
-      let parsedConfig = configWithoutFirstClassFields(config)
-      if (spec.appModuleFeatures().includes('localization')) {
-        const localization = await loadLocalesConfig(directory, spec.identifier)
-        parsedConfig = {...parsedConfig, localization}
-      }
-      return parsedConfig
-    },
+    deployConfig: spec.deployConfig ?? defaultDeployConfig,
   })
 }
 
@@ -401,3 +411,37 @@ export function configWithoutFirstClassFields(config: JsonMapType): JsonMapType
   const {type, handle, uid, path, extensions, ...configWithoutFirstClassFields} = config
   return configWithoutFirstClassFields
 }
+
+/**
+ * Specification overrides for remote specifications that need custom behavior.
+ * These overrides are applied when creating contract-based module specifications
+ * for extensions that are defined remotely but need local customization.
+ *
+ * Can include any method from ExtensionSpecification plus a schema.
+ * All properties are optional - only provide what you want to override.
+ */
+export type SpecificationOverride<TConfiguration extends BaseConfigType = BaseConfigType> = Partial<
+  ExtensionSpecification<TConfiguration>
+> & {
+  schema?: ZodSchemaType<TConfiguration>
+}
+
+/**
+ * Registry of specification overrides by identifier.
+ * Add custom behavior for remote specifications here.
+ */
+export const SPECIFICATION_OVERRIDES: {[key: string]: SpecificationOverride} = {
+  admin_link: adminLinkOverride as unknown as SpecificationOverride,
+}
+
+/**
+ * Get the override configuration for a specific specification identifier.
+ *
+ * @param identifier - The specification identifier
+ * @returns The override configuration if it exists, undefined otherwise
+ */
+export function getSpecificationOverride<TConfiguration extends BaseConfigType = BaseConfigType>(
+  identifier: string,
+): SpecificationOverride<TConfiguration> | undefined {
+  return SPECIFICATION_OVERRIDES[identifier] as SpecificationOverride<TConfiguration> | undefined
+}

packages/app/src/cli/models/extensions/specifications/build-manifest-schema.ts

@@ -1,5 +1,5 @@
 import {AssetIdentifier, BuildAsset} from '../specification.js'
-import {fileExists, copyFile} from '@shopify/cli-kit/node/fs'
+import {fileExists, copyFile, mkdir} from '@shopify/cli-kit/node/fs'
 import {joinPath, dirname, basename} from '@shopify/cli-kit/node/path'
 import {outputContent, outputToken} from '@shopify/cli-kit/node/output'
 import {err, ok, Result} from '@shopify/cli-kit/node/result'
@@ -14,7 +14,7 @@ export {ok, err}
  */
 export interface TargetingWithBuildManifest {
   target: string
-  build_manifest?: BuildManifest
+  build_manifest: BuildManifest
 }
 
 /**
@@ -142,6 +142,10 @@ async function copyAsset(
   if (isStatic) {
     const sourceFile = joinPath(directory, module)
     const outputFilePath = joinPath(dirname(outputPath), filepath)
+
+    // Ensure the directory exists before copying
+    await mkdir(dirname(outputFilePath))
+
     await copyFile(sourceFile, outputFilePath).catch((error) => {
       throw new Error(`Failed to copy static asset ${module} to ${outputFilePath}: ${error.message}`)
     })
@@ -217,9 +221,7 @@ export async function validateBuildManifestAssets(
  * @param extensionPoint - Extension point with build manifest
  * @returns Extension point with updated asset paths
  */
-export function addDistPathToAssets<T extends TargetingWithBuildManifest & {build_manifest: BuildManifest}>(
-  extP: T,
-): T {
+export function addDistPathToAssets<T extends TargetingWithBuildManifest>(extP: T): T {
   return {
     ...extP,
     build_manifest: {

packages/app/src/cli/models/extensions/specifications/remote-overrides/admin_link.ts

@@ -0,0 +1,44 @@
+import {
+  transformStaticAssets,
+  copyStaticBuildManifestAssets,
+  validateBuildManifestAssets,
+  addDistPathToAssets,
+  TargetingWithBuildManifest,
+} from '../build-manifest-schema.js'
+import {configWithoutFirstClassFields, CreateContractOverrideExtensionSpecType} from '../../specification.js'
+import {loadLocalesConfig} from '../../../../utilities/extensions/locales-configuration.js'
+import {JsonMapType} from '@shopify/cli-kit/node/toml'
+
+interface AdminLinkPartialConfig {
+  targeting: TargetingWithBuildManifest[]
+  handle?: string
+}
+
+export const adminLinkOverride: CreateContractOverrideExtensionSpecType<AdminLinkPartialConfig> = {
+  buildConfig: {mode: 'copy_static_assets'},
+  transform: (config: AdminLinkPartialConfig) => {
+    return {
+      ...config,
+      targeting: config.targeting.map((targeting) => {
+        return {
+          ...targeting,
+          ...transformStaticAssets(targeting, config.handle ?? 'admin-link'),
+        }
+      }),
+    }
+  },
+  validate: async (config: AdminLinkPartialConfig, _path: string, directory: string) =>
+    validateBuildManifestAssets(directory, config.targeting),
+  copyStaticAssets: async (config: AdminLinkPartialConfig, directory: string, outputPath: string) =>
+    copyStaticBuildManifestAssets(config.targeting, directory, outputPath),
+  deployConfig: async (config: AdminLinkPartialConfig, directory: string) => {
+    const parsedConfig = configWithoutFirstClassFields(config as unknown as JsonMapType)
+    const localization = await loadLocalesConfig(directory, 'admin_link')
+
+    return {
+      ...parsedConfig,
+      localization,
+      targeting: config.targeting.map(addDistPathToAssets),
+    }
+  },
+}

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

@@ -12,6 +12,7 @@ import {
   addDistPathToAssets,
   transformStaticAssets,
   BuildManifest,
+  TargetingWithBuildManifest,
 } from './build-manifest-schema.js'
 import {Asset, AssetIdentifier, ExtensionFeature, createExtensionSpecification} from '../specification.js'
 import {NewExtensionPointSchemaType, NewExtensionPointsSchema, BaseSchema, MetafieldSchema} from '../schemas.js'
@@ -304,7 +305,7 @@ const uiExtensionSpec = createExtensionSpecification({
 
 async function validateUIExtensionPointConfig(
   directory: string,
-  extensionPoints: (NewExtensionPointSchemaType & {build_manifest?: BuildManifest})[],
+  extensionPoints: (NewExtensionPointSchemaType & TargetingWithBuildManifest)[],
   configPath: string,
 ): Promise<Result<unknown, string>> {
   const errors: string[] = []