command

package

Go to main page

Versions in this module

v0

v0.18.0

Mar 21, 2026

v0.17.0

Mar 4, 2026

v0.16.0

Feb 9, 2026

Changes in this version

+ var ErrPreferenceDuplicateKey = errors.New("go-users: duplicate preference key")

+ var ErrPreferenceKeysRequired = errors.New("go-users: preference keys required")

+ var ErrPreferenceValuesRequired = errors.New("go-users: preference values required")

+ type PreferenceDeleteManyCommand struct

+ func NewPreferenceDeleteManyCommand(cfg PreferenceCommandConfig) *PreferenceDeleteManyCommand

+ func (c *PreferenceDeleteManyCommand) Execute(ctx context.Context, input PreferenceDeleteManyInput) error

+ type PreferenceDeleteManyInput struct

+ Actor types.ActorRef

+ Keys []string

+ Level types.PreferenceLevel

+ Mode types.PreferenceBulkMode

+ Results *[]types.PreferenceBulkDeleteResult

+ Scope types.ScopeFilter

+ UserID uuid.UUID

+ func (PreferenceDeleteManyInput) Type() string

+ func (input PreferenceDeleteManyInput) Validate() error

+ type PreferenceUpsertManyCommand struct

+ func NewPreferenceUpsertManyCommand(cfg PreferenceCommandConfig) *PreferenceUpsertManyCommand

+ func (c *PreferenceUpsertManyCommand) Execute(ctx context.Context, input PreferenceUpsertManyInput) error

+ type PreferenceUpsertManyInput struct

+ Actor types.ActorRef

+ Level types.PreferenceLevel

+ Mode types.PreferenceBulkMode

+ Results *[]types.PreferenceBulkUpsertResult

+ Scope types.ScopeFilter

+ UserID uuid.UUID

+ Values map[string]any

+ func (PreferenceUpsertManyInput) Type() string

+ func (input PreferenceUpsertManyInput) Validate() error

v0.15.0

Jan 26, 2026

v0.14.0

Jan 26, 2026

Changes in this version

+ const DefaultBatchSize

+ const DefaultSchedule

+ const MaxBatchSize

+ var ErrMissingCommand = errors.New("go-users: activity enrichment command required")

+ var ErrMissingEnrichmentQuery = errors.New("go-users: missing activity enrichment query")

+ var ErrMissingEnrichmentStore = errors.New("go-users: missing activity enrichment store")

+ type Command struct

+ func New(cfg Config) *Command

+ func (c *Command) CronHandler() func() error

+ func (c *Command) CronOptions() gocommand.HandlerConfig

+ func (c *Command) Execute(ctx context.Context, input Input) error

+ type Config struct

+ ActivityRepository types.ActivityRepository

+ ActorResolver activity.ActorResolver

+ BatchSize int

+ Clock types.Clock

+ EnrichedAtCutoff time.Duration

+ Enricher activity.ActivityEnricher

+ EnrichmentQuery activity.ActivityEnrichmentQuery

+ EnrichmentStore activity.ActivityEnrichmentStore

+ Logger types.Logger

+ ObjectResolver activity.ObjectResolver

+ Schedule string

+ Scope types.ScopeFilter

+ type Input struct

+ BatchSize int

+ EnrichedBefore *time.Time

+ Scope types.ScopeFilter

+ func (Input) Type() string

+ func (Input) Validate() error

v0.13.0

Jan 21, 2026

Changes in this version

+ var ErrInviteDisabled = errors.New("go-users: invite disabled")

+ var ErrPasswordResetDisabled = errors.New("go-users: password reset disabled")

+ var ErrSignupDisabled = errors.New("go-users: signup disabled")

type InviteCommandConfig

+ FeatureGate featuregate.FeatureGate

type PasswordResetRequestConfig

+ FeatureGate featuregate.FeatureGate

type RegistrationRequestConfig

+ FeatureGate featuregate.FeatureGate

v0.12.0

Jan 20, 2026

v0.11.0

Jan 20, 2026

Changes in this version

