extension

type App struct {
	// contains filtered or unexported fields
}

type AssetBuildConfig struct {
	EnableAssetCaching           bool
	CleanupNodeModules           bool
	DisableAdminBuild            bool
	DisableStorefrontBuild       bool
	ShopwareRoot                 string
	ShopwareVersion              *version.Constraints
	Browserslist                 string
	SkipExtensionsWithBuildFiles bool
	NPMForceInstall              bool
	ForceExtensionBuild          []string
	ForceAdminBuild              bool
	KeepNodeModules              []string
	Executor                     executor.Executor
}

type BuildModifierConfig struct {
	AppBackendUrl    string
	AppBackendSecret string
	Version          string
}

type ChecksumJSON struct {
	Algorithm        string            `json:"algorithm"`
	Hashes           map[string]string `json:"hashes"`
	Version          string            `json:"version"`
	ExtensionVersion string            `json:"extensionVersion"`
}

type Config struct {
	// Controls date-based compatibility behavior, formatted as YYYY-MM-DD.
	CompatibilityDate string `yaml:"compatibility_date,omitempty" jsonschema:"format=date"`
	// Store is the store configuration of the extension.
	Store ConfigStore `yaml:"store,omitempty"`
	// Build is the build configuration of the extension.
	Build ConfigBuild `yaml:"build,omitempty"`
	// Changelog is the changelog configuration of the extension.
	Changelog changelog.Config `yaml:"changelog,omitempty"`
	// Validation is the validation configuration of the extension.
	Validation ConfigValidation `yaml:"validation,omitempty"`
	// contains filtered or unexported fields
}

type ConfigBuild struct {
	// ExtraBundles can be used to declare additional bundles to be considered for building
	ExtraBundles []ConfigExtraBundle `yaml:"extraBundles,omitempty"`
	// Override the shopware version constraint for building, can be used to specify the version of the shopware to use for building
	ShopwareVersionConstraint string `yaml:"shopwareVersionConstraint,omitempty"`
	// Configuration for zipping
	Zip ConfigBuildZip `yaml:"zip"`
}

type ConfigBuildZip struct {
	// Configuration for composer
	Composer ConfigBuildZipComposer `yaml:"composer,omitempty"`
	// Configuration for assets
	Assets ConfigBuildZipAssets `yaml:"assets,omitempty"`
	// Configuration for packing
	Pack ConfigBuildZipPack `yaml:"pack,omitempty"`

	Checksum ConfigBuildZipChecksum `yaml:"checksum,omitempty"`
}

type ConfigBuildZipAssets struct {
	// When enabled, the shopware-cli build the assets
	Enabled bool `yaml:"enabled"`
	// When enabled, compiled assets are cached and restored across builds, keyed by the source-file content hash
	EnableAssetCaching bool `yaml:"enable_asset_caching"`
	// Commands to run before the assets build
	BeforeHooks []string `yaml:"before_hooks,omitempty"`
	// Commands to run after the assets build
	AfterHooks []string `yaml:"after_hooks,omitempty"`
	// When enabled, builtin esbuild will be used for the admin assets
	EnableESBuildForAdmin bool `yaml:"enable_es_build_for_admin"`
	// When enabled, builtin esbuild will be used for the storefront assets
	EnableESBuildForStorefront bool `yaml:"enable_es_build_for_storefront"`
	// When disabled, builtin sass support will be disabled
	DisableSass bool `yaml:"disable_sass"`
	// When enabled, npm will install only production dependencies
	NpmStrict bool `yaml:"npm_strict"`
	// Additional paths to include in asset caching
	AdditionalCaches []ConfigBuildZipAssetsAdditionalCache `yaml:"additional_caches,omitempty"`
}

type ConfigBuildZipAssetsAdditionalCache struct {
	// The output path to cache, relative to extension root
	Path string `yaml:"path"`
	// Source paths to hash for the cache key, relative to extension root
	SourcePaths []string `yaml:"source_paths"`
}

type ConfigBuildZipChecksum struct {
	// Following files will be excluded from the checksum calculation
	Ignore []string `yaml:"ignore,omitempty"`
}

type ConfigBuildZipComposer struct {
	// When enabled, a vendor folder will be created in the zip build
	Enabled bool `yaml:"enabled"`
	// Commands to run before the composer install
	BeforeHooks []string `yaml:"before_hooks,omitempty"`
	// Commands to run after the composer install
	AfterHooks []string `yaml:"after_hooks,omitempty"`
	// Composer packages to be excluded from the zip build
	ExcludedPackages []string `yaml:"excluded_packages,omitempty"`
}

type ConfigBuildZipPack struct {
	// Excludes can be used to exclude files from the zip build
	Excludes ConfigBuildZipPackExcludes `yaml:"excludes,omitempty"`
	// Commands to run before the pack
	BeforeHooks []string `yaml:"before_hooks,omitempty"`
}

