extension

package

Go to main page

Versions in this module

v0

v0.0.27

Oct 4, 2025

v0.0.26

Oct 4, 2025

v0.0.25

Oct 4, 2025

v0.0.24

Oct 4, 2025

v0.0.23

Oct 4, 2025

v0.0.22

Oct 4, 2025

v0.0.21

Oct 4, 2025

v0.0.20

Oct 4, 2025

v0.0.19

Oct 4, 2025

v0.0.18

Oct 4, 2025

v0.0.17

Oct 4, 2025

v0.0.16

Oct 4, 2025

v0.0.15

Oct 4, 2025

v0.0.14

Oct 4, 2025

v0.0.13

Oct 4, 2025

v0.0.12

Oct 4, 2025

v0.0.11

Oct 4, 2025

v0.0.10

Oct 4, 2025

v0.0.9

Oct 4, 2025

v0.0.8

Oct 4, 2025

v0.0.7

Oct 4, 2025

v0.0.6

Oct 4, 2025

v0.0.5

Oct 4, 2025

v0.0.4

Oct 4, 2025

v0.0.3

Oct 3, 2025

Changes in this version

+ const FrontendBaseCSS

+ const FrontendEntrypointJS

+ const FrontendEntrypointTS

+ const FrontendWebpackCJSConfig

+ const FrontendWebpackConfig

type AssetBuildConfig

+ DisableFrontendBuild bool

type ConfigBuildZipAssets

+ EnableESBuildForFrontend bool

type ExtensionAssetConfig

+ func (c ExtensionAssetConfig) FilterByFrontendAndEsBuild(esbuildEnabled bool) ExtensionAssetConfig

+ func (c ExtensionAssetConfig) RequiresFrontendBuild() bool

type ExtensionAssetConfigEntry

+ EnableESBuildForFrontend bool

+ Frontend ExtensionAssetConfigFrontend

+ func (e *ExtensionAssetConfigEntry) GetOutputFrontendPath() string

+ type ExtensionAssetConfigFrontend struct

+ EntryFilePath *string

+ Path string

+ StyleFiles []string

+ Webpack *string

+ type Frontend struct

+ TemplateLoadPriority int

type Manifest

+ Frontend *Frontend

v0.0.2

Oct 3, 2025

v0.0.1

Oct 3, 2025

Changes in this version

+ const AdministrationEntrypointJS

+ const AdministrationEntrypointTS

+ const AdministrationWebpackCJSConfig

+ const AdministrationWebpackConfig

+ const ComposerTypeApp

+ const ComposerTypeBundle

+ const ComposerTypePlugin

+ const DevVersionNumber

+ const StorefrontBaseCSS

+ const StorefrontEntrypointJS

+ const StorefrontEntrypointTS

+ const StorefrontWebpackCJSConfig

+ const StorefrontWebpackConfig

+ const TypeHeyFrameBundle

+ const TypePlatformApp

+ const TypePlatformPlugin

+ var ErrPlatformInvalidType = errors.New("invalid composer type")

+ func AddZipFiles(w *zip.Writer, basePath, baseInZip string) error

+ func BuildAssetsForExtensions(ctx context.Context, sources []asset.Source, assetConfig AssetBuildConfig) error

+ func BuildModifier(ext Extension, extensionRoot string, config BuildModifierConfig) error

+ func ChecksumFile(filePath string) (string, error)

+ func CleanupExtensionFolder(path string, additionalPaths []string) error

+ func ConvertExtensionsToSources(ctx context.Context, extensions []Extension) []asset.Source

+ func CreateZip(baseFolder, zipFile string) error

+ func DumpAndLoadAssetSourcesOfProject(ctx context.Context, project string, cfg *platform.Config) ([]asset.Source, error)

+ func FindAssetSourcesOfProject(ctx context.Context, project string, cfg *platform.Config) []asset.Source

+ func GenerateChecksumJSON(ctx context.Context, baseFolder string, ext Extension) error

+ func GetConfiguredGoldMark() goldmark.Markdown

+ func GetHeyFrameProjectConstraint(project string) (*version.Constraints, error)

+ func GetHeyFrameVersions(ctx context.Context) ([]string, error)

+ func GetPhpVersion(ctx context.Context, constraint *version.Constraints) (string, error)

+ func GitCopyFolder(ctx context.Context, source, target, commitHash string) (string, error)

+ func InstallNPMDependencies(ctx context.Context, path string, packageJsonData NpmPackage, ...) error