+ const SecureLinkActionInvite

+ const SecureLinkActionPasswordReset

+ const SecureLinkActionRegister

+ const SecureLinkRouteInviteAccept

+ const SecureLinkRoutePasswordReset

+ const SecureLinkRouteRegister

+ var ErrResetCommandRequired = errors.New("go-users: password reset command required")

+ var ErrResetIdentifierRequired = errors.New("go-users: password reset requires identifier")

+ var ErrTokenAlreadyUsed = errors.New("go-users: token already used")

+ var ErrTokenExpired = errors.New("go-users: token expired")

+ var ErrTokenJTIRequired = errors.New("go-users: token jti required")

+ var ErrTokenNotFound = errors.New("go-users: token not found")

+ var ErrTokenRequired = errors.New("go-users: token required")

+ var ErrTokenTypeRequired = errors.New("go-users: token type required")

+ var ErrTokenUserMismatch = errors.New("go-users: token user mismatch")

+ var ErrUserNotFound = errors.New("go-users: user not found")

type InviteCommandConfig

+ Route string

+ SecureLinks types.SecureLinkManager

+ TokenRepository types.UserTokenRepository

+ type PasswordResetConfirmConfig struct

+ Clock types.Clock

+ Logger types.Logger

+ ResetCommand *UserPasswordResetCommand

+ ResetRepository types.PasswordResetRepository

+ ScopeEnforcer types.ScopeEnforcer

+ SecureLinks types.SecureLinkManager

+ type PasswordResetRequestConfig struct

+ Activity types.ActivitySink

+ Clock types.Clock

+ Hooks types.Hooks

+ IDGen types.IDGenerator

+ Logger types.Logger

+ Repository types.AuthRepository

+ ResetRepository types.PasswordResetRepository

+ Route string

+ SecureLinks types.SecureLinkManager

+ TokenTTL time.Duration

+ type RegistrationRequestConfig struct

+ Activity types.ActivitySink

+ Clock types.Clock

+ Hooks types.Hooks

+ IDGen types.IDGenerator

+ Logger types.Logger

+ Repository types.AuthRepository

+ Route string

+ ScopeGuard scope.Guard

+ SecureLinks types.SecureLinkManager

+ TokenRepository types.UserTokenRepository

+ TokenTTL time.Duration

+ type TokenConsumeConfig struct

+ Activity types.ActivitySink

+ Clock types.Clock

+ Hooks types.Hooks

+ ScopeEnforcer types.ScopeEnforcer

+ SecureLinks types.SecureLinkManager

+ TokenRepository types.UserTokenRepository

+ type TokenValidateConfig struct

+ Clock types.Clock

+ ScopeEnforcer types.ScopeEnforcer

+ SecureLinks types.SecureLinkManager

+ TokenRepository types.UserTokenRepository

+ type UserPasswordResetConfirmCommand struct

+ func NewUserPasswordResetConfirmCommand(cfg PasswordResetConfirmConfig) *UserPasswordResetConfirmCommand

+ func (c *UserPasswordResetConfirmCommand) Execute(ctx context.Context, input UserPasswordResetConfirmInput) error

+ type UserPasswordResetConfirmInput struct

+ NewPasswordHash string

+ Result *UserPasswordResetConfirmResult

+ Scope types.ScopeFilter

+ Token string

+ func (UserPasswordResetConfirmInput) Type() string

+ func (input UserPasswordResetConfirmInput) Validate() error

+ type UserPasswordResetConfirmResult struct

+ User *types.AuthUser

type UserPasswordResetInput

+ TokenExpiresAt time.Time

+ TokenJTI string

+ type UserPasswordResetRequestCommand struct

+ func NewUserPasswordResetRequestCommand(cfg PasswordResetRequestConfig) *UserPasswordResetRequestCommand

+ func (c *UserPasswordResetRequestCommand) Execute(ctx context.Context, input UserPasswordResetRequestInput) error

+ type UserPasswordResetRequestInput struct

+ Actor types.ActorRef

+ Identifier string

+ Metadata map[string]any