type ConfigBuildZipPackExcludes struct {
	// Paths to exclude from the zip build
	Paths []string `yaml:"paths,omitempty"`
}

type ConfigExtraBundle struct {
	// Path to the bundle, relative from the extension root (src folder)
	Path string `yaml:"path"`
	// Name of the bundle, if empty the folder name of path will be used
	Name string `yaml:"name"`
}

type ConfigStore struct {
	// Specifies the visibility in stores.
	Availabilities *[]string `yaml:"availabilities" jsonschema:"enum=German,enum=International"`
	// Specifies the default locale.
	DefaultLocale *string `yaml:"default_locale" jsonschema:"enum=de_DE,enum=en_GB"`
	// Specifies the languages the extension is translated.
	Localizations *[]string `` /* 437-byte string literal not displayed */
	// Specifies the type of the extension.
	Type *string `yaml:"type" jsonschema:"enum=extension,enum=theme"`
	// Specifies the Path to the icon (256x256 px) for store.
	Icon *string `yaml:"icon"`
	// Specifies whether the extension should automatically be set compatible with Shopware bugfix versions.
	AutomaticBugfixVersionCompatibility *bool `yaml:"automatic_bugfix_version_compatibility"`
	// Specifies the meta title of the extension in store.
	MetaTitle ConfigTranslated[string] `yaml:"meta_title" jsonschema:"maxLength=50"`
	// Specifies the meta description of the extension in store.
	MetaDescription ConfigTranslated[string] `yaml:"meta_description" jsonschema:"maxLength=185"`
	// Specifies the description of the extension in store.
	Description ConfigTranslated[string] `yaml:"description"`
	// Installation manual of the extension in store.
	InstallationManual ConfigTranslated[string] `yaml:"installation_manual"`
	// Specifies the tags of the extension.
	Tags ConfigTranslated[[]string] `yaml:"tags,omitempty"`
	// Specifies the links of YouTube-Videos to show or describe the extension.
	Videos ConfigTranslated[[]string] `yaml:"videos,omitempty"`
	// Specifies the highlights of the extension.
	Highlights ConfigTranslated[[]string] `yaml:"highlights,omitempty"`
	// Specifies the features of the extension.
	Features ConfigTranslated[[]string] `yaml:"features"`
	// Specifies Frequently Asked Questions for the extension.
	Faq ConfigTranslated[[]ConfigStoreFaq] `yaml:"faq"`
	// Specifies images for the extension in the store.
	Images *[]ConfigStoreImage `yaml:"images,omitempty"`
	// Specifies the directory where the images are located.
	ImageDirectory *string `yaml:"image_directory,omitempty"`
	// Specifies the demo shops of the extension in the store.
	DemoShops *[]ConfigStoreDemoShop `yaml:"demo_shops,omitempty"`
}

type ConfigStoreDemoShop struct {
	// Specifies the type of the demo shop.
	Type string `yaml:"type" jsonschema:"enum=frontend,enum=backend"`
	// Specifies the URL to the demo shop.
	Link string `yaml:"link"`
	// Specifies the language of the demo shop.
	Localization string `yaml:"localization" jsonschema:"enum=de_DE,enum=en_GB"`
	// Specifies the login name to access the demo shop.
	LoginName string `yaml:"login_name,omitempty"`
	// Specifies the login password to access the demo shop.
	LoginPassword string `yaml:"login_password,omitempty"`
}

type ConfigStoreFaq struct {
	Question string `yaml:"question"`
	Answer   string `yaml:"answer"`
	Position int    `yaml:"position"`
}

type ConfigStoreImage struct {
	// File path to image relative from root of the extension
	File string `yaml:"file"`
	// Specifies whether the image is active in the language.
	Activate ConfigStoreImageActivate `yaml:"activate"`
	// Specifies whether the image is a preview in the language.
	Preview ConfigStoreImagePreview `yaml:"preview"`
	// Position of the image in the store gallery. Images are sorted ascending; the lowest value is shown first.
	Position int `yaml:"position"`
	// Deprecated: use Position instead.
	Priority int `yaml:"priority,omitempty" jsonschema_extras:"deprecated=true"`
}

type ConfigStoreImageActivate struct {
	German  bool `yaml:"de"`
	English bool `yaml:"en"`
}

type ConfigStoreImagePreview struct {
	German  bool `yaml:"de"`
	English bool `yaml:"en"`
}

type ConfigTranslated[T any] struct {
	German  *T `yaml:"de,omitempty"`
	English *T `yaml:"en,omitempty"`
}

type ConfigValidation struct {
	// Ignore items from the validation.
	Ignore          ConfigValidationList `yaml:"ignore,omitempty"`
	StoreCompliance bool                 `yaml:"store_compliance,omitempty"`
	// PhpVersion overrides the PHP version used for linting (e.g. "8.4").
	// When set, this takes precedence over the version derived from composer.json or the static Shopware-to-PHP mapping.
	PhpVersion string `yaml:"php_version,omitempty"`
}

