Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add admin link extensino remote cotract specification #4591

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions packages/app/src/cli/models/extensions/extension-instance.ts
Original file line number Diff line number Diff line change
Expand Up @@ -206,14 +206,20 @@ export class ExtensionInstance<TConfiguration extends BaseConfigType = BaseConfi
developerPlatformClient,
}: ExtensionDeployConfigOptions): Promise<{[key: string]: unknown} | undefined> {
const {moduleId} = await uploadWasmBlob(this.localIdentifier, this.outputPath, developerPlatformClient)
return this.specification.deployConfig?.(this.configuration, this.directory, apiKey, moduleId)
return this.specification.deployConfig?.(this.configuration, this.directory, apiKey, this.features, moduleId)
}

async commonDeployConfig(
apiKey: string,
appConfiguration: AppConfigurationWithoutPath,
): Promise<{[key: string]: unknown} | undefined> {
const deployConfig = await this.specification.deployConfig?.(this.configuration, this.directory, apiKey, undefined)
const deployConfig = await this.specification.deployConfig?.(
this.configuration,
this.directory,
apiKey,
this.features,
undefined,
)
const transformedConfig = this.specification.transformLocalToRemote?.(this.configuration, appConfiguration) as
| {[key: string]: unknown}
| undefined
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ import uiExtensionSpec from './specifications/ui_extension.js'
import webPixelSpec from './specifications/web_pixel_extension.js'
import editorExtensionCollectionSpecification from './specifications/editor_extension_collection.js'
import customDataSpec, {CustomDataSpecIdentifier} from './specifications/custom_data.js'
import adminLinkSpec from './specifications/admin_link_extension.js'

const SORTED_CONFIGURATION_SPEC_IDENTIFIERS = [
BrandingSpecIdentifier,
Expand Down Expand Up @@ -78,6 +79,7 @@ function loadSpecifications() {
uiExtensionSpec,
webPixelSpec,
editorExtensionCollectionSpecification,
adminLinkSpec,
] as ExtensionSpecification[]

return [...configModuleSpecs, ...moduleSpecs]
Expand Down
14 changes: 12 additions & 2 deletions packages/app/src/cli/models/extensions/specification.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {Result} from '@shopify/cli-kit/node/result'
import {capitalize} from '@shopify/cli-kit/common/string'
import {ParseConfigurationResult, zod} from '@shopify/cli-kit/node/schema'
import {getPathValue, setPathValue} from '@shopify/cli-kit/common/object'
import {loadLocalesConfig} from '../../utilities/extensions/locales-configuration.js'

export type ExtensionFeature =
| 'ui_preview'
Expand All @@ -17,6 +18,7 @@ export type ExtensionFeature =
| 'cart_url'
| 'esbuild'
| 'single_js_entry_path'
| 'localization'

export interface TransformationConfig {
[key: string]: string
Expand Down Expand Up @@ -50,6 +52,7 @@ export interface ExtensionSpecification<TConfiguration extends BaseConfigType =
config: TConfiguration,
directory: string,
apiKey: string,
modeuleFeatures: ExtensionFeature[],
moduleId?: string,
) => Promise<{[key: string]: unknown} | undefined>
validate?: (config: TConfiguration, configPath: string, directory: string) => Promise<Result<unknown, string>>
Expand Down Expand Up @@ -271,10 +274,17 @@ export function createContractBasedModuleSpecification<TConfiguration extends Ba
identifier,
schema: zod.any({}) as unknown as ZodSchemaType<TConfiguration>,
appModuleFeatures: () => appModuleFeatures ?? [],
deployConfig: async (config, _) => {
deployConfig: async (config, directory) => {
// These are loaded automatically for all modules, but are considered "first class" and not part of extension contracts
// If a module needs them, they can access them from the manifest.
const {type, handle, uid, ...configWithoutFirstClassFields} = config
let {type, handle, uid, ...configWithoutFirstClassFields} = config
//Check for 'localization' feature and load the locales configuration
if (appModuleFeatures?.includes('localization')) {
configWithoutFirstClassFields = {
...configWithoutFirstClassFields,
localization: await loadLocalesConfig(directory, config.type),
}
}
return configWithoutFirstClassFields
},
})
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import {createContractBasedModuleSpecification} from '../specification.js'

export const AdminLinkSpecIdentifier = 'admin_link'

const AdminLinkSpec = createContractBasedModuleSpecification(AdminLinkSpecIdentifier, ['localization'])

export default AdminLinkSpec
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ const functionSpec = createExtensionSpecification({
],
schema: FunctionExtensionSchema,
appModuleFeatures: (_) => ['function'],
deployConfig: async (config, directory, apiKey, moduleId) => {
deployConfig: async (config, directory, apiKey, _, moduleId) => {
let inputQuery: string | undefined
const inputQueryPath = joinPath(directory, 'input.graphql')
if (await fileExists(inputQueryPath)) {
Expand Down
Loading