@metad/contracts 3.6.0 → 3.6.1

package/src/email.model.ts

@@ -0,0 +1,46 @@
+import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
+import {
+	IEmailTemplate,
+	IEmailTemplateFindInput
+} from './email-template.model';
+import { IUser } from './user.model';
+
+export interface IEmail 
+	extends IBasePerTenantAndOrganizationEntityModel {
+	name: string;
+	content: string;
+	email: string;
+	isArchived?: boolean;
+	user?: IUser;
+	userId?: string;
+	emailTemplate: IEmailTemplate;
+	emailTemplateId: string;
+}
+
+export interface IEmailUpdateInput 
+	extends IBasePerTenantAndOrganizationEntityModel {
+	name?: string;
+	content?: string;
+	email?: string;
+	emailTemplate?: IEmailTemplate;
+	emailTemplateId?: string;
+	user?: IUser;
+	userId?: string;
+	isArchived?: boolean;
+}
+
+export interface IEmailFindInput
+	extends IBasePerTenantAndOrganizationEntityModel {
+	emailTemplate?: IEmailTemplateFindInput;
+	emailTemplateId?: string;
+	user?: IUser;
+	userId?: string;
+	email?: string;
+	isArchived?: boolean;
+}
+
+export interface DisplayEmail {
+	from: string;
+	to: string;
+	date: string;
+}

package/src/employee.model.ts