+ func InstallNodeModulesOfConfigs(ctx context.Context, cfgs ExtensionAssetConfig, force bool) ([]string, error)

+ func LoadSymfonyEnvFile(projectRoot string) error

+ func PlatformPath(projectRoot, component, path string) string

+ func PrepareExtensionForRelease(ctx context.Context, sourceRoot, extensionRoot string, ext Extension) error

+ func PrepareFolderForZipping(ctx context.Context, path string, ext Extension, extCfg *Config) error

+ func ResizeExtensionIcon(ctx context.Context, ext Extension) error

+ func RunValidation(ctx context.Context, ext Extension, check validation.Check)

+ func Unzip(r *zip.Reader, dest string) error

+ type ActionButton struct

+ Action string

+ Entity string

+ Label TranslatableString

+ URL string

+ View string

+ type Admin struct

+ ActionButton []ActionButton

+ BaseAppUrl string

+ MainModule *MainModule

+ Module []Module

+ type AllowedHosts struct

+ Host []string

+ type App struct

+ func (App) GetType() string

+ func (a App) GetChangelog() (*ExtensionChangelog, error)

+ func (a App) GetComposerName() (string, error)

+ func (a App) GetExtensionConfig() *Config

+ func (a App) GetHeyFrameVersionConstraint() (*version.Constraints, error)

+ func (a App) GetIconPath() string

+ func (a App) GetLicense() (string, error)

+ func (a App) GetMetaData() *extensionMetadata

+ func (a App) GetName() (string, error)

+ func (a App) GetPath() string

+ func (a App) GetResourcesDir() string

+ func (a App) GetResourcesDirs() []string

+ func (a App) GetRootDir() string

+ func (a App) GetSourceDirs() []string

+ func (a App) GetVersion() (*version.Version, error)

+ func (a App) Validate(_ context.Context, check validation.Check)

+ type AssetBuildConfig struct

+ Browserslist string

+ CleanupNodeModules bool

+ DisableAdminBuild bool

+ DisableStorefrontBuild bool

+ ForceAdminBuild bool

+ ForceExtensionBuild []string

+ HeyFrameRoot string

+ HeyFrameVersion *version.Constraints

+ KeepNodeModules []string

+ NPMForceInstall bool

+ SkipExtensionsWithBuildFiles bool

+ type BuildModifierConfig struct

+ AppBackendSecret string

+ AppBackendUrl string

+ Version string

+ type ChecksumJSON struct

+ Algorithm string

+ ExtensionVersion string

+ Hashes map[string]string

+ Version string

+ type Config struct

+ Build ConfigBuild

+ Changelog changelog.Config

+ FileName string

+ Store ConfigStore

+ Validation ConfigValidation

+ func (c *Config) Dump(dir string) error

+ type ConfigBuild struct

+ ExtraBundles []ConfigExtraBundle

+ HeyFrameVersionConstraint string

+ Zip ConfigBuildZip

+ type ConfigBuildZip struct

+ Assets ConfigBuildZipAssets

+ Checksum ConfigBuildZipChecksum

+ Composer ConfigBuildZipComposer

+ Pack ConfigBuildZipPack

+ type ConfigBuildZipAssets struct

+ AfterHooks []string

+ BeforeHooks []string

+ DisableSass bool

+ EnableESBuildForAdmin bool

+ EnableESBuildForStorefront bool

+ Enabled bool

+ NpmStrict bool

+ type ConfigBuildZipChecksum struct

+ Ignore []string

+ type ConfigBuildZipComposer struct

+ AfterHooks []string

+ BeforeHooks []string

+ Enabled bool

+ ExcludedPackages []string

+ type ConfigBuildZipPack struct

+ BeforeHooks []string

+ Excludes ConfigBuildZipPackExcludes

+ type ConfigBuildZipPackExcludes struct

+ Paths []string

+ type ConfigExtraBundle struct

+ Name string

+ Path string

+ type ConfigStore struct

+ AutomaticBugfixVersionCompatibility *bool

+ Availabilities *[]string

+ Categories *[]string

+ DefaultLocale *string

+ Description ConfigTranslated[string]

+ Faq ConfigTranslated[[]ConfigStoreFaq]

+ Features ConfigTranslated[[]string]

+ Highlights ConfigTranslated[[]string]

+ Icon *string

+ ImageDirectory *string

+ Images *[]ConfigStoreImage

+ InstallationManual ConfigTranslated[string]

+ Localizations *[]string

+ MetaDescription ConfigTranslated[string]

