package models

Import Path
	github.com/limanmys/render-engine/app/models (on go.dev)

Dependency Relation
	imports 7 packages, and imported by 10 packages

Involved Source Files

	    access_token.go
	    credentials.go
	    cron_job.go
	    extension.go
	    licence.go
	    oauth2_token.go
	    permission.go
	    php_command.go
	    queue.go
	    role_users.go
	    server.go
	    server_key.go
	    settings.go
	    token.go
	    user.go
Package-Level Type Names (total 18)

	/* sort by: alphabet | popularity */
	 type AccessToken (struct)
		AccessToken Structure of the personal access token

		Fields (total 9)
			CreatedAt string
			ID string
			IPRange string
			LastUsedAt string
			LastUsedIP string
			Name string
			Token string
			UpdatedAt string
			UserID string
		Methods (only one)
			( AccessToken) TableName() string
		Implements (at least one exported)
			 AccessToken : gorm.io/gorm/schema.Tabler

	 type CommandParams (struct)
		CommandParams structure of CommandParams object

		Fields (total 9)
			BaseURL string
			Extension string
			Locale string
			LogID string
			RequestData map[string]string
			Server string
			TargetFunction string
			Token string
			User string
		As Inputs Of (at least 2)
			func github.com/limanmys/render-engine/internal/sandbox.GenerateCommand(extension *Extension, credentials *Credentials, params *CommandParams) (string, error)
			func github.com/limanmys/render-engine/internal/sandbox.GetParams(extension *Extension, credentials *Credentials, params *CommandParams) (*Server, *User, map[string]string, error)

	 type Credentials (struct)
		Credentials type of credentials object

		Fields (total 4)
			Key string
				Certificate or password

			Port string
				Connection port

			Type string
				Type

			Username string
				Username

		As Outputs Of (at least 2)
			func KeyData.DecryptData(user *User, server *Server) *Credentials
			func github.com/limanmys/render-engine/internal/liman.GetCredentials(user *User, server *Server) (*Credentials, error)
		As Inputs Of (at least 2)
			func github.com/limanmys/render-engine/internal/sandbox.GenerateCommand(extension *Extension, credentials *Credentials, params *CommandParams) (string, error)
			func github.com/limanmys/render-engine/internal/sandbox.GetParams(extension *Extension, credentials *Credentials, params *CommandParams) (*Server, *User, map[string]string, error)

	 type CronJob (struct)

		Fields (total 14)
			BaseURL string
			CreatedAt time.Time
			Day int
			ExtensionID *uuid.UUID
			ID *uuid.UUID
			Message string
				// Last run message

			Output string
				// Last run output

			Payload string
			ServerID *uuid.UUID
			Status Status
				// Last run status

			Target string
			Time string
			UpdatedAt time.Time
			UserID *uuid.UUID
		Methods (total 4)
			( CronJob) TableName() string
			(*CronJob) UpdateAsDone(output string)
			(*CronJob) UpdateAsFailed(message string)
			(*CronJob) UpdateAsProcessing()
		Implements (at least one exported)
			 CronJob : gorm.io/gorm/schema.Tabler
		As Outputs Of (at least one exported)
			func NewCronJob() *CronJob
		As Inputs Of (at least one exported)
			func github.com/limanmys/render-engine/pkg/cron_jobs.RegisterAndRun(cj *CronJob) error

	 type Extension (struct)
		Extension Structure of the extension obj

		Fields (total 15)
			CreatedAt string
			Displays string
			ID string
			Icon string
			Issuer string
			Language string
			Name string
			Order int
			RequireKey string
			Service string
			SslPorts string
			Status string
			Support string
			UpdatedAt string
			Version string
		Methods (only one)
			( Extension) TableName() string
		Implements (at least one exported)
			 Extension : gorm.io/gorm/schema.Tabler
		As Outputs Of (at least one exported)
			func github.com/limanmys/render-engine/internal/liman.GetExtension(extension *Extension) (*Extension, error)
		As Inputs Of (at least 6)
			func github.com/limanmys/render-engine/internal/liman.GetExtension(extension *Extension) (*Extension, error)
			func github.com/limanmys/render-engine/internal/liman.GetExtensionJSON(extension *Extension) (map[string]any, error)
			func github.com/limanmys/render-engine/internal/liman.GetLicence(extension *Extension) (*Licence, error)
			func github.com/limanmys/render-engine/internal/liman.GetSettings(user *User, server *Server, extension *Extension) (map[string]string, error)
			func github.com/limanmys/render-engine/internal/sandbox.GenerateCommand(extension *Extension, credentials *Credentials, params *CommandParams) (string, error)
			func github.com/limanmys/render-engine/internal/sandbox.GetParams(extension *Extension, credentials *Credentials, params *CommandParams) (*Server, *User, map[string]string, error)

	 type KeyData (struct)

		Fields (total 3)
			ClientPassword string
			ClientUsername string
			KeyPort string
		Methods (only one)
			( KeyData) DecryptData(user *User, server *Server) *Credentials

	 type Licence (struct)
		Licence structure of Licence object

		Fields (total 5)
			CreatedAt string
			Data string
			ExtensionID string
			ID string
			UpdatedAt string
		Methods (only one)
			( Licence) TableName() string
		Implements (at least one exported)
			 Licence : gorm.io/gorm/schema.Tabler
		As Outputs Of (at least one exported)
			func github.com/limanmys/render-engine/internal/liman.GetLicence(extension *Extension) (*Licence, error)

	 type Oauth2Token (struct)

		Fields (total 6)
			AccessToken string
			ExpiresIn int
			RefreshExpiresIn int
			RefreshToken string
			TokenType string
			UserID string
		Methods (only one)
			( Oauth2Token) TableName() string
		Implements (at least one exported)
			 Oauth2Token : gorm.io/gorm/schema.Tabler
		As Outputs Of (at least one exported)
			func github.com/limanmys/render-engine/internal/auth.GetOauth2Token(user_id string) (*Oauth2Token, error)
		As Inputs Of (at least one exported)
			func github.com/limanmys/render-engine/internal/auth.RefreshToken(token *Oauth2Token) error

	 type Operation string (basic type)

		As Types Of (total 4)
			const OperationCreate
			const OperationInstall
			const OperationReport
			const OperationUpdate

	 type Permission (struct)
		Permission structure of Permission object

		Fields (total 10)
			Blame string
			CreatedAt string
			Extra string
			ID string
			Key string
			MorphID string
			MorphType string
			Type string
			UpdatedAt string
			Value string
		Methods (only one)
			( Permission) TableName() string
		Implements (at least one exported)
			 Permission : gorm.io/gorm/schema.Tabler

	 type Queue (struct)
		Queue structure of Queue object

		Fields (total 8)
			CreatedAt time.Time
			Data gormjsonb.JSONB
			Error string
			ID string
			Path string
			Status Status
			Type Operation
			UpdatedAt time.Time
		Methods (total 6)
			(*Queue) BeforeCreate(tx *gorm.DB) (err error)
				Fill ID of Queue object with UUID beforeCreate

			(*Queue) BeforeUpdate(tx *gorm.DB) (err error)
			( Queue) TableName() string
			(*Queue) UpdateAsDone(path string)
			(*Queue) UpdateError(err string)
			(*Queue) UpdateStatus(status Status)
		Implements (at least 3)
			*Queue : gorm.io/gorm/callbacks.BeforeCreateInterface
			*Queue : gorm.io/gorm/callbacks.BeforeUpdateInterface
			 Queue : gorm.io/gorm/schema.Tabler

	 type RoleUsers (struct)
		RoleUsers structure of Role Users pivot table object

		Fields (total 6)
			CreatedAt string
			ID string
			RoleID string
			Type string
			UpdatedAt string
			UserID string
		Methods (only one)
			( RoleUsers) TableName() string
		Implements (at least one exported)
			 RoleUsers : gorm.io/gorm/schema.Tabler

	 type Server (struct)
		ServerModel Structure of the server obj

		Fields (total 12)
			ControlPort string
			CreatedAt string
			Enabled string
			ID string
			IPAddress string
			KeyPort int
			Name string
			Os string
			SharedKey int
			Type string
			UpdatedAt string
			UserID string
		Methods (only one)
			( Server) TableName() string
		Implements (at least one exported)
			 Server : gorm.io/gorm/schema.Tabler
		As Outputs Of (at least 2)
			func github.com/limanmys/render-engine/internal/liman.GetServer(server *Server) (*Server, error)
			func github.com/limanmys/render-engine/internal/sandbox.GetParams(extension *Extension, credentials *Credentials, params *CommandParams) (*Server, *User, map[string]string, error)
		As Inputs Of (at least 4)
			func KeyData.DecryptData(user *User, server *Server) *Credentials
			func github.com/limanmys/render-engine/internal/liman.GetCredentials(user *User, server *Server) (*Credentials, error)
			func github.com/limanmys/render-engine/internal/liman.GetServer(server *Server) (*Server, error)
			func github.com/limanmys/render-engine/internal/liman.GetSettings(user *User, server *Server, extension *Extension) (map[string]string, error)

	 type ServerKey (struct)
		ServerKey Structure of the server keys

		Fields (total 7)
			CreatedAt string
			Data string
			ID string
			ServerID string
			Type string
			UpdatedAt string
			UserID string
		Methods (only one)
			( ServerKey) TableName() string
		Implements (at least one exported)
			 ServerKey : gorm.io/gorm/schema.Tabler

	 type Settings (struct)
		Settings structure of Settings object

		Fields (total 7)
			CreatedAt string
			ID string
			Name string
			ServerID string
			UpdatedAt string
			UserID string
			Value string
		Methods (total 2)
			(*Settings) BeforeCreate(tx *gorm.DB) error
			( Settings) TableName() string
		Implements (at least 2)
			*Settings : gorm.io/gorm/callbacks.BeforeCreateInterface
			 Settings : gorm.io/gorm/schema.Tabler

	 type Status string (basic type)

		As Inputs Of (at least one exported)
			func (*Queue).UpdateStatus(status Status)
		As Types Of (total 4)
			const StatusDone
			const StatusFailed
			const StatusPending
			const StatusProcessing

	 type Token (struct)
		TokenModel Structure of the tokens tableD

		Fields (total 5)
			CreatedAt string
			ID string
			Token string
			UpdatedAt string
			UserID string
		Methods (only one)
			( Token) TableName() string
		Implements (at least one exported)
			 Token : gorm.io/gorm/schema.Tabler

	 type User (struct)
		UserModel Structure of the users table

		Fields (total 13)
			AuthType string
			CreatedAt string
			Email string
			ForceChange bool
			ID string
			LastLoginAt string
			LastLoginIP string
			Name string
			ObjectGUID string
			Password string
			RememberToken string
			Status int
			UpdatedAt string
		Methods (only one)
			( User) TableName() string
		Implements (at least one exported)
			 User : gorm.io/gorm/schema.Tabler
		As Outputs Of (at least 2)
			func github.com/limanmys/render-engine/internal/liman.GetUser(user *User) (*User, error)
			func github.com/limanmys/render-engine/internal/sandbox.GetParams(extension *Extension, credentials *Credentials, params *CommandParams) (*Server, *User, map[string]string, error)
		As Inputs Of (at least 6)
			func KeyData.DecryptData(user *User, server *Server) *Credentials
			func github.com/limanmys/render-engine/internal/liman.GetCredentials(user *User, server *Server) (*Credentials, error)
			func github.com/limanmys/render-engine/internal/liman.GetObjectPermissions(user *User) ([]string, error)
			func github.com/limanmys/render-engine/internal/liman.GetPermissions(user *User, extFilter string) ([]string, map[string]string, error)
			func github.com/limanmys/render-engine/internal/liman.GetSettings(user *User, server *Server, extension *Extension) (map[string]string, error)
			func github.com/limanmys/render-engine/internal/liman.GetUser(user *User) (*User, error)


Package-Level Functions (only one)

	 func NewCronJob() *CronJob
Package-Level Constants (total 8)

	const OperationCreate Operation = "create"
	const OperationInstall Operation = "install"
	const OperationReport Operation = "report"
	const OperationUpdate Operation = "update"
	const StatusDone Status = "done"
	const StatusFailed Status = "failed"
	const StatusPending Status = "pending"
	const StatusProcessing Status = "processing"

The pages are generated with Golds v0.6.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.