shop

type CompatibilityError struct {
	Message string
	// contains filtered or unexported fields
}

type ComposerJsonOptions struct {
	Version          string
	DependingVersion string
	RC               bool
	UseElasticsearch bool
	UseAMQP          bool
	NoAudit          bool
	DeploymentMethod string
}

type ComposerScript struct {
	Name        string
	Description string
	Aliases     []string
}

type Config struct {
	AdditionalConfigs []string `yaml:"include,omitempty"`
	// Shop URL. Prefer environments.local.url or another named environment; the top-level url key is used only when environments.local is absent.
	URL string `yaml:"url,omitempty" jsonschema:"deprecated=true"`
	// Controls date-based compatibility behavior, formatted as YYYY-MM-DD.
	CompatibilityDate string `yaml:"compatibility_date,omitempty" jsonschema:"format=date"`
	// PHP version (e.g. "8.3") used for local PHP and Composer commands of this project. Written by "project create" for non-Docker projects. The matching PHP is looked up on the machine running the command, so the value stays portable across machines; it takes precedence over the php found in PATH, while the PHP_BINARY environment variable overrides it.
	PHPVersion string       `yaml:"php_version,omitempty"`
	Build      *ConfigBuild `yaml:"build,omitempty"`
	// Admin API credentials. Prefer environments.local.admin_api or another named environment; the top-level admin_api key is used only when environments.local is absent.
	AdminApi         *ConfigAdminApi   `yaml:"admin_api,omitempty" jsonschema:"deprecated=true"`
	ConfigDump       *ConfigDump       `yaml:"dump,omitempty"`
	ConfigDeployment *ConfigDeployment `yaml:"deployment,omitempty"`
	Validation       *ConfigValidation `yaml:"validation,omitempty"`
	ImageProxy       *ConfigImageProxy `yaml:"image_proxy,omitempty"`
	// Docker dev environment configuration
	Docker *ConfigDocker `yaml:"docker,omitempty"`
	// Named shop targets. Empty -e selects environments.local. Store url and admin_api here rather than at the top level.
	Environments map[string]*EnvironmentConfig `yaml:"environments,omitempty"`
	// When enabled, composer scripts will be disabled during CI builds
	DisableComposerScripts bool `yaml:"disable_composer_scripts,omitempty"`
	// When enabled, composer install will be skipped during CI builds
	DisableComposerInstall bool `yaml:"disable_composer_install,omitempty"`
	// contains filtered or unexported fields
}

type ConfigAdminApi struct {
	// Client ID of integration
	ClientId string `yaml:"client_id,omitempty"`
	// Client Secret of integration
	ClientSecret string `yaml:"client_secret,omitempty"`
	// Username of admin user
	Username string `yaml:"username,omitempty"`
	// Password of admin user
	Password string `yaml:"password,omitempty"`
	// Disable SSL certificate check
	DisableSSLCheck bool `yaml:"disable_ssl_check,omitempty"`
}

type ConfigBuild struct {
	// When enabled, the assets will not be copied to the public folder
	DisableAssetCopy bool `yaml:"disable_asset_copy,omitempty"`
	// When enabled, the assets of extensions will be removed from the extension public folder. (Requires Shopware 6.5.2.0)
	RemoveExtensionAssets bool `yaml:"remove_extension_assets,omitempty"`
	// When enabled, the extensions source code will be keep in the final build
	KeepExtensionSource bool `yaml:"keep_extension_source,omitempty"`
	// When enabled, the source maps will not be removed from the final build
	KeepSourceMaps bool `yaml:"keep_source_maps,omitempty"`
	// Paths to delete for the final build
	CleanupPaths []string `yaml:"cleanup_paths,omitempty"`
	// Browserslist configuration for the Storefront build
	Browserslist string `yaml:"browserslist,omitempty"`
	// Extensions to exclude from the build
	ExcludeExtensions []string `yaml:"exclude_extensions,omitempty"`
	// When enabled, the storefront build will be skipped
	DisableStorefrontBuild bool `yaml:"disable_storefront_build,omitempty"`
	// When enabled, the checksum.json generation for extensions will be skipped
	DisableChecksums bool `yaml:"disable_checksums,omitempty"`
	// When enabled, an already existing checksum.json in an extension will be kept instead of being overwritten
	KeepExistingChecksums bool `yaml:"keep_existing_checksums,omitempty"`
	// Extensions to force build for, even if they have compiled files
	ForceExtensionBuild []ConfigBuildExtension `yaml:"force_extension_build,omitempty"`
	// When enabled, the shopware admin will be built
	ForceAdminBuild bool `yaml:"force_admin_build,omitempty"`
	// Keep following node_modules in the final build
	KeepNodeModules []string `yaml:"keep_node_modules,omitempty"`
	// MJML email template compilation configuration
	MJML *ConfigBuildMJML `yaml:"mjml,omitempty"`
	// When enabled, built assets are cached and restored on subsequent builds when sources haven't changed
	AssetCaching bool `yaml:"asset_caching,omitempty"`
	// Hooks to run at specific points during CI builds
	Hooks *ConfigBuildHooks `yaml:"hooks,omitempty"`
	// Shopware bundles to include in builds (alternative to composer.json extra.shopware-bundles)
	Bundles []ConfigProjectBundle `yaml:"bundles,omitempty"`
}