+ MetaTitle ConfigTranslated[string]

+ Tags ConfigTranslated[[]string]

+ Type *string

+ Videos ConfigTranslated[[]string]

+ func (c *ConfigStore) IsInGermanStore() bool

+ type ConfigStoreFaq struct

+ Answer string

+ Position int

+ Question string

+ type ConfigStoreImage struct

+ Activate ConfigStoreImageActivate

+ File string

+ Preview ConfigStoreImagePreview

+ Priority int

+ type ConfigStoreImageActivate struct

+ English bool

+ German bool

+ type ConfigStoreImagePreview struct

+ English bool

+ German bool

+ type ConfigTranslated struct

+ English *T

+ German *T

+ type ConfigValidation struct

+ Ignore ConfigValidationList

+ StoreCompliance bool

+ type ConfigValidationList []validation.ToolConfigIgnore

+ func (c *ConfigValidationList) Identifiers() []string

+ type Cookie struct

+ Cookie string

+ Expiration int

+ SnippetDescription string

+ SnippetName string

+ Value string

+ type CookieEntry struct

+ type CookieGroup struct

+ Entries []CookieEntry

+ SnippetDescription string

+ SnippetName string

+ type Cookies struct

+ Cookie []Cookie

+ Group []CookieGroup

+ type CustomFieldBase struct

+ AllowCartExpose bool

+ AllowCustomerWrite bool

+ HelpText TranslatableString

+ Label TranslatableString

+ Position int

+ Required bool

+ type CustomFieldBool struct

+ Name string

+ XMLName xml.Name

+ type CustomFieldColorPicker struct

+ Name string

+ XMLName xml.Name

+ type CustomFieldDatetime struct

+ Name string

+ XMLName xml.Name

+ type CustomFieldFloat struct

+ Max float64

+ Min float64

+ Name string

+ Placeholder TranslatableString

+ Steps float64

+ XMLName xml.Name

+ type CustomFieldInt struct

+ Max int

+ Min int

+ Name string

+ Placeholder TranslatableString

+ Steps int

+ XMLName xml.Name

+ type CustomFieldList struct

+ Bool []CustomFieldBool

+ ColorPicker []CustomFieldColorPicker

+ Datetime []CustomFieldDatetime

+ Float []CustomFieldFloat

+ Int []CustomFieldInt

+ MediaSelection []CustomFieldMedia

+ MultiEntitySelect []CustomFieldMultiEntitySelect

+ MultiSelect []CustomFieldMultiSelect

+ Price []CustomFieldPrice

+ SingleEntitySelect []CustomFieldSingleEntitySelect

+ SingleSelect []CustomFieldSingleSelect

+ Text []CustomFieldText

+ TextArea []CustomFieldTextArea

+ type CustomFieldMedia struct

+ Name string

+ XMLName xml.Name

+ type CustomFieldMultiEntitySelect struct

+ XMLName xml.Name

+ type CustomFieldMultiSelect struct

+ XMLName xml.Name

+ type CustomFieldPrice struct

+ Name string

+ XMLName xml.Name

+ type CustomFieldSet struct

+ Fields CustomFieldList

+ Global bool

+ Label TranslatableString

+ Name string

+ RelatedEntities EntityList

+ type CustomFieldSingleEntitySelect struct

+ Entity string

+ LabelProperty string

+ Name string

+ Placeholder TranslatableString

+ XMLName xml.Name

+ type CustomFieldSingleSelect struct

+ Name string

+ Options OptionCollection

+ Placeholder TranslatableString

+ XMLName xml.Name

+ type CustomFieldText struct

+ Name string

+ Placeholder TranslatableString

+ XMLName xml.Name

+ type CustomFieldTextArea struct

+ Name string

+ Placeholder TranslatableString

+ XMLName xml.Name

+ type CustomFields struct

+ CustomFieldSet []CustomFieldSet

+ type DeliveryTime struct

+ ID string

+ Max int

+ Min int

+ Name TranslatableString

+ Unit string

+ type EntityList struct

+ Category *struct{}

+ Channel *struct{}

+ Country *struct{}

+ Currency *struct{}

+ Customer *struct{}

+ CustomerAddress *struct{}

+ CustomerGroup *struct{}

+ DeliveryTime *struct{}

+ DocumentBaseConfig *struct{}

+ EventAction *struct{}

+ LandingPage *struct{}

+ Language *struct{}

+ Media *struct{}

+ NumberRange *struct{}

+ Order *struct{}

+ PaymentMethod *struct{}