+ Result *UserPasswordResetRequestResult

+ Scope types.ScopeFilter

+ UserID uuid.UUID

+ func (UserPasswordResetRequestInput) Type() string

+ func (input UserPasswordResetRequestInput) Validate() error

+ type UserPasswordResetRequestResult struct

+ ExpiresAt time.Time

+ Token string

+ User *types.AuthUser

+ type UserRegistrationRequestCommand struct

+ func NewUserRegistrationRequestCommand(cfg RegistrationRequestConfig) *UserRegistrationRequestCommand

+ func (c *UserRegistrationRequestCommand) Execute(ctx context.Context, input UserRegistrationRequestInput) error

+ type UserRegistrationRequestInput struct

+ Actor types.ActorRef

+ Email string

+ FirstName string

+ LastName string

+ Metadata map[string]any

+ Result *UserRegistrationRequestResult

+ Role string

+ Scope types.ScopeFilter

+ Username string

+ func (UserRegistrationRequestInput) Type() string

+ func (input UserRegistrationRequestInput) Validate() error

+ type UserRegistrationRequestResult struct

+ ExpiresAt time.Time

+ Token string

+ User *types.AuthUser

+ type UserTokenConsumeCommand struct

+ func NewUserTokenConsumeCommand(cfg TokenConsumeConfig) *UserTokenConsumeCommand

+ func (c *UserTokenConsumeCommand) Execute(ctx context.Context, input UserTokenConsumeInput) error

+ type UserTokenConsumeInput struct

+ Result *UserTokenConsumeResult

+ Scope types.ScopeFilter

+ Token string

+ TokenType types.UserTokenType

+ func (UserTokenConsumeInput) Type() string

+ func (input UserTokenConsumeInput) Validate() error

+ type UserTokenConsumeResult struct

+ Payload types.SecureLinkPayload

+ Token *types.UserToken

+ type UserTokenValidateCommand struct

+ func NewUserTokenValidateCommand(cfg TokenValidateConfig) *UserTokenValidateCommand

+ func (c *UserTokenValidateCommand) Execute(ctx context.Context, input UserTokenValidateInput) error

+ type UserTokenValidateInput struct

+ Result *UserTokenValidateResult

+ Scope types.ScopeFilter

+ Token string

+ TokenType types.UserTokenType

+ func (UserTokenValidateInput) Type() string

+ func (input UserTokenValidateInput) Validate() error

+ type UserTokenValidateResult struct

+ Payload types.SecureLinkPayload

+ Token *types.UserToken

v0.10.0

Jan 15, 2026

v0.9.0

Jan 13, 2026

v0.8.0

Jan 13, 2026

Changes in this version

type UserUpdateCommandConfig

+ Policy types.TransitionPolicy

v0.7.0

Jan 13, 2026

Changes in this version

+ var ErrUsersRequired = errors.New("go-users: users required")

+ type BulkUserImportCommand struct

+ func NewBulkUserImportCommand(create *UserCreateCommand) *BulkUserImportCommand

+ func (c *BulkUserImportCommand) Execute(ctx context.Context, input BulkUserImportInput) error

+ type BulkUserImportInput struct

+ Actor types.ActorRef

+ ContinueOnError bool

+ DefaultStatus types.LifecycleState

+ DryRun bool

+ Results *[]BulkUserImportResult

+ Scope types.ScopeFilter

+ Users []*types.AuthUser

+ func (BulkUserImportInput) Type() string

+ func (input BulkUserImportInput) Validate() error

+ type BulkUserImportResult struct

+ Email string

+ Err error

+ Index int

+ Status types.LifecycleState

+ UserID uuid.UUID

v0.6.0

Jan 12, 2026

Changes in this version

+ var ErrUserEmailRequired = errors.New("go-users: user email required")

+ var ErrUserRequired = errors.New("go-users: user payload required")

+ type UserCreateCommand struct

+ func NewUserCreateCommand(cfg UserCreateCommandConfig) *UserCreateCommand

+ func (c *UserCreateCommand) Execute(ctx context.Context, input UserCreateInput) error

