image
Akan.js
Docs
DocsConventionsReferencesCheatsheet
English
image
Akan.js
Akan.js v2 docs are now available.View the v1 docs
DocsConventionsReferencesCheatsheet
Released under the MIT License
Official Akan.js Consulting onAkansoft
Copyright © 2026 Akan.js All rights reserved.
System managed bybassman
General
• Authorization
• Schema Design
• Edge Computing
• File Management
• Single Sign-On
• DataList & Enum
Interface
• CRUD
• Endpoint
• Form
Observability
• Logging
• Dependency Injection
• Error Handling
• Metrics
Performance
• Caching
• Image Optimization
• Lazy Loading
• Querying
• Queueing
• Realtime
Development
• Documentation
• Script
• Docker
• Kubernetes
• PWA
General
• Authorization
• Schema Design
• Edge Computing
• File Management
• Single Sign-On
• DataList & Enum
Interface
• CRUD
• Endpoint
• Form
Observability
• Logging
• Dependency Injection
• Error Handling
• Metrics
Performance
• Caching
• Image Optimization
• Lazy Loading
• Querying
• Queueing
• Realtime
Development
• Documentation
• Script
• Docker
• Kubernetes
• PWA
Next
Authorization

Constant Schema Docs

Akan can render schema definition tables and model relationship diagrams directly from ConstantRegistry.
Developer schema page
Printable schema definition
Constant Schema Docs
Database models, scalar models, enums, and relations from ConstantRegistry.
Database Models
1
Scalar Models
0
Enums
20
Relations
7
User
user
User is an public information of the user who uses the service. It can be displayed to other users.
User
Full
28 fields
KeyTypeRequiredField TypeRelationDefaultConstraintsEnumDescription
id
ID
IDRequiredproperty-null
-
-Unique ID value
createdAt
CreatedAt
DateRequiredproperty-null
-
-Data created time
updatedAt
UpdatedAt
DateRequiredproperty-null
-
-Data updated time
removedAt
RemovedAt
DateOptionalproperty-null
-
-Data removed time
nickname
Nickname
StringOptionalproperty-
maxlength 12
-Nickname of the user that is displayed to other users
image
Image
FileOptionalpropertyreferencenull
-
-Profile image of the user
images
Images
[File]Requiredpropertyreference[]
-
-Profile images of the user
appliedImages
Applied Images
[File]Requiredpropertyreference[]
-
-Applied images of the user
name
Name
StringOptionalhiddenselect:false-null
-
-Name of the user
agreePolicies
Agree Policies
[String]Optionalhiddenselect:false-[]
-
-Agreed policies of the user
discord
Discord
AnyOptionalhiddenselect:false-{}
-
-Discord information of the user
accountId
Account ID
StringOptionalhiddenselect:false-null
-
-Account ID of the user
password
Password
StringOptionalhiddenselect:false-null
-
-Password of the user
phone
Phone
StringOptionalhiddenselect:false-null
-
-Phone number of the user
notiInfo
Noti Info
NotiInfoOptionalhiddenselect:false-null
-
-Notification information of the user
imageNum
Image Number
IntOptionalhiddenselect:false-0
-
-Number of images of the user
encourageInfo
Encourage Info
EncourageInfoOptionalhiddenselect:false-[function]
-
-Encourage information of the user
restrictInfo
Restrict Info
RestrictInfoOptionalhiddenselect:false-null
-
-Restrict information of the user
leaveInfo
Leave Info
LeaveInfoOptionalhiddenselect:false-null
-
-Leave information of the user
verifies
Verifies
[String]Requiredproperty-[]
-
naverkakaogithubgoogleapplefacebookwalletpasswordphoneemail
Verification information of the user
roles
Roles
[String]Requiredproperty-["user"]
-
rootadminuserbusinessguest
Authorized roles of the user
playing
Playing
[String]Requiredproperty-[]
-
-Services that the user is playing
isOnline
Is Online
BooleanRequiredproperty-true
-
-Online status of the user
lastLoginAt
Last Login At
DateRequiredproperty-[function]
-
-Latest login time of the user
joinAt
Join At
DateOptionalproperty-null
-
-Join date of the user
profileStatus
Profile Status
StringRequiredproperty-prepare
-
activeprepareappliedapprovedreappliedfeaturedreservedrejected
Profile approval status of the user
badgeCount
Badge Count
IntRequiredproperty-0
-
-Badge count of the user
status
Status
StringRequiredproperty-prepare
-
prepareactivedormantrestricted
Status of the user
Enums
KeyRef NameTypeValuesUsed By
adminRoleadminRoleString
-
bannerStatusbannerStatusString
-
bannerTargetbannerTargetString
-
coordinateTypecoordinateTypeString
-
fileStatusfileStatusString
-
inquiryinquiryString
-
journeyjourneyString
-
leaveTypeleaveTypeString
-
linkTypelinkTypeString
-
notificationTypenotificationTypeString
-
notiLevelnotiLevelString
-
notiSettingnotiSettingString
-
periodTypeperiodTypeString
-
profileStatusprofileStatusString
user.profileStatususer.profileStatususer.profileStatus
responsiveresponsiveString
-
ssoTypessoTypeString
-
summaryStatussummaryStatusString
-
userRoleuserRoleString
user.rolesuser.roles
userStatususerStatusString
user.statususer.statususer.status
verifyverifyString
user.verifiesuser.verifies

