weseek__growi/packages/app/src/interfaces/activity.ts

import { Ref } from './common';
import { HasObjectId } from './has-object-id';
import { IUser } from './user';

// Model
const MODEL_PAGE = 'Page';
const MODEL_COMMENT = 'Comment';

// Action
const ACTION_UNSETTLED = 'UNSETTLED';
const ACTION_REGISTRATION_SUCCESS = 'REGISTRATION_SUCCESS';
const ACTION_LOGIN_SUCCESS = 'LOGIN_SUCCESS';
const ACTION_LOGIN_FAILURE = 'LOGIN_FAILURE';
const ACTION_LOGOUT = 'LOGOUT';
const ACTION_USER_PERSONAL_SETTINGS_UPDATE = 'USER_PERSONAL_SETTINGS_UPDATE';
const ACTION_USER_IMAGE_TYPE_UPDATE = 'USER_IMAGE_TYPE_UPDATE';
const ACTION_USER_LDAP_ACCOUNT_ASSOCIATE = 'USER_LDAP_ACCOUNT_ASSOCIATE';
const ACTION_USER_LDAP_ACCOUNT_DISCONNECT = 'USER_LDAP_ACCOUNT_DISCONNECT';
const ACTION_USER_PASSWORD_UPDATE = 'USER_PASSWORD_UPDATE';
const ACTION_USER_API_TOKEN_UPDATE = 'USER_API_TOKEN_UPDATE';
const ACTION_USER_EDITOR_SETTINGS_UPDATE = 'USER_EDITOR_SETTINGS_UPDATE';
const ACTION_USER_IN_APP_NOTIFICATION_SETTINGS_UPDATE = 'USER_IN_APP_NOTIFICATION_SETTINGS_UPDATE';
const ACTION_PAGE_VIEW = 'PAGE_VIEW';
const ACTION_PAGE_LIKE = 'PAGE_LIKE';
const ACTION_PAGE_UNLIKE = 'PAGE_UNLIKE';
const ACTION_PAGE_BOOKMARK = 'PAGE_BOOKMARK';
const ACTION_PAGE_UNBOOKMARK = 'PAGE_UNBOOKMARK';
const ACTION_PAGE_CREATE = 'PAGE_CREATE';
const ACTION_PAGE_UPDATE = 'PAGE_UPDATE';
const ACTION_PAGE_RENAME = 'PAGE_RENAME';
const ACTION_PAGE_DUPLICATE = 'PAGE_DUPLICATE';
const ACTION_PAGE_DELETE = 'PAGE_DELETE';
const ACTION_PAGE_DELETE_COMPLETELY = 'PAGE_DELETE_COMPLETELY';
const ACTION_PAGE_REVERT = 'PAGE_REVERT';
const ACTION_PAGE_SUBSCRIBE = 'PAGE_SUBSCRIBE';
const ACTION_PAGE_UNSUBSCRIBE = 'ACTION_PAGE_UNSUBSCRIBE';
const ACTION_COMMENT_CREATE = 'COMMENT_CREATE';
const ACTION_COMMENT_UPDATE = 'COMMENT_UPDATE';
const ACTION_COMMENT_REMOVE = 'COMMENT_REMOVE';
const ACTION_ADMIN_APP_SETTINGS_UPDATE = 'ADMIN_APP_SETTING_UPDATE';
const ACTION_ADMIN_SITE_URL_UPDATE = 'ADMIN_SITE_URL_UPDATE';
const ACTION_ADMIN_MAIL_SMTP_UPDATE = 'ADMIN_MAIL_SMTP_UPDATE';
const ACTION_ADMIN_MAIL_SES_UPDATE = 'ADMIN_MAIL_SES_UPDATE';
const ACTION_ADMIN_MAIL_TEST_SUBMIT = 'ADMIN_MAIL_TEST_SUBMIT ';
const ACTION_ADMIN_FILE_UPLOAD_CONFIG_UPDATE = 'ADMIN_FILE_UPLOAD_CONFIG_UPDATE';
const ACTION_ADMIN_PLUGIN_UPDATE = 'ADMIN_PLUGIN_UPDATE';
const ACTION_ADMIN_MAINTENANCEMODE_ENABLED = 'ADMIN_MAINTENANCEMODE_ENABLED';
const ACTION_ADMIN_MAINTENANCEMODE_DISABLED = 'ADMIN_MAINTENANCEMODE_DISABLED';
const ACTION_ADMIN_SECURITY_SETTINGS_UPDATE = 'ADMIN_SECURITY_SETTINGS_UPDATE';
const ACTION_ADMIN_LINE_BREAK_UPDATE = 'ADMIN_LINE_BREAK_UPDATE';
const ACTION_ADMIN_LAYOUT_UPDATE = 'ADMIN_LAYOUT_UPDATE';
const ACTION_ADMIN_ARCHIVE_DATA_UPLOAD = 'ADMIN_ARCHIVE_DATA_UPLOAD';
const ACTION_ADMIN_ARCHIVE_DATA_CREATE = 'ADMIN_ARCHIVE_DATA_CREATE';
const ACTION_ADMIN_USER_NOTIFICATION_SETTINGS_ADD = 'ADMIN_USER_NOTIFICATION_SETTINGS_ADD';
const ACTION_ADMIN_SLACK_WORKSPACE_CREATE = 'ADMIN_SLACK_WORKSPACE_CREATE';
const ACTION_ADMIN_SLACK_CONFIGURATION_SETTING_UPDATE = 'ACTION_ADMIN_SLACK_CONFIGURATION_SETTING_UPDATE';
const ACTION_ADMIN_USERS_INVITE = 'ADMIN_USERS_INVITE';
const ACTION_ADMIN_USER_GROUP_CREATE = 'ADMIN_USER_GROUP_CREATE';
const ACTION_ADMIN_SEARCH_INDICES_NORMALIZE = 'ADMIN_SEARCH_INDICES_NORMALIZE';
const ACTION_ADMIN_SEARCH_INDICES_REBUILD = 'ADMIN_SEARCH_INDICES_REBUILD';


export const SupportedTargetModel = {
  MODEL_PAGE,
} as const;

export const SupportedEventModel = {
  MODEL_COMMENT,
} as const;

export const SupportedAction = {
  ACTION_UNSETTLED,
  ACTION_REGISTRATION_SUCCESS,
  ACTION_LOGIN_SUCCESS,
  ACTION_LOGIN_FAILURE,
  ACTION_LOGOUT,
  ACTION_USER_PERSONAL_SETTINGS_UPDATE,
  ACTION_USER_IMAGE_TYPE_UPDATE,
  ACTION_USER_LDAP_ACCOUNT_ASSOCIATE,
  ACTION_USER_LDAP_ACCOUNT_DISCONNECT,
  ACTION_USER_PASSWORD_UPDATE,
  ACTION_USER_API_TOKEN_UPDATE,
  ACTION_USER_EDITOR_SETTINGS_UPDATE,
  ACTION_USER_IN_APP_NOTIFICATION_SETTINGS_UPDATE,
  ACTION_PAGE_VIEW,
  ACTION_PAGE_LIKE,
  ACTION_PAGE_UNLIKE,
  ACTION_PAGE_BOOKMARK,
  ACTION_PAGE_UNBOOKMARK,
  ACTION_PAGE_CREATE,
  ACTION_PAGE_UPDATE,
  ACTION_PAGE_RENAME,
  ACTION_PAGE_DUPLICATE,
  ACTION_PAGE_DELETE,
  ACTION_PAGE_DELETE_COMPLETELY,
  ACTION_PAGE_REVERT,
  ACTION_PAGE_SUBSCRIBE,
  ACTION_PAGE_UNSUBSCRIBE,
  ACTION_COMMENT_CREATE,
  ACTION_COMMENT_UPDATE,
  ACTION_COMMENT_REMOVE,
  ACTION_ADMIN_APP_SETTINGS_UPDATE,
  ACTION_ADMIN_SITE_URL_UPDATE,
  ACTION_ADMIN_MAIL_SMTP_UPDATE,
  ACTION_ADMIN_MAIL_SES_UPDATE,
  ACTION_ADMIN_MAIL_TEST_SUBMIT,
  ACTION_ADMIN_FILE_UPLOAD_CONFIG_UPDATE,
  ACTION_ADMIN_PLUGIN_UPDATE,
  ACTION_ADMIN_MAINTENANCEMODE_ENABLED,
  ACTION_ADMIN_MAINTENANCEMODE_DISABLED,
  ACTION_ADMIN_SECURITY_SETTINGS_UPDATE,
  ACTION_ADMIN_LINE_BREAK_UPDATE,
  ACTION_ADMIN_LAYOUT_UPDATE,
  ACTION_ADMIN_ARCHIVE_DATA_UPLOAD,
  ACTION_ADMIN_ARCHIVE_DATA_CREATE,
  ACTION_ADMIN_USER_NOTIFICATION_SETTINGS_ADD,
  ACTION_ADMIN_SLACK_WORKSPACE_CREATE,
  ACTION_ADMIN_SLACK_CONFIGURATION_SETTING_UPDATE,
  ACTION_ADMIN_USERS_INVITE,
  ACTION_ADMIN_USER_GROUP_CREATE,
  ACTION_ADMIN_SEARCH_INDICES_NORMALIZE,
  ACTION_ADMIN_SEARCH_INDICES_REBUILD,
} as const;

// Action required for notification
export const EssentialActionGroup = {
  ACTION_PAGE_LIKE,
  ACTION_PAGE_BOOKMARK,
  ACTION_PAGE_UPDATE,
  ACTION_PAGE_RENAME,
  ACTION_PAGE_DUPLICATE,
  ACTION_PAGE_DELETE,
  ACTION_PAGE_DELETE_COMPLETELY,
  ACTION_PAGE_REVERT,
  ACTION_COMMENT_CREATE,
} as const;

export const ActionGroupSize = {
  Small: 'SMALL',
  Medium: 'MEDIUM',
  Large: 'LARGE',
} as const;

export const SmallActionGroup = {
  ACTION_LOGIN_SUCCESS,
  ACTION_LOGIN_FAILURE,
  ACTION_LOGOUT,
  ACTION_PAGE_CREATE,
  ACTION_PAGE_DELETE,
} as const;

// SmallActionGroup + Action by all General Users - PAGE_VIEW
export const MediumActionGroup = {
  ...SmallActionGroup,
  ACTION_USER_PERSONAL_SETTINGS_UPDATE,
  ACTION_USER_IMAGE_TYPE_UPDATE,
  ACTION_USER_LDAP_ACCOUNT_ASSOCIATE,
  ACTION_USER_LDAP_ACCOUNT_DISCONNECT,
  ACTION_USER_PASSWORD_UPDATE,
  ACTION_USER_API_TOKEN_UPDATE,
  ACTION_USER_EDITOR_SETTINGS_UPDATE,
  ACTION_USER_IN_APP_NOTIFICATION_SETTINGS_UPDATE,
  ACTION_PAGE_LIKE,
  ACTION_PAGE_UNLIKE,
  ACTION_PAGE_BOOKMARK,
  ACTION_PAGE_UNBOOKMARK,
  ACTION_PAGE_CREATE,
  ACTION_PAGE_UPDATE,
  ACTION_PAGE_RENAME,
  ACTION_PAGE_DUPLICATE,
  ACTION_PAGE_DELETE,
  ACTION_PAGE_DELETE_COMPLETELY,
  ACTION_PAGE_REVERT,
  ACTION_PAGE_SUBSCRIBE,
  ACTION_PAGE_UNSUBSCRIBE,
  ACTION_COMMENT_CREATE,
  ACTION_COMMENT_UPDATE,
  ACTION_COMMENT_REMOVE,
} as const;

// MediumActionGroup + All Actions by Admin Users - PAGE_VIEW
export const LargeActionGroup = {
  ...MediumActionGroup,
  ACTION_ADMIN_APP_SETTINGS_UPDATE,
  ACTION_ADMIN_SITE_URL_UPDATE,
  ACTION_ADMIN_MAIL_SMTP_UPDATE,
  ACTION_ADMIN_MAIL_SES_UPDATE,
  ACTION_ADMIN_MAIL_TEST_SUBMIT,
  ACTION_ADMIN_FILE_UPLOAD_CONFIG_UPDATE,
  ACTION_ADMIN_PLUGIN_UPDATE,
  ACTION_ADMIN_MAINTENANCEMODE_ENABLED,
  ACTION_ADMIN_MAINTENANCEMODE_DISABLED,
  ACTION_ADMIN_SECURITY_SETTINGS_UPDATE,
  ACTION_ADMIN_LINE_BREAK_UPDATE,
  ACTION_ADMIN_LAYOUT_UPDATE,
  ACTION_ADMIN_ARCHIVE_DATA_UPLOAD,
  ACTION_ADMIN_ARCHIVE_DATA_CREATE,
  ACTION_ADMIN_USER_NOTIFICATION_SETTINGS_ADD,
  ACTION_ADMIN_SLACK_WORKSPACE_CREATE,
  ACTION_ADMIN_SLACK_CONFIGURATION_SETTING_UPDATE,
  ACTION_ADMIN_USERS_INVITE,
  ACTION_ADMIN_USER_GROUP_CREATE,
  ACTION_ADMIN_SEARCH_INDICES_NORMALIZE,
  ACTION_ADMIN_SEARCH_INDICES_REBUILD,
} as const;

/*
 * For AuditLogManagement.tsx
 */
export const PageActions = Object.values({
  ACTION_PAGE_LIKE,
  ACTION_PAGE_BOOKMARK,
  ACTION_PAGE_CREATE,
  ACTION_PAGE_UPDATE,
  ACTION_PAGE_RENAME,
  ACTION_PAGE_DUPLICATE,
  ACTION_PAGE_DELETE,
  ACTION_PAGE_DELETE_COMPLETELY,
  ACTION_PAGE_REVERT,
} as const);

export const CommentActions = Object.values({
  ACTION_COMMENT_CREATE,
  ACTION_COMMENT_UPDATE,
} as const);

/*
 * Array
 */
export const AllSupportedTargetModels = Object.values(SupportedTargetModel);
export const AllSupportedEventModels = Object.values(SupportedEventModel);
export const AllSupportedActions = Object.values(SupportedAction);
export const AllEssentialActions = Object.values(EssentialActionGroup);
export const AllSmallGroupActions = Object.values(SmallActionGroup);
export const AllMediumGroupActions = Object.values(MediumActionGroup);
export const AllLargeGroupActions = Object.values(LargeActionGroup);

/*
 * Type
 */
export type SupportedTargetModelType = typeof SupportedTargetModel[keyof typeof SupportedTargetModel];
export type SupportedEventModelType = typeof SupportedEventModel[keyof typeof SupportedEventModel];
export type SupportedActionType = typeof SupportedAction[keyof typeof SupportedAction];

export type ISnapshot = Partial<Pick<IUser, 'username'>>

export type IActivity = {
  user?: Ref<IUser>
  ip?: string
  endpoint?: string
  targetModel?: SupportedTargetModelType
  target?: string
  eventModel?: SupportedEventModelType
  event?: string
  action: SupportedActionType
  createdAt: Date
  snapshot?: ISnapshot
}

export type IActivityHasId = IActivity & HasObjectId;

export type ISearchFilter = {
  usernames?: string[]
  dates?: {startDate: string | null, endDate: string | null}
  actions?: SupportedActionType[]
}