package
0.0.0-20240511025140-bf03555f9c45
Repository: https://github.com/luckyakbar/atec-api.git
Documentation: pkg.go.dev

# Packages

Package mock is a generated GoMock package.

# Functions

GetUserFromCtx get user from context.
NewResultGenerator factory to make image generator.
SetUserToCtx set user to context.

# Constants

NilKey is used to indicate that this value / cache is intended to be treated as nil and different from not found from cache.
list available roles.
list available roles.
list of all available task.
list of all available task.

# Structs

AccessToken represent access_tokens table.
AccountVerificationInput will be the request format to verify account pin.
Answer singular answer per question.
AuthUser represents all the necessary data to be passed on context.
ChangePasswordSession will hold the data saved to validate change password.
Email represent emails table structure from database.
FailedAccountVerificationResponse will be returned when pin varification is failed.
FindReadyToUseOutput output for find ready to use package.
FindUserResponse can be used to return the User data to API response.
GeneratedSDPackage will be used to define the generated SD package as the returned value as REST API responses.
GeneratedSDTemplate will be used to define the generated SD template as the returned value as REST API responses.
ImageResult will be the result of image generation.
InitiateResetPasswordOutput will be returned when initiate reset password is successfull.
InitiateSDTestInput input when initiating the sd test.
InitiateSDTestOutput output when initiating the sd test.
LogInInput input for log in process.
LogInOutput output of log in process.
LogOutInput input for log out process.
Pin represent "pins" table.
RegisterEmailInput input to register email.
ResetPasswordInput input for reset password process.
ResetPasswordResponse will be returned when reset password success.
SDAnswerAndValue sd answer and value.
SDPackage sd package.
SDQuestionAndAnswers sd question and answer.
SDResultImageGenerationOpts options to generate image for sd test result.
SDSubGroupDetail sd sub group detail.
SDTemplate define what the full SD test template will look like.
SDTemplateSubGroupDetail define what the details of every sub group used by this template.
SDTest the actual db table representation.
SDTestAnswer will hold total sd test answer.
SDTestGroupResult sd test result per group.
SDTestQuestion test question and the answer options.
SDTestResult will hold the total result of sd test.
SDTestStatistic will hold the structure of sd test statistic.
SearchPackageOutput output search sd package.
SearchSDPackageInput input to search sd package.
SearchSDTemplateInput input for searching SDTemplate input.
SearchSDTemplateOutput output for searching SD Template.
SearchUserInput input.
SearchUserOutput output.
SignUpInput will be the request format to sign up.
SignUpResponse will be the returned response format when success signup.
SpeechDelayPackage will represent speech delay only test packages on db table.
SpeechDelayTemplate will represent speech delay only test templates on db table.
StatsComponent will define what will be the statistic component.
SubmitSDTestInput input to submit sd test.
SubmitSDTestOutput output from submit sd test.
SuccessAccountVerificationResponse will be returned when pin varification is successfull.
TestAnswer will hold per group test answer.
User represent "users" table.
ViewHistoriesInput input.
ViewHistoriesOutput output from submit sd test.

# Interfaces

AccessTokenRepository access token repository.
AuthUsecase auth usecase.
Cacher :nodoc:.
EmailRepository represent the email's repository interface.
EmailUsecase represent the email's usecase interface.
PinRepository pin's repository.
SDPackageRepository interface for SD package repository.
SDPackageUsecase interface for SD package usecase.
SDResultImageGenerator interface.
SDTemplateRepository speech delay test template repository.
SDTemplateUsecase speech delay test template usecase.
SDTestRepository repository.
SDTestUsecase usecase.
UserRepository user's repository.
UserUsecase user's usecase.
WorkerClient is the interface for all worker client mainly to enqueue task.

# Type aliases

Role is enum for available role.
Task is the datatype for all background processor task.