@@ -0,0 +1,199 @@
+import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
+import { IContact } from './contact.model';
+// import { IEmployeeJobsStatistics } from './employee-job.model';
+// import { IOrganizationDepartment } from './organization-department.model';
+// import { IOrganizationEmploymentType } from './organization-employment-type.model';
+import { CrudActionEnum, IOrganizationFindInput } from './organization.model';
+// import { IOrganizationPosition } from './organization-positions.model';
+import { IOrganizationTeam } from './organization-team-model';
+// import { IRequestApprovalEmployee } from './request-approval-employee.model';
+// import { ISkill } from './skill-entity.model';
+import { ITag } from './tag-entity.model';
+import { IUser, IUserFindInput } from './user.model';
+// import { IOrganizationContact } from './organization-contact.model';
+// import { IOrganizationProject } from './organization-projects.model';
+// import { IEmployeeSetting } from './employee-settings.model';
+// import { IExpense } from './expense.model';
+// import { ITimesheet } from './timesheet.model';
+
+export interface IEmployee extends IBasePerTenantAndOrganizationEntityModel {
+	[x: string]: any;
+	endWork?: any;
+	startedWorkOn?: any;
+	user: IUser;
+	userId: string;
+	valueDate?: Date;
+	isActive: boolean;
+	short_description?: string;
+	description?: string;
+	teams?: IOrganizationTeam[];
+	payPeriod?: string;
+	billRateValue?: number;
+	billRateCurrency?: string;
+	reWeeklyLimit?: number;
+	// organizationDepartments?: IOrganizationDepartment[];
+	// organizationContacts?: IOrganizationContact[];
+	// projects?: IOrganizationProject[];
+	// organizationPosition?: IOrganizationPosition;
+	tags: ITag[];
+	// skills: ISkill[];
+	offerDate?: Date;
+	acceptDate?: Date;
+	rejectDate?: Date;
+	employeeLevel?: string;
+	anonymousBonus?: boolean;
+	// organizationEmploymentTypes?: IOrganizationEmploymentType[];
+	// requestApprovalEmployee?: IRequestApprovalEmployee[];
+	// settings?: IEmployeeSetting[];
+	// expenses?: IExpense[];
+	// timesheets?: ITimesheet[];
+	// contact: IContact;
+	// averageIncome?: number;
+	// totalWorkHours?: number;
+	// averageExpenses?: number;
+	// averageBonus?: number;
+	// show_anonymous_bonus?: boolean;
+	// show_average_bonus?: boolean;
+	// show_average_expenses?: boolean;
+	// show_average_income?: boolean;
+	// show_billrate?: boolean;
+	// show_payperiod?: boolean;
+	// isJobSearchActive?: boolean;
+	// linkedInUrl?: string;
+	// facebookUrl?: string;
+	// instagramUrl?: string;
+	// twitterUrl?: string;
+	// githubUrl?: string;
+	// gitlabUrl?: string;
+	// upworkUrl?: string;
+	// jobSuccess?: number;
+	// isVerified?: boolean;
+	// isVetted?: boolean;
+	// totalJobs?: number;
+	// fullName?: string;
+}
+
+// export type IEmployeeJobsStatisticsResponse = IEmployee &
+// 	IEmployeeJobsStatistics;
+
+export interface UpdateEmployeeJobsStatistics {
+	isJobSearchActive?: boolean;
+}
+
+export interface IEmployeeFindInput {
+	id?: string;
+	organization?: IOrganizationFindInput;
+	user?: IUserFindInput;
+	valueDate?: Date;
+	organizationId?: string;
+	tenantId?: string;
+	tags?: ITag[];
+	// skills?: ISkill[];
+}
+
+export interface IEmployeeUpdateInput 
+	extends IBasePerTenantAndOrganizationEntityModel {
+	payPeriod?: string;
+	billRateValue?: number;
+	billRateCurrency?: string;
+	reWeeklyLimit?: number;
+	// organizationDepartment?: IOrganizationDepartment;
+	// organizationPosition?: IOrganizationPosition;
+	offerDate?: Date;
+	acceptDate?: Date;
+	rejectDate?: Date;
+	short_description?: string;
+	description?: string;
+	averageIncome?: number;
+	averageExpenses?: number;
+	averageBonus?: number;
+	// skills?: ISkill[];
+	isJobSearchActive?: boolean;
+	contact?: IContact;
+	linkedInUrl?: string;
+	facebookUrl?: string;
+	instagramUrl?: string;
+	twitterUrl?: string;
+	githubUrl?: string;
+	gitlabUrl?: string;
+	upworkUrl?: string;
+}
+
+export interface IEmployeeCreateInput
+	extends IBasePerTenantAndOrganizationEntityModel {
+	user: IUser;
+	password?: string;
+	offerDate?: Date;
+	acceptDate?: Date;
+	rejectDate?: Date;
+	members?: IEmployee[];
+	tags?: ITag[];
+	// skills?: ISkill[];
+	startedWorkOn?: any;
+	short_description?: string;
+	description?: string;
+	originalUrl?: string;
+	isActive?: boolean;
+}
+
+export interface ISelectedEmployee {
+	id: string;
+	firstName: string;
+	lastName: string;
+	fullName?: string;
+	imageUrl: string;
+	defaultType?: DEFAULT_TYPE;
+	tags?: ITag[];
+	// skills?: ISkill[];
+}
+
+export enum DEFAULT_TYPE {
+	ALL_EMPLOYEE = 'ALL_EMPLOYEE',
+	NO_EMPLOYEE = 'NO_EMPLOYEE'
+}
+
+export enum PayPeriodEnum {
+	NONE = 'NONE',
+	BI_WEEKLY = 'BI_WEEKLY',
+	WEEKLY = 'WEEKLY',
+	TWICE_PER_MONTH = 'TWICE_PER_MONTH',
+	MONTHLY = 'MONTHLY'
+}
+export interface IEmployeeLevel 
+	extends IBasePerTenantAndOrganizationEntityModel  {
+	level: string;
+	tag?: ITag[];
+	// skills?: ISkill[];
+}
+
+export interface IEmployeeLevelInput
+	extends IBasePerTenantAndOrganizationEntityModel {
+	level: string;
+	tags?: ITag[];
+	// skills?: ISkill[];
+}
+
+export interface IEmployeeLevelFindInput {
+	organizationId?: string;
+	tenantId: string;
+}
+export interface EmployeeViewModel {
+	fullName: string;
+	email: string;
+	bonus?: number;
+	endWork?: any;
+	id: string;
+	imageUrl?: string;
+	averageIncome?: number;
+	averageExpenses?: number;
+	averageBonus?: number;
+	workStatus?: string;
+	startedWorkOn?: string;
+	isActive?: boolean;
+	tags?: ITag[];
+}
+
+export interface IEmployeeStoreState {
+	employee: IEmployee | IEmployee[];
+	action: CrudActionEnum;
+}