type ConfigBuildExtension struct {
	// Name of the extension
	Name string `yaml:"name" jsonschema:"required"`
}

type ConfigBuildHooks struct {
	// Commands to run before anything runs
	Pre []string `yaml:"pre,omitempty"`
	// Commands to run after everything completes
	Post []string `yaml:"post,omitempty"`
	// Commands to run before composer install
	PreComposer []string `yaml:"pre-composer,omitempty"`
	// Commands to run after composer install
	PostComposer []string `yaml:"post-composer,omitempty"`
	// Commands to run before asset build
	PreAssets []string `yaml:"pre-assets,omitempty"`
	// Commands to run after asset build
	PostAssets []string `yaml:"post-assets,omitempty"`
}

type ConfigBuildMJML struct {
	// Whether to enable MJML compilation
	Enabled bool `yaml:"enabled,omitempty"`
	// Directories to search for MJML files
	SearchPaths []string `yaml:"search_paths,omitempty"`
	// When enabled, mj-include directives in MJML templates are processed.
	// MJML 5 ignores mj-include by default for security reasons; set this to
	// true to opt back in. Each search_path is automatically added to the
	// mj-include allowlist for files compiled inside it, so templates can
	// include siblings under the same search_path (e.g. a shared _includes/
	// folder) without further configuration.
	AllowIncludes bool `yaml:"allow_includes,omitempty"`
	// Extra directories outside any search_path that mj-include is allowed to
	// read from. Relative paths are resolved against the project root.
	// Absolute paths are used as-is. Most projects do not need this — set it
	// only when partials live outside the search_path tree. Implies
	// allow_includes.
	IncludePaths []string `yaml:"include_paths,omitempty"`
}

type ConfigDeployment struct {
	Hooks struct {
		// The pre hook will be executed before the deployment
		Pre ConfigDeploymentHook `yaml:"pre"`
		// The post hook will be executed after the deployment
		Post ConfigDeploymentHook `yaml:"post"`
		// The pre-install hook will be executed before the installation
		PreInstall ConfigDeploymentHook `yaml:"pre-install"`
		// The post-install hook will be executed after the installation
		PostInstall ConfigDeploymentHook `yaml:"post-install"`
		// The post-extension-on-project-install hook will be executed after project extensions are installed
		PostExtensionOnProjectInstall ConfigDeploymentHook `yaml:"post-extension-on-project-install"`
		// The pre-update hook will be executed before the update
		PreUpdate ConfigDeploymentHook `yaml:"pre-update"`
		// The post-update hook will be executed after the update
		PostUpdate ConfigDeploymentHook `yaml:"post-update"`
	} `yaml:"hooks"`

	Store struct {
		LicenseDomain string `yaml:"license-domain"`
	} `yaml:"store"`

	Cache struct {
		AlwaysClear bool `yaml:"always_clear"`
	} `yaml:"cache"`

	// The extension management of the deployment
	ExtensionManagement struct {
		// When enabled, the extensions will be installed, updated, and removed
		Enabled bool `yaml:"enabled"`
		// Which extensions should not be managed
		Exclude []string `yaml:"exclude"`

		Overrides ConfigDeploymentOverrides `yaml:"overrides"`

		// DEPRECATED, On these extensions, it will be always called plugin:update
		ForceUpdatesDeprecated []string `yaml:"force_updates,omitempty" jsonschema:"deprecated=true"`
		// On these extensions, it will be always called plugin:update
		ForceUpdate []string `yaml:"force-update,omitempty"`
	} `yaml:"extension-management"`

	OneTimeTasks []struct {
		Id     string `yaml:"id" jsonschema:"required"`
		Script string `yaml:"script" jsonschema:"required"`
	} `yaml:"one-time-tasks"`

	// Staging mode configuration for the deployment
	Staging *ConfigDeploymentStaging `yaml:"staging,omitempty"`

	// OpenSearch configuration for the deployment.
	OpenSearch *ConfigDeploymentOpenSearch `yaml:"opensearch,omitempty"`
}