+ type UserCreateCommandConfig struct

+ Activity types.ActivitySink

+ Clock types.Clock

+ Hooks types.Hooks

+ Logger types.Logger

+ Repository types.AuthRepository

+ ScopeGuard scope.Guard

+ type UserCreateInput struct

+ Actor types.ActorRef

+ Result *types.AuthUser

+ Scope types.ScopeFilter

+ Status types.LifecycleState

+ User *types.AuthUser

+ func (UserCreateInput) Type() string

+ func (input UserCreateInput) Validate() error

type UserInviteInput

+ Username string

+ type UserUpdateCommand struct

+ func NewUserUpdateCommand(cfg UserUpdateCommandConfig) *UserUpdateCommand

+ func (c *UserUpdateCommand) Execute(ctx context.Context, input UserUpdateInput) error

+ type UserUpdateCommandConfig struct

+ Activity types.ActivitySink

+ Clock types.Clock

+ Hooks types.Hooks

+ Logger types.Logger

+ Repository types.AuthRepository

+ ScopeGuard scope.Guard

+ type UserUpdateInput struct

+ Actor types.ActorRef

+ Result *types.AuthUser

+ Scope types.ScopeFilter

+ User *types.AuthUser

+ func (UserUpdateInput) Type() string

+ func (input UserUpdateInput) Validate() error

v0.5.0

Jan 9, 2026

Changes in this version

type CreateRoleInput

+ Order int

type UpdateRoleInput

+ Order int

v0.4.0

Jan 8, 2026

Changes in this version

type CreateRoleInput

+ Metadata map[string]any

+ RoleKey string

type UpdateRoleInput

+ Metadata map[string]any

+ RoleKey string

v0.3.0

Dec 2, 2025

v0.2.0

Nov 25, 2025

Changes in this version

+ var ErrActivityVerbRequired = errors.New("go-users: activity verb required")

+ var ErrActorRequired = types.ErrActorRequired

+ var ErrInviteEmailRequired = errors.New("go-users: invite requires email")

+ var ErrLifecycleTargetRequired = errors.New("go-users: lifecycle transition requires target state")

+ var ErrLifecycleUserIDRequired = errors.New("go-users: lifecycle transition requires user id")

+ var ErrPasswordHashRequired = errors.New("go-users: password reset requires password hash")

+ var ErrPreferenceKeyRequired = errors.New("go-users: preference key required")

+ var ErrPreferenceValueRequired = errors.New("go-users: preference value required")

+ var ErrRoleIDRequired = errors.New("go-users: role id required")

+ var ErrRoleNameRequired = errors.New("go-users: role name required")

+ var ErrUserIDRequired = types.ErrUserIDRequired

+ var ErrUserIDsRequired = errors.New("go-users: user ids required")

+ type ActivityLogCommand struct

+ func NewActivityLogCommand(cfg ActivityLogConfig) *ActivityLogCommand

+ func (c *ActivityLogCommand) Execute(ctx context.Context, input ActivityLogInput) error

+ type ActivityLogConfig struct

+ Clock types.Clock

+ Hooks types.Hooks

+ Sink types.ActivitySink

+ type ActivityLogInput struct

+ Record types.ActivityRecord

+ func (ActivityLogInput) Type() string

+ func (input ActivityLogInput) Validate() error

+ type AssignRoleCommand struct

+ func NewAssignRoleCommand(registry types.RoleRegistry, guard scope.Guard) *AssignRoleCommand

+ func (c *AssignRoleCommand) Execute(ctx context.Context, input AssignRoleInput) error

+ type AssignRoleInput struct

+ Actor types.ActorRef

+ RoleID uuid.UUID

+ Scope types.ScopeFilter

+ UserID uuid.UUID

+ func (AssignRoleInput) Type() string

+ func (input AssignRoleInput) Validate() error

+ type BulkUserTransitionCommand struct

+ func NewBulkUserTransitionCommand(lifecycle *UserLifecycleTransitionCommand) *BulkUserTransitionCommand

