weseek__growi/packages/core/src/interfaces/user.ts

import type { IAccessToken } from './access-token';
import type { IAttachment } from './attachment';
import type { Ref } from './common';
import type { HasObjectId } from './has-object-id';
import type { Lang } from './lang';

export type IUser = {
  name: string,
  username: string,
  email: string,
  password: string,
  image?: string, // for backward conpatibility
  imageAttachment?: Ref<IAttachment>,
  imageUrlCached: string,
  isGravatarEnabled: boolean,
  admin: boolean,
  readOnly: boolean,
  apiToken?: string,
  accessToken?: Ref<IAccessToken>,
  isEmailPublished: boolean,
  isInvitationEmailSended: boolean,
  lang: Lang,
  slackMemberId?: string,
  createdAt: Date,
  lastLoginAt?: Date,
  introduction: string,
  status: IUserStatus,
  isQuestionnaireEnabled: boolean,
}

export type IUserGroupRelation = {
  relatedGroup: Ref<IUserGroup>,
  relatedUser: Ref<IUser>,
  createdAt: Date,
}

export type IUserGroup = {
  name: string;
  createdAt: Date;
  description: string;
  parent: Ref<IUserGroup> | null;
}

export const USER_STATUS = {
  REGISTERED: 1,
  ACTIVE: 2,
  SUSPENDED: 3,
  DELETED: 4,
  INVITED: 5,
} as const;
export type IUserStatus = typeof USER_STATUS[keyof typeof USER_STATUS]

export type IUserHasId = IUser & HasObjectId;
export type IUserGroupHasId = IUserGroup & HasObjectId;
export type IUserGroupRelationHasId = IUserGroupRelation & HasObjectId;

export type IAdminExternalAccount<P> = {
  _id: string,
  providerType: P,
  accountId: string,
  user: IUser,
  createdAt: Date,
}