type ConfigDeploymentHook struct {
	Steps []ConfigDeploymentHookStep
}

type ConfigDeploymentHookStep struct {
	// An optional title shown in the deployment output for this step
	Title string `yaml:"title,omitempty"`
	// The script that is executed for this step
	Script string `yaml:"script"`
}

type ConfigDeploymentOpenSearch struct {
	// When enabled, OpenSearch indexes are created after a fresh installation.
	IndexOnInstall bool `yaml:"index-on-install,omitempty"`
}

type ConfigDeploymentOverrides map[string]struct {
	State string `yaml:"state"`
}

type ConfigDeploymentStaging struct {
	// When enabled, staging setup commands will be executed during installation and upgrade
	Enabled bool `yaml:"enabled,omitempty"`
}

type ConfigDocker struct {
	// PHP configuration for the Docker dev image
	PHP *ConfigDockerPHP `yaml:"php,omitempty"`
	// Per-service settings for the Docker dev environment: host port overrides and implementation variants.
	Services ConfigDockerServices `yaml:"services,omitempty"`
}

type ConfigDockerPHP struct {
	// PHP version (e.g. "8.3", "8.2"). Defaults to "8.3".
	Version string `yaml:"version,omitempty"`
	// Profiler to enable. Possible values: xdebug, blackfire, tideways, pcov, spx.
	Profiler string `yaml:"profiler,omitempty" jsonschema:"enum=xdebug,enum=blackfire,enum=tideways,enum=pcov,enum=spx"`
	// Blackfire server ID from your Blackfire account. Required when profiler is "blackfire".
	BlackfireServerID string `yaml:"blackfire_server_id,omitempty"`
	// Blackfire server token from your Blackfire account. Required when profiler is "blackfire".
	BlackfireServerToken string `yaml:"blackfire_server_token,omitempty"`
	// Tideways API key from your Tideways account. Required when profiler is "tideways".
	TidewaysAPIKey string `yaml:"tideways_api_key,omitempty"`
}

type ConfigDockerService = docker.ServiceSettings

type ConfigDockerServices map[string]*ConfigDockerService

type ConfigDump struct {
	// Allows to rewrite single columns, perfect for GDPR compliance
	Rewrite map[string]map[string]string `yaml:"rewrite,omitempty"`
	// Only export the schema of these tables, supports glob wildcards (e.g. "customer*")
	NoData []string `yaml:"nodata,omitempty"`
	// Ignore these tables from export, supports glob wildcards (e.g. "customer*")
	Ignore []string `yaml:"ignore,omitempty"`
	// Add an where condition to that table, schema is table name as key, and where statement as value
	Where map[string]string `yaml:"where,omitempty"`
	// Limit the amount of exported rows of a table, schema is table name as key. All tables referencing the limited table via foreign keys (also transitively) are filtered automatically, so they only contain rows belonging to the kept rows. A second limit on a table that is already filtered this way is rejected. When the limited table references itself (e.g. product.parent_id), the ancestors of the kept rows are exported too, so the dump stays importable. Requires the CREATE and DROP privileges to freeze the kept rows into staging tables
	Limit map[string]mysqldump.TableLimit `yaml:"limit,omitempty"`
}

type ConfigImageProxy struct {
	// The URL of the upstream server to proxy requests to when files are not found locally
	URL string `yaml:"url,omitempty"`
}

type ConfigProjectBundle struct {
	// Relative path from project root to the bundle directory
	Path string `yaml:"path" jsonschema:"required"`
	// Optional override for the bundle name; defaults to the directory basename
	Name string `yaml:"name,omitempty"`
}

type ConfigURLState struct {
	// HasFile is false when the project has no config file; registration
	// then leaves the project config alone entirely.
	HasFile bool `json:"-"`
	// RootURL is the top-level url value. HasRoot false = key was absent.
	RootURL string `json:"root_url,omitempty"`
	HasRoot bool   `json:"had_root_url,omitempty"`
	// EnvURL is environments.<env>.url, which overrides the top-level url
	// in the dev TUI and the admin API client. HasEnv false = key absent.
	EnvURL string `json:"env_url,omitempty"`
	HasEnv bool   `json:"had_env_url,omitempty"`
}