package/src/entity-with-members.model.ts

@@ -0,0 +1,16 @@
+import { IEmployee } from './employee.model';
+import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
+import { ITag } from './tag-entity.model';
+
+export interface IBaseEntityWithMembers
+	extends IBasePerTenantAndOrganizationEntityModel {
+	members?: IEmployee[];
+	name?: string;
+	tags?: ITag[];
+}
+
+export interface IEditEntityByMemberInput {
+	addedEntityIds?: string[];
+	removedEntityIds?: string[];
+	member: IEmployee;
+}

package/src/feature.model.ts

@@ -0,0 +1,108 @@
+import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
+
+export interface IFeature extends IBasePerTenantAndOrganizationEntityModel {
+	code: string;
+	description: string;
+	featureOrganizations?: IFeatureOrganization[];
+	image?: string;
+	readonly imageUrl?: string;
+	link: string;
+	name: string;
+	status: string;
+	icon: string;
+	isEnabled?: boolean;
+	isPaid?: boolean;
+	readonly parentId?: string;
+	parent?: IFeature;
+	children?: IFeature[];
+}
+export interface IFeatureCreateInput extends IFeature {
+	isEnabled: boolean;
+}
+
+export interface IFeatureOrganization
+	extends IBasePerTenantAndOrganizationEntityModel {
+	feature: IFeature;
+	featureId?: string;
+	isEnabled: boolean;
+}
+
+export interface IFeatureOrganizationUpdateInput
+	extends IBasePerTenantAndOrganizationEntityModel {
+	featureId: string;
+	isEnabled: boolean;
+}
+
+export interface IFeatureOrganizationFindInput
+	extends IBasePerTenantAndOrganizationEntityModel {
+	featureId?: string;
+}
+
+export enum FeatureStatusEnum {
+	INFO = 'info',
+	PRIMARY = 'primary',
+	SUCCESS = 'success',
+	WARNING = 'warning'
+}
+
+export enum IFeatureToggleTypeEnum {
+	RELEASE = 'release',
+	KILL_SWITCH = 'kill-switch',
+	EXPERIMENT = 'experiment',
+	OPERATIONAL = 'operational',
+	PERMISSION = 'permission'
+}
+
+export interface IFeatureToggleVariant {
+	name?: string;
+	weight?: number;
+	weightType?: string;
+	payload?: IFeatureTogglePayload;
+	overrides?: IFeatureToggleOverride[];
+}
+
+export interface IFeatureToggleOverride {
+	contextName?: string;
+	values?: string[];
+}
+
+export interface IFeatureTogglePayload {
+	type?: string;
+	value?: string;
+}
+
+export interface IFeatureToggle {
+	name: string;
+	description?: string;
+	type: IFeatureToggleTypeEnum;
+	project?: string;
+	enabled: boolean;
+	stale?: boolean;
+	strategies?: any;
+	variants?: IFeatureToggleVariant[];
+	createdAt?: string;
+	lastSeenAt?: string | null;
+}
+
+export enum FeatureEnum {
+	FEATURE_HOME = 'FEATURE_HOME',
+	FEATURE_DASHBOARD = 'FEATURE_DASHBOARD',
+	FEATURE_JOB = 'FEATURE_JOB',
+	FEATURE_EMPLOYEES = 'FEATURE_EMPLOYEES',
+	FEATURE_MANAGE_INVITE = 'FEATURE_MANAGE_INVITE',
+	FEATURE_ORGANIZATION = 'FEATURE_ORGANIZATION',
+	FEATURE_ORGANIZATION_TAG = 'FEATURE_ORGANIZATION_TAG',
+	FEATURE_ORGANIZATION_PROJECT = 'FEATURE_ORGANIZATION_PROJECT',
+	FEATURE_CONTACT = 'FEATURE_CONTACT',
+	FEATURE_USER = 'FEATURE_USER',
+	FEATURE_ORGANIZATIONS = 'FEATURE_ORGANIZATIONS',
+	// FEATURE_APP_INTEGRATION = 'FEATURE_APP_INTEGRATION',
+	FEATURE_SETTING = 'FEATURE_SETTING',
+	FEATURE_EMAIL_HISTORY = 'FEATURE_EMAIL_HISTORY',
+	FEATURE_EMAIL_TEMPLATE = 'FEATURE_EMAIL_TEMPLATE',
+	FEATURE_FILE_STORAGE = 'FEATURE_FILE_STORAGE',
+	FEATURE_SMS_GATEWAY = 'FEATURE_SMS_GATEWAY',
+	FEATURE_SMTP = 'FEATURE_SMTP',
+	FEATURE_ROLES_PERMISSION = 'FEATURE_ROLES_PERMISSION',
+	FEATURE_INTEGRATION = 'FEATURE_INTEGRATION',
+}

