Skip to content
Open
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
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,30 @@ describe('deployConfig', async () => {
expect(got).toMatchObject({theme_extension: {files: {}}})
})

test('passes app configuration context to deployConfig', async () => {
const extensionInstance = await testThemeExtensions()
const originalDeployConfig = extensionInstance.specification.deployConfig
const deployConfig = vi.fn().mockResolvedValue({theme_extension: {files: {}}})
extensionInstance.specification.deployConfig = deployConfig

try {
await extensionInstance.deployConfig({
apiKey: 'apiKey',
appConfiguration: placeholderAppConfiguration,
})

expect(deployConfig).toHaveBeenCalledWith(
extensionInstance.configuration,
extensionInstance.directory,
'apiKey',
undefined,
{appConfiguration: placeholderAppConfiguration},
)
} finally {
extensionInstance.specification.deployConfig = originalDeployConfig
}
})

test('returns transformed config when defined', async () => {
const extensionInstance = await testAppConfigExtensions()

Expand Down
10 changes: 9 additions & 1 deletion packages/app/src/cli/models/extensions/extension-instance.ts
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,15 @@ export class ExtensionInstance<TConfiguration extends BaseConfigType = BaseConfi
apiKey,
appConfiguration,
}: ExtensionDeployConfigOptions): 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,
undefined,
{
appConfiguration,
},
)
const transformedConfig = this.specification.transformLocalToRemote?.(this.configuration, appConfiguration) as
| {[key: string]: unknown}
| undefined
Expand Down
5 changes: 5 additions & 0 deletions packages/app/src/cli/models/extensions/specification.ts
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,10 @@ export interface BuildAsset {
static?: boolean
}

interface ExtensionDeployConfigContext {
appConfiguration: AppConfiguration
}

/**
* Extension specification with all the needed properties and methods to load an extension.
*/
Expand All @@ -80,6 +84,7 @@ export interface ExtensionSpecification<TConfiguration extends BaseConfigType =
directory: string,
apiKey: string,
moduleId?: string,
context?: ExtensionDeployConfigContext,
) => Promise<Record<string, unknown> | undefined>
validate?: (config: TConfiguration, configPath: string, directory: string) => Promise<Result<unknown, string>>
preDeployValidation?: (extension: ExtensionInstance<TConfiguration>) => Promise<void>
Expand Down
Loading