Printable Definition

`Constant.Doc.Print` renders every selected variant and field inline, without tabs, collapse panels, modals, or diagram interactions.
Constant Schema Definition
Database models, scalar models, enums, and relations from ConstantRegistry.
Database Models
1
Scalar Models
0
Enums
20
Relations
7
User
user
User is an public information of the user who uses the service. It can be displayed to other users.
UserInput
Input
4 fields
KeyTypeRequiredField TypeRelationDefaultConstraintsEnumDescriptionDetail
nickname
Nickname
StringOptional
property
-maxlength 12-Nickname of the user that is displayed to other users-
image
Image
FileOptional
property
reference target: filenull--Profile image of the user-
images
Images
[File]Required
property
reference target: file[]--Profile images of the user-
appliedImages
Applied Images
[File]Required
property
reference target: file[]--Applied images of the user-
UserObject
Object
28 fields
KeyTypeRequiredField TypeRelationDefaultConstraintsEnumDescriptionDetail
id
ID
IDRequired
property
-null--Unique ID value-
createdAt
CreatedAt
DateRequired
property
-null--Data created time-
updatedAt
UpdatedAt
DateRequired
property
-null--Data updated time-
removedAt
RemovedAt
DateOptional
property
-null--Data removed time-
nickname
Nickname
StringOptional
property
-maxlength 12-Nickname of the user that is displayed to other users-
image
Image
FileOptional
property
reference target: filenull--Profile image of the user-
images
Images
[File]Required
property
reference target: file[]--Profile images of the user-
appliedImages
Applied Images
[File]Required
property
reference target: file[]--Applied images of the user-
name
Name
StringOptional
hidden
select:false
-null--Name of the user-
agreePolicies
Agree Policies
[String]Optional
hidden
select:false
-[]--Agreed policies of the user-
discord
Discord
AnyOptional
hidden
select:false
-{}--Discord information of the user-
accountId
Account ID
StringOptional
hidden
select:false
-null--Account ID of the user-
password
Password
StringOptional
hidden
select:false
-null--Password of the user-
phone
Phone
StringOptional
hidden
select:false
-null--Phone number of the user-
notiInfo
Noti Info
NotiInfoOptional
hidden
select:false
target: notiInfonull--Notification information of the user-
imageNum
Image Number
IntOptional
hidden
select:false
-0--Number of images of the user-
encourageInfo
Encourage Info
EncourageInfoOptional
hidden
select:false
target: encourageInfo[function]--Encourage information of the user-
restrictInfo
Restrict Info
RestrictInfoOptional
hidden
select:false
target: restrictInfonull--Restrict information of the user-
leaveInfo
Leave Info
LeaveInfoOptional
hidden
select:false
target: leaveInfonull--Leave information of the user-
verifies
Verifies
[String]Required
property
-[]-verify: naver, kakao, github, google, apple, facebook, wallet, password, phone, emailVerification information of the user-
roles
Roles
[String]Required
property
-["user"]-userRole: root, admin, user, business, guestAuthorized roles of the user-
playing
Playing
[String]Required
property
-[]--Services that the user is playing-
isOnline
Is Online
BooleanRequired
property
-true--Online status of the user-
lastLoginAt
Last Login At
DateRequired
property
-[function]--Latest login time of the user-
joinAt
Join At
DateOptional
property
-null--Join date of the user-
profileStatus
Profile Status
StringRequired
property
-prepare-profileStatus: active, prepare, applied, approved, reapplied, featured, reserved, rejectedProfile approval status of the user-
badgeCount
Badge Count
IntRequired
property
-0--Badge count of the user-
status
Status
StringRequired
property
-prepare-userStatus: prepare, active, dormant, restrictedStatus of the user-
User
Full
28 fields
KeyTypeRequiredField TypeRelationDefaultConstraintsEnumDescriptionDetail
id
ID
IDRequired
property
-null--Unique ID value-
createdAt
CreatedAt
DateRequired
property
-null--Data created time-
updatedAt
UpdatedAt
DateRequired
property
-null--Data updated time-
removedAt
RemovedAt
DateOptional
property
-null--Data removed time-
nickname
Nickname
StringOptional
property
-maxlength 12-Nickname of the user that is displayed to other users-
image
Image
FileOptional
property
reference target: filenull--Profile image of the user-
images
Images
[File]Required
property
reference target: file[]--Profile images of the user-
appliedImages
Applied Images
[File]Required
property
reference target: file[]--Applied images of the user-
name
Name
StringOptional
hidden
select:false
-null--Name of the user-
agreePolicies
Agree Policies
[String]Optional
hidden
select:false
-[]--Agreed policies of the user-
discord
Discord
AnyOptional
hidden
select:false
-{}--Discord information of the user-
accountId
Account ID
StringOptional
hidden
select:false
-null--Account ID of the user-
password
Password
StringOptional
hidden
select:false
-null--Password of the user-
phone
Phone
StringOptional
hidden
select:false
-null--Phone number of the user-
notiInfo
Noti Info
NotiInfoOptional
hidden
select:false
target: notiInfonull--Notification information of the user-
imageNum
Image Number
IntOptional
hidden
select:false
-0--Number of images of the user-
encourageInfo
Encourage Info
EncourageInfoOptional
hidden
select:false
target: encourageInfo[function]--Encourage information of the user-
restrictInfo
Restrict Info
RestrictInfoOptional
hidden
select:false
target: restrictInfonull--Restrict information of the user-
leaveInfo
Leave Info
LeaveInfoOptional
hidden
select:false
target: leaveInfonull--Leave information of the user-
verifies
Verifies
[String]Required
property
-[]-verify: naver, kakao, github, google, apple, facebook, wallet, password, phone, emailVerification information of the user-
roles
Roles
[String]Required
property
-["user"]-userRole: root, admin, user, business, guestAuthorized roles of the user-
playing
Playing
[String]Required
property
-[]--Services that the user is playing-
isOnline
Is Online
BooleanRequired
property
-true--Online status of the user-
lastLoginAt
Last Login At
DateRequired
property
-[function]--Latest login time of the user-
joinAt
Join At
DateOptional
property
-null--Join date of the user-
profileStatus
Profile Status
StringRequired
property
-prepare-profileStatus: active, prepare, applied, approved, reapplied, featured, reserved, rejectedProfile approval status of the user-
badgeCount
Badge Count
IntRequired
property
-0--Badge count of the user-
status
Status
StringRequired
property
-prepare-userStatus: prepare, active, dormant, restrictedStatus of the user-
LightUser
Light
10 fields
KeyTypeRequiredField TypeRelationDefaultConstraintsEnumDescriptionDetail
id
ID
IDRequired
property
-null--Unique ID value-
createdAt
CreatedAt
DateRequired
property
-null--Data created time-
updatedAt
UpdatedAt
DateRequired
property
-null--Data updated time-
removedAt
RemovedAt
DateOptional
property
-null--Data removed time-
image
Image
FileOptional
property
reference target: filenull--Profile image of the user-
nickname
Nickname
StringOptional
property
-maxlength 12-Nickname of the user that is displayed to other users-
playing
Playing
[String]Required
property
-[]--Services that the user is playing-
profileStatus
Profile Status
StringRequired
property
-prepare-profileStatus: active, prepare, applied, approved, reapplied, featured, reserved, rejectedProfile approval status of the user-
lastLoginAt
Last Login At
DateRequired
property
-[function]--Latest login time of the user-
status
Status
StringRequired
property
-prepare-userStatus: prepare, active, dormant, restrictedStatus of the user-
UserInsight
Insight
1 fields
KeyTypeRequiredField TypeRelationDefaultConstraintsEnumDescriptionDetail
count
user.count
IntRequired
property
-0accumulate-user.count.desc-
Enums
KeyRef NameTypeValuesDescriptionsUsed By
adminRoleadminRoleStringmanager, admin, superAdmin
manager: Manager
admin: Admin
superAdmin: Super Admin
-
bannerStatusbannerStatusStringactive, displaying
active: Active
displaying: Displaying
-
bannerTargetbannerTargetString_blank, _self
_blank: New tab
_self: Same tab
-
coordinateTypecoordinateTypeStringPoint
Point: Point
-
fileStatusfileStatusStringactive, uploading
active: Active
uploading: Uploading
-
inquiryinquiryStringwelcome, payable, waitPay, paid, morePayable, waitMorePay, inquired, concerned, concernedPayable, concernedWaitPay, ashed, vip, kicked
welcome: Welcome
payable: Payable
waitPay: Wait Pay
paid: Paid
morePayable: More Payable
waitMorePay: Wait More Pay
inquired: Inquired
concerned: Concerned
concernedPayable: Concerned Payable
concernedWaitPay: Concerned Wait Pay
ashed: Ashed
vip: VIP
kicked: Kicked
-
journeyjourneyStringwelcome, waiting, firstJoin, joined, leaving, leaved, returning, returned
welcome: Welcome
waiting: Waiting
firstJoin: First Join
joined: Joined
leaving: Leaving
leaved: Leaved
returning: Returning
returned: Returned
-
leaveTypeleaveTypeStringnoReply, comeback, unsatisfied, other
noReply: No Reply
comeback: Comeback
unsatisfied: Unsatisfied
other: Other
-
linkTypelinkTypeStringwebsite, twitter, discord, telegram, instagram, facebook, youtube, github, medium, linkedin, reddit, twitch, vimeo, weibo, wikipedia, app, email, other
website: Website
twitter: Twitter
discord: Discord
telegram: Telegram
instagram: Instagram
facebook: Facebook
youtube: YouTube
github: GitHub
medium: Medium
linkedin: LinkedIn
reddit: Reddit
twitch: Twitch
vimeo: Vimeo
weibo: Weibo
wikipedia: Wikipedia
app: App
email: Email
other: Other
-
notificationTypenotificationTypeStringtopic, token
topic: Topic
token: Token
-
notiLevelnotiLevelStringactionRequired, notice, essential, suggestion, advertise
actionRequired: Action Required
notice: Notice
essential: Essential
suggestion: Suggestion
advertise: Advertise
-
notiSettingnotiSettingStringdisagree, fewer, normal, block
disagree: Disagree
fewer: Fewer
normal: Normal
block: Block
-
periodTypeperiodTypeStringnon-periodic, active, hourly, daily, weekly, monthly
non-periodic: Non-periodic
active: Active
hourly: Hourly
daily: Daily
weekly: Weekly
monthly: Monthly
-
profileStatusprofileStatusStringactive, prepare, applied, approved, reapplied, featured, reserved, rejected
active: Active
prepare: Prepare
applied: Applied
approved: Approved
reapplied: Reapplied
featured: Featured
reserved: Reserved
rejected: Rejected
user.profileStatus (Object), user.profileStatus (Full), user.profileStatus (Light)
responsiveresponsiveStringxl, lg, md, sm, xs
xl: responsive.xl
lg: responsive.lg
md: responsive.md
sm: responsive.sm
xs: responsive.xs
-
ssoTypessoTypeStringnaver, kakao, github, google, apple, facebook
naver: ssoType.naver
kakao: ssoType.kakao
github: ssoType.github
google: ssoType.google
apple: ssoType.apple
facebook: ssoType.facebook
-
summaryStatussummaryStatusStringactive, archived
active: Active
archived: Archived
-
userRoleuserRoleStringroot, admin, user, business, guest
root: Root
admin: Admin
user: User
business: Business
guest: Guest
user.roles (Object), user.roles (Full)
userStatususerStatusStringprepare, active, dormant, restricted
prepare: Prepare
active: Active
dormant: Dormant
restricted: Restricted
user.status (Object), user.status (Full), user.status (Light)
verifyverifyStringnaver, kakao, github, google, apple, facebook, wallet, password, phone, email
naver: Naver
kakao: Kakao
github: Github
google: Google
apple: Apple
facebook: Facebook
wallet: Wallet
password: Password
phone: Phone
email: Email
user.verifies (Object), user.verifies (Full)
Constant Schema Docs
Generated Schema
Printable Definition