components

Documentation

Index

• Constants
• func CheckDeprecated(log logger.Logger, name, version string, versionSet Versioning)
• func IsInitialVersion(version string) bool
• func IsWasmComponentType(componentType string) bool
• func RegisterWasmComponentType(category Category, typeName string)
• type Category
• type VersionConstructor
• type Versioning

Constants

const (
	// Unstable version (v0).
	UnstableVersion = "v0"

	// First stable version (v1).
	FirstStableVersion = "v1"
)

Functions

func CheckDeprecated

func CheckDeprecated(log logger.Logger, name, version string, versionSet Versioning)

CheckDeprecated checks if a version is deprecated and logs a warning if it is using information derived from the version set.

func IsInitialVersion

func IsInitialVersion(version string) bool

IsInitialVersion returns true when a version is considered an unstable version (v0) or first stable version (v1). For backward compatibility, empty strings are also included.

func IsWasmComponentType

func IsWasmComponentType(componentType string) bool

func RegisterWasmComponentType

func RegisterWasmComponentType(category Category, typeName string)

Types

type Category

type Category string

const (
	CategoryBindings        Category = "bindings"
	CategoryPubSub          Category = "pubsub"
	CategorySecretStore     Category = "secretstores"
	CategoryStateStore      Category = "state"
	CategoryWorkflow        Category = "workflow"
	CategoryWorkflowBackend Category = "workflowbackend"
	CategoryMiddleware      Category = "middleware"
	CategoryConfiguration   Category = "configuration"
	CategoryCryptoProvider  Category = "crypto"
	CategoryLock            Category = "lock"
	CategoryNameResolution  Category = "nameresolution"
)

supported components category

type VersionConstructor

type VersionConstructor struct {
	Version     string
	Constructor any
}

VersionConstructor is a version name func pair used to construct a component.

type Versioning

type Versioning struct {
	// Preferred is the preferred version to use, used to log a warning if a
	// deprecated version is used.
	Preferred VersionConstructor

	// Deprecated is a list of deprecated versions to log a warning if used.
	Deprecated []VersionConstructor

	// Others is a list of other versions that are supported, but not preferred.
	Others []VersionConstructor

	// Default is the default version to use when no version is specified. This
	// should make a VersionConstructor from the set above.
	Default string
}

Versioning is a struct that contains the versioning information for a single component Type. It is expected that each VersionConstructor be unique.