package/src/file-provider.ts

@@ -0,0 +1,37 @@
+export interface FileStorageOption {
+	dest: string | CallableFunction;
+	provider?: FileStorageProviderEnum;
+	prefix?: string;
+	filename?: string | CallableFunction;
+}
+
+export interface FileSystem {
+	rootPath: string;
+	baseUrl?: string;
+}
+
+export enum FileStorageProviderEnum {
+	LOCAL = 'LOCAL',
+	S3 = 'S3',
+	WASABI = 'WASABI',
+	OSS = 'OSS', // 阿里云对象存储 OSS（Object Storage Service）
+}
+
+export interface UploadedFile {
+	fieldname: string;
+	key: string; // path of the file in storage
+	originalname: string; // orignal file name
+	size: number; // files in bytes
+	encoding?: string;
+	mimetype?: string;
+	filename: string;
+	url: string; // file public url
+	path: string; // Full path of the file
+}
+
+export interface S3FileStorageProviderConfig {
+	aws_access_key_id?: string;
+	aws_secret_access_key?: string;
+	aws_default_region?: string;
+	aws_bucket?: string;
+}

package/src/help-center-article.model.ts

@@ -0,0 +1,35 @@
+// import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
+// import { IEmployee } from './employee.model';
+
+// export interface IHelpCenterArticle
+// 	extends IBasePerTenantAndOrganizationEntityModel {
+// 	name: string;
+// 	description: string;
+// 	data: string;
+// 	index: number;
+// 	draft: boolean;
+// 	privacy: boolean;
+// 	categoryId: string;
+// 	employees?: IEmployee[];
+// 	authors?: IHelpCenterAuthor[];
+// }
+
+// export interface IHelpCenterAuthor
+// 	extends IBasePerTenantAndOrganizationEntityModel {
+// 	articleId: string;
+// 	article?: IHelpCenterArticle;
+// 	employeeId: string;
+// 	employee?: IEmployee;
+// 	articles?: IHelpCenterArticle[];
+// }
+
+// export interface IHelpCenterAuthorCreate
+// 	extends IBasePerTenantAndOrganizationEntityModel {
+// 	articleId: string;
+// 	employeeIds: string[];
+// }
+
+// export interface IHelpCenterAuthorFind
+// 	extends IBasePerTenantAndOrganizationEntityModel {
+// 	id?: string;
+// }

package/src/help-center.model.ts