+ Product *struct{}

+ ProductManufacturer *struct{}

+ ProductReview *struct{}

+ ProductStream *struct{}

+ Promotion *struct{}

+ PropertyGroup *struct{}

+ Rule *struct{}

+ Salutation *struct{}

+ ShippingMethod *struct{}

+ Tax *struct{}

+ type Extension interface

+ GetChangelog func() (*ExtensionChangelog, error)

+ GetComposerName func() (string, error)

+ GetExtensionConfig func() *Config

+ GetHeyFrameVersionConstraint func() (*version.Constraints, error)

+ GetIconPath func() string

+ GetLicense func() (string, error)

+ GetMetaData func() *extensionMetadata

+ GetName func() (string, error)

+ GetPath func() string

+ GetResourcesDir func() string

+ GetResourcesDirs func() []string

+ GetRootDir func() string

+ GetSourceDirs func() []string

+ GetType func() string

+ GetVersion func() (*version.Version, error)

+ Validate func(context.Context, validation.Check)

+ func FindExtensionsFromProject(ctx context.Context, project string) []Extension

+ func GetExtensionByFolder(path string) (Extension, error)

+ func GetExtensionByZip(filePath string) (Extension, error)

+ type ExtensionAssetConfig map[string]*ExtensionAssetConfigEntry

+ func BuildAssetConfigFromExtensions(ctx context.Context, sources []asset.Source, assetCfg AssetBuildConfig) ExtensionAssetConfig

+ func (c ExtensionAssetConfig) FilterByAdmin() ExtensionAssetConfig

+ func (c ExtensionAssetConfig) FilterByAdminAndEsBuild(esbuildEnabled bool) ExtensionAssetConfig

+ func (c ExtensionAssetConfig) FilterByStorefrontAndEsBuild(esbuildEnabled bool) ExtensionAssetConfig

+ func (c ExtensionAssetConfig) Has(name string) bool

+ func (c ExtensionAssetConfig) Not(extensions []string) ExtensionAssetConfig

+ func (c ExtensionAssetConfig) Only(extensions []string) ExtensionAssetConfig

+ func (c ExtensionAssetConfig) RequiresAdminBuild() bool

+ func (c ExtensionAssetConfig) RequiresHeyFrameRepository() bool

+ func (c ExtensionAssetConfig) RequiresStorefrontBuild() bool

+ type ExtensionAssetConfigAdmin struct

+ EntryFilePath *string

+ Path string

+ Webpack *string

+ type ExtensionAssetConfigEntry struct

+ Administration ExtensionAssetConfigAdmin

+ BasePath string

+ DisableSass bool

+ EnableESBuildForAdmin bool

+ EnableESBuildForStorefront bool

+ NpmStrict bool

+ Storefront ExtensionAssetConfigStorefront

+ TechnicalName string

+ Views []string

+ func (e *ExtensionAssetConfigEntry) GetContentHash() (string, error)

+ func (e *ExtensionAssetConfigEntry) GetOutputAdminPath() string

+ func (e *ExtensionAssetConfigEntry) GetOutputStorefrontPath() string

+ func (e *ExtensionAssetConfigEntry) RequiresBuild() bool

+ type ExtensionAssetConfigStorefront struct

+ EntryFilePath *string

+ Path string

+ StyleFiles []string

+ Webpack *string

+ type ExtensionChangelog struct

+ Changelogs map[string]string

+ English string

+ German string

+ type Gateways struct

+ Checkout string

+ type HeyFrameBundle struct

+ Composer heyframeBundleComposerJson

+ func (HeyFrameBundle) GetType() string

+ func (p HeyFrameBundle) GetChangelog() (*ExtensionChangelog, error)

+ func (p HeyFrameBundle) GetComposerName() (string, error)

+ func (p HeyFrameBundle) GetExtensionConfig() *Config

+ func (p HeyFrameBundle) GetHeyFrameVersionConstraint() (*version.Constraints, error)

+ func (p HeyFrameBundle) GetIconPath() string

+ func (p HeyFrameBundle) GetLicense() (string, error)

+ func (p HeyFrameBundle) GetMetaData() *extensionMetadata

+ func (p HeyFrameBundle) GetName() (string, error)

+ func (p HeyFrameBundle) GetPath() string

+ func (p HeyFrameBundle) GetResourcesDir() string

+ func (p HeyFrameBundle) GetResourcesDirs() []string

+ func (p HeyFrameBundle) GetRootDir() string

+ func (p HeyFrameBundle) GetSourceDirs() []string

