accountinterfaces

package

v0.0.0-...-5cbc45b Latest Latest Go to latest Published: Apr 3, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/reearth/reearthx

Links

Open Source Insights

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrOperationDenied error = rerror.NewE(i18n.T("operation denied"))
	ErrInvalidOperator error = rerror.NewE(i18n.T("invalid operator"))
)

View Source

var (
	ErrUserInvalidPasswordConfirmation = rerror.NewE(i18n.T("invalid password confirmation"))
	ErrUserInvalidPasswordReset        = rerror.NewE(i18n.T("invalid password reset request"))
	ErrUserInvalidLang                 = rerror.NewE(i18n.T("invalid lang"))
	ErrSignupInvalidSecret             = rerror.NewE(i18n.T("invalid secret"))
	ErrInvalidUserEmail                = rerror.NewE(i18n.T("invalid email"))
	ErrNotVerifiedUser                 = rerror.NewE(i18n.T("not verified user"))
	ErrInvalidEmailOrPassword          = rerror.NewE(i18n.T("invalid email or password"))
	ErrUserAlreadyExists               = rerror.NewE(i18n.T("user already exists"))
)

View Source

var (
	ErrOwnerCannotLeaveTheWorkspace = rerror.NewE(i18n.T("owner user cannot leave from the workspace"))
	ErrCannotChangeOwnerRole        = rerror.NewE(i18n.T("cannot change the role of the workspace owner"))
	ErrCannotDeleteWorkspace        = rerror.NewE(i18n.T("cannot delete workspace because at least one project is left"))
	ErrWorkspaceWithProjects        = rerror.NewE(i18n.T("target workspace still has some project"))
)

Functions ¶

This section is empty.

Types ¶

type GetUserByCredentials ¶

type GetUserByCredentials struct {
	Email    string
	Password string
}

type SignupOIDCParam ¶

type SignupOIDCParam struct {
	AccessToken string
	Issuer      string
	Sub         string
	Email       string
	Name        string
	Secret      *string
	User        SignupUserParam
}

type SignupParam ¶

type SignupParam struct {
	Email       string
	Name        string
	Password    string
	Secret      *string
	Lang        *language.Tag
	Theme       *user.Theme
	UserID      *user.ID
	WorkspaceID *workspace.ID
}

type SignupUserParam ¶

type SignupUserParam struct {
	UserID      *user.ID
	Lang        *language.Tag
	Theme       *user.Theme
	WorkspaceID *workspace.ID
}

type UpdateMeParam ¶

type UpdateMeParam struct {
	Name                 *string
	Email                *string
	Lang                 *language.Tag
	Theme                *user.Theme
	Password             *string
	PasswordConfirmation *string
}

type User ¶

type User interface {
	UserQuery

	// sign up
	Signup(context.Context, SignupParam) (*user.User, error)
	SignupOIDC(context.Context, SignupOIDCParam) (*user.User, error)

	// editing me
	UpdateMe(context.Context, UpdateMeParam, *accountusecase.Operator) (*user.User, error)
	RemoveMyAuth(context.Context, string, *accountusecase.Operator) (*user.User, error)
	DeleteMe(context.Context, user.ID, *accountusecase.Operator) error

	// built-in auth server
	CreateVerification(context.Context, string) error
	VerifyUser(context.Context, string) (*user.User, error)
	StartPasswordReset(context.Context, string) error
	PasswordReset(context.Context, string, string) error
}

type UserFindOrCreateParam ¶

type UserFindOrCreateParam struct {
	Sub   string
	ISS   string
	Token string
}

type UserQuery ¶

type UserQuery interface {
	FetchByID(context.Context, user.IDList) (user.List, error)
	FetchBySub(context.Context, string) (*user.User, error)
	SearchUser(context.Context, string) (*user.Simple, error)
}

type Workspace ¶

type Workspace interface {
	Fetch(context.Context, workspace.IDList, *accountusecase.Operator) (workspace.List, error)
	FindByUser(context.Context, user.ID, *accountusecase.Operator) (workspace.List, error)
	Create(context.Context, string, user.ID, *accountusecase.Operator) (*workspace.Workspace, error)
	Update(context.Context, workspace.ID, string, *accountusecase.Operator) (*workspace.Workspace, error)
	AddUserMember(context.Context, workspace.ID, map[user.ID]workspace.Role, *accountusecase.Operator) (*workspace.Workspace, error)
	AddIntegrationMember(context.Context, workspace.ID, workspace.IntegrationID, workspace.Role, *accountusecase.Operator) (*workspace.Workspace, error)
	UpdateUserMember(context.Context, workspace.ID, user.ID, workspace.Role, *accountusecase.Operator) (*workspace.Workspace, error)
	UpdateIntegration(context.Context, workspace.ID, workspace.IntegrationID, workspace.Role, *accountusecase.Operator) (*workspace.Workspace, error)
	RemoveUserMember(context.Context, workspace.ID, user.ID, *accountusecase.Operator) (*workspace.Workspace, error)
	RemoveIntegration(context.Context, workspace.ID, workspace.IntegrationID, *accountusecase.Operator) (*workspace.Workspace, error)
	Remove(context.Context, workspace.ID, *accountusecase.Operator) error
}

Source Files ¶

View all Source files

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