type ConfigValidationList []validation.ToolConfigIgnore

type ConsoleCommandFunc func(ctx context.Context, args ...string) *exec.Cmd

type Extension interface {
	GetName() (string, error)
	GetComposerName() (string, error)
	// Deprecated: use the list variation instead
	GetResourcesDir() string
	GetResourcesDirs() []string

	GetIconPath() string

	// GetRootDir Returns the root folder where the code is located plugin -> src, app ->
	GetRootDir() string
	GetSourceDirs() []string
	GetVersion() (*version.Version, error)
	GetLicense() (string, error)
	GetShopwareVersionConstraint() (*version.Constraints, error)
	GetType() string
	GetPath() string
	GetChangelog() (*ExtensionChangelog, error)
	GetMetaData() *ExtensionMetadata
	UpdateMetaData(*ExtensionMetadata) error
	GetExtensionConfig() *Config
	Validate(context.Context, validation.Check)
}

type ExtensionAssetConfig map[string]*ExtensionAssetConfigEntry

type ExtensionAssetConfigAdmin struct {
	Path          string  `json:"path"`
	EntryFilePath *string `json:"entryFilePath"`
	Webpack       *string `json:"webpack"`
}

type ExtensionAssetConfigEntry struct {
	BasePath                   string                         `json:"basePath"`
	Views                      []string                       `json:"views"`
	TechnicalName              string                         `json:"technicalName"`
	Administration             ExtensionAssetConfigAdmin      `json:"administration"`
	Storefront                 ExtensionAssetConfigStorefront `json:"storefront"`
	EnableESBuildForAdmin      bool
	EnableESBuildForStorefront bool
	DisableSass                bool
	NpmStrict                  bool
	AdditionalCaches           []ConfigBuildZipAssetsAdditionalCache
	// contains filtered or unexported fields
}

type ExtensionAssetConfigStorefront struct {
	Path          string   `json:"path"`
	EntryFilePath *string  `json:"entryFilePath"`
	Webpack       *string  `json:"webpack"`
	StyleFiles    []string `json:"styleFiles"`
}

type ExtensionChangelog struct {
	German     string `json:"german"`
	English    string `json:"english"`
	Changelogs map[string]string
}

type ExtensionMetadata struct {
	Name        string
	Label       ExtensionTranslated
	Description ExtensionTranslated
}

type ExtensionTranslated struct {
	German  string `json:"german"`
	English string `json:"english"`
}

type Manifest struct {
	Meta  Meta   `xml:"meta"`
	Setup *Setup `xml:"setup,omitempty"`
}

type Meta struct {
	Name          string             `xml:"name"`
	Label         TranslatableString `xml:"label"`
	Description   TranslatableString `xml:"description,omitempty"`
	Author        string             `xml:"author,omitempty"`
	Copyright     string             `xml:"copyright,omitempty"`
	Version       string             `xml:"version"`
	Icon          string             `xml:"icon,omitempty"`
	License       string             `xml:"license"`
	Compatibility string             `xml:"compatibility,omitempty"`
}

type PlatformComposerJson struct {
	Name        string   `json:"name"`
	Keywords    []string `json:"keywords"`
	Description string   `json:"description"`
	Version     string   `json:"version"`
	Type        string   `json:"type"`
	License     string   `json:"license"`
	Authors     []struct {
		Name     string `json:"name"`
		Homepage string `json:"homepage"`
	} `json:"authors"`
	Require  map[string]string         `json:"require"`
	Extra    platformComposerJsonExtra `json:"extra"`
	Autoload struct {
		Psr0 map[string]string `json:"psr-0"`
		Psr4 map[string]string `json:"psr-4"`
	} `json:"autoload"`
	Suggest map[string]string `json:"suggest"`
}

type PlatformPlugin struct {
	Composer PlatformComposerJson
	// contains filtered or unexported fields
}

type Setup struct {
	RegistrationUrl string `xml:"registrationUrl"`
	Secret          string `xml:"secret,omitempty"`
}

type ShopwareBundle struct {
	Composer shopwareBundleComposerJson
	// contains filtered or unexported fields
}

type StorefrontWatcherOptions struct {
	ThemeID   string
	DomainURL string
	// ProxyHostname, when set, routes the deprecated webpack hot-proxy watcher
	// through the shared proxy at this hostname (e.g.
	// "storefront-watch.my-shop.shopware.local") instead of exposing fixed
	// local ports, so multiple shops can watch in parallel. Empty keeps the
	// classic local-port behavior.
	ProxyHostname string
}

type TranslatableString []struct {
	Value string `xml:",chardata"`
	Lang  string `xml:"lang,attr,omitempty"`
}