type ConfigValidation struct {
	// Ignore items from the validation.
	Ignore []ConfigValidationIgnoreItem `yaml:"ignore,omitempty"`

	IgnoreExtensions []ConfigValidationIgnoreExtension `yaml:"ignore_extensions,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 ConfigValidationIgnoreExtension struct {
	// The name of the extension to ignore.
	Name string `yaml:"name"`
}

type ConfigValidationIgnoreItem struct {
	// The identifier of the item to ignore.
	Identifier string `yaml:"identifier"`
	// The path of the item to ignore.
	Path string `yaml:"path,omitempty"`
	// The message of the item to ignore.
	Message string `yaml:"message,omitempty"`
}

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

type ConsoleResponse struct {
	Commands []struct {
		Name        string `json:"name"`
		Description string `json:"description"`
		Hidden      bool   `json:"hidden"`
		Definition  struct {
			Arguments interface{} `json:"arguments"`
			Options   map[string]struct {
				Shortcut string `json:"shortcut"`
			} `json:"options"`
		} `json:"definition"`
	} `json:"commands"`
}

type DumpDatabaseOptions struct {
	// Output is the destination file path, or "-" for stdout
	Output string
	// Compression compresses the dump output, parsed via mysqldump.ParseCompression
	Compression mysqldump.Compression
	// Clean excludes volatile tables (cart, messenger_messages, ...) from the data dump
	Clean bool
	// Anonymize rewrites customer related columns with faker data
	Anonymize bool
	// SkipLockTables disables locking the tables during the dump
	SkipLockTables bool
	// Quick enables the mysqldump quick mode
	Quick bool
	// Parallel controls how many tables are dumped concurrently (0 = disabled)
	Parallel int
	// InsertIntoLimit caps the rows per INSERT statement (0 = auto, takes priority over Quick when set)
	InsertIntoLimit int
	// LimitOverrides contains "table=rows" entries limiting the dumped rows per table
	LimitOverrides []string
}

type EnvironmentConfig struct {
	Type string `yaml:"type" jsonschema:"enum=local,enum=docker,enum=ssh"`
	// Shop URL for this named environment
	URL string `yaml:"url,omitempty"`
	// Admin API credentials for this named environment
	AdminApi *ConfigAdminApi `yaml:"admin_api,omitempty"`
	// SSH target of this named environment (type "ssh"): a Shopware project on a remote host reachable over SSH. Commands run through a multiplexed SSH connection, and the database is tunneled through it automatically.
	SSH *EnvironmentSSHConfig `yaml:"ssh,omitempty"`
}

type EnvironmentSSHConfig struct {
	// SSH host name or IP address
	Host string `yaml:"host" jsonschema:"required"`
	// SSH user. Defaults to the user configured in ~/.ssh/config or the current user
	User string `yaml:"user,omitempty"`
	// SSH port. Defaults to 22
	Port int `yaml:"port,omitempty"`
	// Absolute path of the Shopware project root on the remote host
	Directory string `yaml:"directory" jsonschema:"required"`
	// Path to the SSH private key file. Defaults to the ssh agent or the default key files
	IdentityFile string `yaml:"identity_file,omitempty"`
	// PHP binary used for PHP and console commands on the remote host (e.g. "/usr/bin/php8.3"). Defaults to "php"
	PHPBinary string `yaml:"php_binary,omitempty"`
}

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

type ProductionDockerfileOptions struct {
	PHPVersion          string
	WithDevDependencies bool
}

type ProjectSBOMOptions struct {
	// OutputPath is the destination file. Empty means
	// filepath.Join(root, DefaultProjectSBOMOutput). Relative paths are resolved
	// against the process working directory (same as other CLI --output flags).
	OutputPath string

	// SkipMissingLock, when true, returns nil without writing a file if
	// composer.lock is absent. Used by `project ci` so a lock-less tree does not
	// fail the build. The standalone command leaves this false so a missing lock
	// is a hard error.
	SkipMissingLock bool

	// IncludeDevDependencies controls whether packages-dev from composer.lock are
	// included. Defaults to false to match `project ci`.
	IncludeDevDependencies bool

	// ToolVersion is reported in the SBOM metadata tools entry (shopware-cli version).
	ToolVersion string
}

type ShopwareProjectScaffold struct {
	ProjectFolder       string
	Version             string
	DeploymentMethod    string
	CISystem            string
	PHPVersion          string
	UseDocker           bool
	UseElasticsearch    bool
	UseAMQP             bool
	NoAudit             bool
	SymfonyCLIInstalled bool
}

type StartWorkerFunc func(ctx context.Context, job WorkerJob) (*exec.Cmd, error)

type WorkerConfig struct {
	MemoryLimit   string
	TimeLimit     string
	FailureLimit  uint
	MessagesLimit uint
	Verbose       bool
}

type WorkerJob struct {
	Queues       []string
	ConsumerName string
}

type WorkerQueue struct {
	Name  string
	Count int
}