+ func (c *BulkUserTransitionCommand) Execute(ctx context.Context, input BulkUserTransitionInput) error

+ type BulkUserTransitionInput struct

+ Actor types.ActorRef

+ Metadata map[string]any

+ Reason string

+ Results *[]BulkUserTransitionResult

+ Scope types.ScopeFilter

+ StopOnError bool

+ Target types.LifecycleState

+ UserIDs []uuid.UUID

+ func (BulkUserTransitionInput) Type() string

+ func (input BulkUserTransitionInput) Validate() error

+ type BulkUserTransitionResult struct

+ Err error

+ UserID uuid.UUID

+ type CreateRoleCommand struct

+ func NewCreateRoleCommand(registry types.RoleRegistry, guard scope.Guard) *CreateRoleCommand

+ func (c *CreateRoleCommand) Execute(ctx context.Context, input CreateRoleInput) error

+ type CreateRoleInput struct

+ Actor types.ActorRef

+ Description string

+ IsSystem bool

+ Name string

+ Permissions []string

+ Result *types.RoleDefinition

+ Scope types.ScopeFilter

+ func (CreateRoleInput) Type() string

+ func (input CreateRoleInput) Validate() error

+ type DeleteRoleCommand struct

+ func NewDeleteRoleCommand(registry types.RoleRegistry, guard scope.Guard) *DeleteRoleCommand

+ func (c *DeleteRoleCommand) Execute(ctx context.Context, input DeleteRoleInput) error

+ type DeleteRoleInput struct

+ Actor types.ActorRef

+ RoleID uuid.UUID

+ Scope types.ScopeFilter

+ func (DeleteRoleInput) Type() string

+ func (input DeleteRoleInput) Validate() error

+ type InviteCommandConfig struct

+ Activity types.ActivitySink

+ Clock types.Clock

+ Hooks types.Hooks

+ IDGen types.IDGenerator

+ Logger types.Logger

+ Repository types.AuthRepository

+ ScopeGuard scope.Guard

+ TokenTTL time.Duration

+ type LifecycleCommandConfig struct

+ Activity types.ActivitySink

+ Clock types.Clock

+ Hooks types.Hooks

+ Logger types.Logger

+ Policy types.TransitionPolicy

+ Repository types.AuthRepository

+ ScopeGuard scope.Guard

+ type PasswordResetCommandConfig struct

+ Activity types.ActivitySink

+ Clock types.Clock

+ Hooks types.Hooks

+ Logger types.Logger

+ Repository types.AuthRepository

+ ScopeGuard scope.Guard

+ type PreferenceCommandConfig struct

+ Clock types.Clock

+ Hooks types.Hooks

+ Repository types.PreferenceRepository

+ ScopeGuard scope.Guard

+ type PreferenceDeleteCommand struct

+ func NewPreferenceDeleteCommand(cfg PreferenceCommandConfig) *PreferenceDeleteCommand

+ func (c *PreferenceDeleteCommand) Execute(ctx context.Context, input PreferenceDeleteInput) error

+ type PreferenceDeleteInput struct

+ Actor types.ActorRef

+ Key string

+ Level types.PreferenceLevel

+ Scope types.ScopeFilter

+ UserID uuid.UUID

+ func (PreferenceDeleteInput) Type() string

+ func (input PreferenceDeleteInput) Validate() error

+ type PreferenceUpsertCommand struct

+ func NewPreferenceUpsertCommand(cfg PreferenceCommandConfig) *PreferenceUpsertCommand

+ func (c *PreferenceUpsertCommand) Execute(ctx context.Context, input PreferenceUpsertInput) error

+ type PreferenceUpsertInput struct

+ Actor types.ActorRef

+ Key string

+ Level types.PreferenceLevel

+ Result *types.PreferenceRecord

+ Scope types.ScopeFilter

+ UserID uuid.UUID

+ Value map[string]any

+ func (PreferenceUpsertInput) Type() string

+ func (input PreferenceUpsertInput) Validate() error

+ type ProfileCommandConfig struct

+ Clock types.Clock

+ Hooks types.Hooks

+ Repository types.ProfileRepository

+ ScopeGuard scope.Guard

+ type ProfileUpsertCommand struct

+ func NewProfileUpsertCommand(cfg ProfileCommandConfig) *ProfileUpsertCommand

+ func (c *ProfileUpsertCommand) Execute(ctx context.Context, input ProfileUpsertInput) error

+ type ProfileUpsertInput struct

+ Actor types.ActorRef

+ Patch types.ProfilePatch

+ Result *types.UserProfile

+ Scope types.ScopeFilter

+ UserID uuid.UUID

+ func (ProfileUpsertInput) Type() string

+ func (input ProfileUpsertInput) Validate() error

+ type UnassignRoleCommand struct

+ func NewUnassignRoleCommand(registry types.RoleRegistry, guard scope.Guard) *UnassignRoleCommand

+ func (c *UnassignRoleCommand) Execute(ctx context.Context, input UnassignRoleInput) error

+ type UnassignRoleInput struct

+ Actor types.ActorRef

+ RoleID uuid.UUID

+ Scope types.ScopeFilter

+ UserID uuid.UUID

+ func (UnassignRoleInput) Type() string

+ func (input UnassignRoleInput) Validate() error

+ type UpdateRoleCommand struct

+ func NewUpdateRoleCommand(registry types.RoleRegistry, guard scope.Guard) *UpdateRoleCommand

+ func (c *UpdateRoleCommand) Execute(ctx context.Context, input UpdateRoleInput) error

+ type UpdateRoleInput struct

+ Actor types.ActorRef

+ Description string

+ IsSystem bool

+ Name string

+ Permissions []string

+ Result *types.RoleDefinition

+ RoleID uuid.UUID

+ Scope types.ScopeFilter

+ func (UpdateRoleInput) Type() string

+ func (input UpdateRoleInput) Validate() error

+ type UserInviteCommand struct

+ func NewUserInviteCommand(cfg InviteCommandConfig) *UserInviteCommand

+ func (c *UserInviteCommand) Execute(ctx context.Context, input UserInviteInput) error

+ type UserInviteInput struct

+ Actor types.ActorRef

+ Email string

+ FirstName string

+ LastName string

+ Metadata map[string]any

+ Result *UserInviteResult

+ Role string

+ Scope types.ScopeFilter

+ func (UserInviteInput) Type() string

+ func (input UserInviteInput) Validate() error

+ type UserInviteResult struct

+ ExpiresAt time.Time

+ Token string

+ User *types.AuthUser

+ type UserLifecycleTransitionCommand struct

+ func NewUserLifecycleTransitionCommand(cfg LifecycleCommandConfig) *UserLifecycleTransitionCommand

+ func (c *UserLifecycleTransitionCommand) Execute(ctx context.Context, input UserLifecycleTransitionInput) error

+ type UserLifecycleTransitionInput struct

+ Actor types.ActorRef

+ Metadata map[string]any

+ Reason string

+ Result *UserLifecycleTransitionResult

+ Scope types.ScopeFilter

+ Target types.LifecycleState

+ UserID uuid.UUID

+ func (UserLifecycleTransitionInput) Describe() string

+ func (UserLifecycleTransitionInput) Type() string

+ func (input UserLifecycleTransitionInput) Validate() error

+ type UserLifecycleTransitionResult struct

+ User *types.AuthUser

+ type UserPasswordResetCommand struct

+ func NewUserPasswordResetCommand(cfg PasswordResetCommandConfig) *UserPasswordResetCommand

+ func (c *UserPasswordResetCommand) Execute(ctx context.Context, input UserPasswordResetInput) error

+ type UserPasswordResetInput struct

+ Actor types.ActorRef

+ NewPasswordHash string

+ Result *UserPasswordResetResult

+ Scope types.ScopeFilter

+ UserID uuid.UUID

+ func (UserPasswordResetInput) Type() string

+ func (input UserPasswordResetInput) Validate() error

+ type UserPasswordResetResult struct

+ User *types.AuthUser

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