@@ -0,0 +1,33 @@
+// import { IHelpCenterArticle } from './help-center-article.model';
+// import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
+
+// export interface IHelpCenter extends IBasePerTenantAndOrganizationEntityModel {
+// 	name: string;
+// 	icon: string;
+// 	flag: string;
+// 	privacy: string;
+// 	language: string;
+// 	color: string;
+// 	description?: string;
+// 	data?: string;
+// 	index: number;
+// 	children?: IHelpCenter[];
+// 	parent?: IHelpCenter;
+// 	article?: IHelpCenterArticle[];
+// 	parentId?: string;
+// }
+
+// export interface IHelpCenterFind
+// 	extends IBasePerTenantAndOrganizationEntityModel {
+// 	id?: string;
+// }
+
+// export enum HelpCenterActionEnum {
+// 	ADD = 'add',
+// 	EDIT = 'edit'
+// }
+
+// export enum HelpCenterFlagEnum {
+// 	BASE = 'base',
+// 	CATEGORY = 'category'
+// }

package/src/http-status.enum.ts

@@ -0,0 +1,58 @@
+export enum HttpStatus {
+	CONTINUE = 100,
+	SWITCHING_PROTOCOLS = 101,
+	PROCESSING = 102,
+	OK = 200,
+	CREATED = 201,
+	ACCEPTED = 202,
+	NON_AUTHORITATIVE_INFORMATION = 203,
+	NO_CONTENT = 204,
+	RESET_CONTENT = 205,
+	PARTIAL_CONTENT = 206,
+	AMBIGUOUS = 300,
+	MOVED_PERMANENTLY = 301,
+	FOUND = 302,
+	SEE_OTHER = 303,
+	NOT_MODIFIED = 304,
+	TEMPORARY_REDIRECT = 307,
+	PERMANENT_REDIRECT = 308,
+	BAD_REQUEST = 400,
+	UNAUTHORIZED = 401,
+	PAYMENT_REQUIRED = 402,
+	FORBIDDEN = 403,
+	NOT_FOUND = 404,
+	METHOD_NOT_ALLOWED = 405,
+	NOT_ACCEPTABLE = 406,
+	PROXY_AUTHENTICATION_REQUIRED = 407,
+	REQUEST_TIMEOUT = 408,
+	CONFLICT = 409,
+	GONE = 410,
+	LENGTH_REQUIRED = 411,
+	PRECONDITION_FAILED = 412,
+	PAYLOAD_TOO_LARGE = 413,
+	URI_TOO_LONG = 414,
+	UNSUPPORTED_MEDIA_TYPE = 415,
+	REQUESTED_RANGE_NOT_SATISFIABLE = 416,
+	EXPECTATION_FAILED = 417,
+	I_AM_A_TEAPOT = 418,
+	UNPROCESSABLE_ENTITY = 422,
+	FAILED_DEPENDENCY = 424,
+	TOO_MANY_REQUESTS = 429,
+	INTERNAL_SERVER_ERROR = 500,
+	NOT_IMPLEMENTED = 501,
+	BAD_GATEWAY = 502,
+	SERVICE_UNAVAILABLE = 503,
+	GATEWAY_TIMEOUT = 504,
+	HTTP_VERSION_NOT_SUPPORTED = 505
+}
+
+export enum RequestMethodEnum {
+	GET = 'GET',
+	POST = 'POST',
+	PUT = 'PUT',
+	DELETE = 'DELETE',
+	PATCH = 'PATCH',
+	ALL = 'ALL',
+	OPTIONS = 'OPTIONS',
+	HEAD = 'HEAD'
+}

package/src/import-export.model.ts

@@ -0,0 +1,42 @@
+import { IBasePerTenantEntityModel } from "./base-entity.model";
+
+export interface IImportRecord extends IBasePerTenantEntityModel {
+	entityType?: string;
+	sourceId?: string;
+	destinationId?: string;
+	importDate?: Date;
+	wasCreated?: boolean;
+}
+
+export interface IImportRecordFind extends IBasePerTenantEntityModel {
+	entityType?: string;
+	sourceId?: string;
+	destinationId?: string;
+}
+
+export interface IImportHistory extends IBasePerTenantEntityModel {
+	file: string;
+	path: string;
+	size: number;
+	status: string;
+	importDate?: Date;
+}
+
+export interface IEntityModel {
+	name: string;
+	value: string;
+	checked: boolean;
+	isGroup: boolean;
+	entities: IEntityModel[];
+}
+
+export enum ImportTypeEnum {
+	MERGE = 'merge',
+	CLEAN = 'clean',
+}
+
+export enum ImportHistoryStatusEnum {
+	SUCCESS = 'Success',
+	FAILED = 'Failed',
+	CANCELLED = 'Cancelled'
+}