+ func (p HeyFrameBundle) GetVersion() (*version.Version, error)

+ func (p HeyFrameBundle) Validate(c context.Context, check validation.Check)

+ type MainModule struct

+ Source string

+ type Manifest struct

+ Admin *Admin

+ AllowedHosts *AllowedHosts

+ Cookies *Cookies

+ CustomFields *CustomFields

+ Gateways *Gateways

+ Meta Meta

+ Payments *Payments

+ Permissions *Permissions

+ RuleConditions *RuleConditions

+ Setup *Setup

+ ShippingMethods *ShippingMethods

+ Storefront *Storefront

+ Tax *Tax

+ Webhooks *Webhooks

+ XMLName xml.Name

+ type Meta struct

+ Author string

+ Compatibility string

+ Copyright string

+ Description TranslatableString

+ Icon string

+ Label TranslatableString

+ License string

+ Name string

+ Privacy string

+ PrivacyPolicyExtensions TranslatableString

+ Version string

+ type Module struct

+ Label TranslatableString

+ Name string

+ Parent string

+ Position int

+ Source string

+ type NpmPackage struct

+ Dependencies map[string]string

+ DevDependencies map[string]string

+ Scripts map[string]string

+ func (p NpmPackage) HasScript(name string) bool

+ type Option struct

+ Name TranslatableString

+ Value string

+ type OptionCollection struct

+ Option []Option

+ type PaymentMethod struct

+ CaptureURL string

+ Description TranslatableString

+ FinalizeURL string

+ Icon string

+ Identifier string

+ Name TranslatableString

+ PayURL string

+ RecurringURL string

+ RefundURL string

+ ValidateURL string

+ type Payments struct

+ PaymentMethod []PaymentMethod

+ type Permissions struct

+ Create []string

+ Delete []string

+ Permission []string

+ Read []string

+ Update []string

+ type PlatformComposerJson struct

+ Authors []struct{ ... }

+ Autoload struct{ ... }

+ Description string

+ Extra platformComposerJsonExtra

+ Keywords []string

+ License string

+ Name string

+ Require map[string]string

+ Suggest map[string]string

+ Type string

+ Version string

+ type PlatformPlugin struct

+ Composer PlatformComposerJson

+ func (PlatformPlugin) GetType() string

+ func (p PlatformPlugin) GetChangelog() (*ExtensionChangelog, error)

+ func (p PlatformPlugin) GetComposerName() (string, error)

+ func (p PlatformPlugin) GetExtensionConfig() *Config

+ func (p PlatformPlugin) GetHeyFrameVersionConstraint() (*version.Constraints, error)

+ func (p PlatformPlugin) GetIconPath() string

+ func (p PlatformPlugin) GetLicense() (string, error)

+ func (p PlatformPlugin) GetMetaData() *extensionMetadata

+ func (p PlatformPlugin) GetName() (string, error)

+ func (p PlatformPlugin) GetPath() string

+ func (p PlatformPlugin) GetResourcesDir() string

+ func (p PlatformPlugin) GetResourcesDirs() []string

+ func (p PlatformPlugin) GetRootDir() string

+ func (p PlatformPlugin) GetSourceDirs() []string

+ func (p PlatformPlugin) GetVersion() (*version.Version, error)

+ func (p PlatformPlugin) Validate(c context.Context, check validation.Check)

+ type RuleCondition struct

+ Constraints []CustomFieldList

+ Group string

+ Identifier string

+ Name TranslatableString

+ Script string

+ type RuleConditions struct

+ RuleCondition []RuleCondition

+ type Setup struct

+ RegistrationUrl string

+ Secret string

+ type ShippingMethod struct

+ Active bool

+ DeliveryTime DeliveryTime

+ Description TranslatableString

+ Icon string

+ Identifier string

+ Name TranslatableString

+ Position int

+ TrackingURL TranslatableString

+ type ShippingMethods struct

+ ShippingMethod []ShippingMethod

+ type Storefront struct

+ TemplateLoadPriority int

+ type Tax struct

+ TaxProvider []TaxProvider

+ type TaxProvider struct

+ Identifier string

+ Name string

+ Priority int

+ ProcessURL string

+ type Translatable interface

+ type TranslatableString []struct

+ func (t TranslatableString) GetValueByLanguage(lang []string) string

+ type Webhook struct

+ Event string

+ Name string

+ OnlyLiveVersion bool

+ URL string

+ type Webhooks struct

+ Webhook []Webhook

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL