platform/plugins/hr/src/index.ts
Denis Bykhov da6c2eda0a
HR managers (#2721)
Signed-off-by: Denis Bykhov <bykhov.denis@gmail.com>
2023-03-10 11:48:04 +06:00

161 lines
3.6 KiB
TypeScript

//
// Copyright © 2022 Hardcore Engineering Inc.
//
// Licensed under the Eclipse Public License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. You may
// obtain a copy of the License at https://www.eclipse.org/legal/epl-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//
// See the License for the specific language governing permissions and
// limitations under the License.
//
import type { Contact, Employee, EmployeeAccount } from '@hcengineering/contact'
import type { Arr, AttachedDoc, Class, Doc, Markup, Mixin, Ref, Space, Type } from '@hcengineering/core'
import type { Asset, IntlString, Plugin } from '@hcengineering/platform'
import { plugin } from '@hcengineering/platform'
import { Viewlet } from '@hcengineering/view'
import { NotificationType } from '@hcengineering/notification'
/**
* @public
*/
export interface Department extends Space {
space: Ref<Department>
avatar?: string | null
teamLead: Ref<Employee> | null
attachments?: number
comments?: number
channels?: number
members: Arr<Ref<DepartmentMember>>
subscribers?: Arr<Ref<Contact>>
managers: Arr<Ref<Employee>>
}
/**
* @public
*/
export interface DepartmentMember extends EmployeeAccount {}
/**
* @public
*/
export interface Staff extends Employee {
department: Ref<Department>
}
/**
* @public
*/
export interface RequestType extends Doc {
label: IntlString
icon: Asset
value: number
color: number
}
/**
* @public
*/
export interface TzDate {
year: number
month: number
day: number
offset: number
}
/**
* @public
*/
export interface PublicHoliday extends Doc {
title: string
description: string
date: TzDate
department: Ref<Department>
}
/**
* @public
*/
export interface Request extends AttachedDoc {
attachedTo: Ref<Staff>
attachedToClass: Ref<Class<Staff>>
space: Ref<Department>
type: Ref<RequestType>
description: Markup
comments?: number
attachments?: number
// Date always in UTC
tzDate: TzDate
tzDueDate: TzDate
}
/**
* @public
*/
export const hrId = 'hr' as Plugin
/**
* @public
*/
const hr = plugin(hrId, {
app: {
HR: '' as Ref<Doc>
},
class: {
Department: '' as Ref<Class<Department>>,
DepartmentMember: '' as Ref<Class<DepartmentMember>>,
Request: '' as Ref<Class<Request>>,
RequestType: '' as Ref<Class<RequestType>>,
TzDate: '' as Ref<Class<Type<TzDate>>>,
PublicHoliday: '' as Ref<Class<PublicHoliday>>
},
mixin: {
Staff: '' as Ref<Mixin<Staff>>
},
icon: {
HR: '' as Asset,
Department: '' as Asset,
Structure: '' as Asset,
Vacation: '' as Asset,
Sick: '' as Asset,
PTO: '' as Asset,
Remote: '' as Asset,
Overtime: '' as Asset
},
ids: {
Head: '' as Ref<Department>,
Vacation: '' as Ref<RequestType>,
Leave: '' as Ref<RequestType>,
Sick: '' as Ref<RequestType>,
PTO: '' as Ref<RequestType>,
PTO2: '' as Ref<RequestType>,
Remote: '' as Ref<RequestType>,
Overtime: '' as Ref<RequestType>,
Overtime2: '' as Ref<RequestType>,
CreateRequestNotification: '' as Ref<NotificationType>,
UpdateRequestNotification: '' as Ref<NotificationType>,
RemoveRequestNotification: '' as Ref<NotificationType>,
CreatePublicHolidayNotification: '' as Ref<NotificationType>
},
viewlet: {
TableMember: '' as Ref<Viewlet>,
StaffStats: '' as Ref<Viewlet>
}
})
export * from './utils'
/**
* @public
*/
export default hr