package/src/index.ts

@@ -0,0 +1,60 @@
+export * from './types'
+export * from './contact.model'
+export * from './core.model'
+export * from './country.model'
+export * from './currency.model'
+
+export * from './email-template.model'
+export * from './email.model'
+
+export * from './employee.model'
+export * from './entity-with-members.model'
+
+export * from './feature.model'
+export * from './file-provider'
+
+export * from './http-status.enum'
+
+export * from './import-export.model'
+
+export * from './language.model'
+export * from './organization-contact.model'
+export * from './organization-department.model'
+export * from './organization-language.model'
+
+export * from './organization-team-employee-model'
+export * from './organization-team-model'
+export * from './organization.model'
+
+export * from './role-permission.model'
+export * from './seed.model'
+
+export * from './tag-entity.model'
+export * from './tenant.model'
+
+export * from './translation.model'
+
+export type { IBasePerTenantAndOrganizationEntityModel, IBasePerTenantEntityModel, IBaseRelationsEntityModel } from './base-entity.model'
+export type { IBaseEntityModel as BaseEntityModel } from './base-entity.model'
+export * from './role.model'
+export * from './user-organization.model'
+export * from './user.model'
+
+export * from './analytics/index'
+export * from './custom-smtp.model'
+export * from './date-picker.model'
+export * from './integration.model'
+export * from './invite.model'
+export * from './organization-projects.model'
+export * from './password-reset.model'
+export * from './secret-token.model'
+export * from './storage-file.model'
+export * from './visibility.model'
+export * from './integration/index'
+export * from './ai/index'
+export * from './agent/index'
+export * from './api-key.model'
+export * from './schedule'
+export * from './tools/index'
+export * from './plain-object.model'
+export * from './plugin'

package/src/integration/dify.ts

@@ -0,0 +1,31 @@
+// import { IntegrationEnum, IntegrationFeatureEnum, TIntegrationProvider } from '../integration.model'
+
+// export const IntegrationDifyProvider: TIntegrationProvider = {
+//   name: IntegrationEnum.Dify,
+//   label: {
+//     en_US: 'Dify',
+//     zh_Hans: 'Dify'
+//   },
+//   description: {
+//     en_US:
+//       'Dify’s Knowledge feature visualizes each stage of the RAG pipeline, developers can upload internal company documents, FAQs, and standard working guides, then process them into structured data that large language models (LLMs) can query.',
+//     zh_Hans:
+//       'Dify 的知识功能将 RAG 管道的每个阶段可视化，开发人员可以上传公司内部文档、常见问题解答和标准工作指南，然后将它们处理成大型语言模型 (LLM) 可以查询的结构化数据。'
+//   },
+//   avatar: 'dify.svg',
+//   schema: {
+//     type: 'object',
+//     properties: {
+//       url: {
+//         type: 'string',
+//         description: 'The url of Dify server',
+//       },
+//       apiKey: {
+//         type: 'string',
+//         description: 'The API Key of the Dify server'
+//       }
+//     }
+//   },
+//   features: [IntegrationFeatureEnum.KNOWLEDGE],
+//   helpUrl: 'https://docs.dify.ai/en/guides/knowledge-base/readme'
+// }

package/src/integration/dingtalk.ts

@@ -0,0 +1,16 @@
+import { IntegrationEnum, TIntegrationProvider } from '../integration.model'
+
+export const IntegrationDingTalkProvider: TIntegrationProvider = {
+  name: IntegrationEnum.DINGTALK,
+  label: {
+    en_US: 'DingTalk',
+    zh_Hans: '钉钉'
+  },
+  avatar: 'dingtalk.svg',
+  webhook: true,
+  schema: {
+    type: 'object',
+    properties: {}
+  },
+  pro: true
+}