@metad/contracts 3.6.0 → 3.6.1

package/src/role-permission.model.ts

@@ -0,0 +1,123 @@
+import { AnalyticsPermissionsEnum } from './analytics/index'
+import { AIPermissionsEnum } from './ai/index'
+import { IBasePerTenantEntityModel } from './base-entity.model'
+import { IRole } from './role.model'
+
+export interface IRolePermission extends IBasePerTenantEntityModel {
+  roleId: string
+  permission: string
+  role: IRole
+  enabled: boolean
+}
+
+export interface IRolePermissionMigrateInput extends IBasePerTenantEntityModel {
+  permission: string
+  role: string
+  isImporting: boolean
+  sourceId: string
+}
+
+export interface IRolePermissionCreateInput extends IBasePerTenantEntityModel {
+  roleId: string
+  permission: string
+  enabled: boolean
+}
+
+export interface IRolePermissionUpdateInput {
+  enabled: boolean
+}
+
+export enum PermissionsEnum {
+  PROFILE_EDIT = 'PROFILE_EDIT',
+  ADMIN_DASHBOARD_VIEW = 'ADMIN_DASHBOARD_VIEW',
+  ORG_EMPLOYEES_VIEW = 'ORG_EMPLOYEES_VIEW',
+  ORG_EMPLOYEES_EDIT = 'ORG_EMPLOYEES_EDIT',
+  ORG_TAGS_EDIT = 'ORG_TAGS_EDIT',
+  ORG_USERS_VIEW = 'ORG_USERS_VIEW',
+  ORG_USERS_EDIT = 'ORG_USERS_EDIT',
+  ORG_INVITE_VIEW = 'ORG_INVITE_VIEW',
+  ORG_INVITE_EDIT = 'ORG_INVITE_EDIT',
+  ALL_ORG_VIEW = 'ALL_ORG_VIEW',
+  ALL_ORG_EDIT = 'ALL_ORG_EDIT',
+  APPROVAL_POLICY_VIEW = 'APPROVALS_POLICY_VIEW',
+  APPROVAL_POLICY_EDIT = 'APPROVALS_POLICY_EDIT',
+  CHANGE_SELECTED_ORGANIZATION = 'CHANGE_SELECTED_ORGANIZATION',
+  CHANGE_ROLES_PERMISSIONS = 'CHANGE_ROLES_PERMISSIONS',
+  SUPER_ADMIN_EDIT = 'SUPER_ADMIN_EDIT',
+  PUBLIC_PAGE_EDIT = 'PUBLIC_PAGE_EDIT',
+  VIEW_ALL_EMAILS = 'VIEW_ALL_EMAILS',
+  VIEW_ALL_EMAIL_TEMPLATES = 'VIEW_ALL_EMAIL_TEMPLATES',
+  ORG_HELP_CENTER_EDIT = 'ORG_HELP_CENTER_EDIT',
+  ORG_CONTACT_EDIT = 'ORG_CONTACT_EDIT',
+  ORG_CONTACT_VIEW = 'ORG_CONTACT_VIEW',
+  ORG_DEMO_EDIT = 'ORG_DEMO_EDIT', // Orgnization demo edit permission
+  INTEGRATION_EDIT = 'INTEGRATION_EDIT',
+  INTEGRATION_VIEW = 'INTEGRATION_VIEW',
+  FILE_STORAGE_VIEW = 'FILE_STORAGE_VIEW',
+  SMS_GATEWAY_VIEW = 'SMS_GATEWAY_VIEW',
+  CUSTOM_SMTP_VIEW = 'CUSTOM_SMTP_VIEW',
+  VIEW_ALL_ACCOUNTING_TEMPLATES = 'VIEW_ALL_ACCOUNTING_TEMPLATES',
+  ACCESS_DELETE_ACCOUNT = 'ACCESS_DELETE_ACCOUNT',
+  ACCESS_DELETE_ALL_DATA = 'ACCESS_DELETE_ALL_DATA'
+}
+
+export const PermissionGroups = {
+  //Permissions which can be given to any role
+  GENERAL: [
+    PermissionsEnum.PROFILE_EDIT,
+    PermissionsEnum.ADMIN_DASHBOARD_VIEW,
+    PermissionsEnum.ORG_INVITE_VIEW,
+    PermissionsEnum.ORG_INVITE_EDIT,
+    // PermissionsEnum.ORG_TAGS_EDIT,
+    PermissionsEnum.VIEW_ALL_EMAILS,
+    PermissionsEnum.VIEW_ALL_EMAIL_TEMPLATES,
+    // PermissionsEnum.ORG_HELP_CENTER_EDIT,
+    PermissionsEnum.INTEGRATION_EDIT,
+    // PermissionsEnum.ORG_CONTACT_VIEW,
+    PermissionsEnum.ORG_DEMO_EDIT,
+    // PermissionsEnum.VIEW_ALL_ACCOUNTING_TEMPLATES,
+
+    // AI
+    AIPermissionsEnum.KNOWLEDGEBASE_EDIT,
+    AIPermissionsEnum.COPILOT_VIEW,
+    AIPermissionsEnum.COPILOT_EDIT,
+    AIPermissionsEnum.XPERT_EDIT,
+    AIPermissionsEnum.CHAT_VIEW,
+
+    // DataSource
+    AnalyticsPermissionsEnum.DATA_SOURCE_VIEW,
+    AnalyticsPermissionsEnum.DATA_SOURCE_EDIT,
+    // Semantic Model
+    AnalyticsPermissionsEnum.MODELS_VIEW,
+    AnalyticsPermissionsEnum.MODELS_EDIT,
+    // Story
+    AnalyticsPermissionsEnum.STORIES_VIEW,
+    AnalyticsPermissionsEnum.STORIES_EDIT,
+    // Business Area
+    AnalyticsPermissionsEnum.BUSINESS_AREA_VIEW,
+    AnalyticsPermissionsEnum.BUSINESS_AREA_EDIT,
+    // Certification
+    AnalyticsPermissionsEnum.CERTIFICATION_EDIT,
+    // Indicator
+    AnalyticsPermissionsEnum.INDICATOR_VIEW,
+    AnalyticsPermissionsEnum.INDICATOR_MARTKET_VIEW,
+    AnalyticsPermissionsEnum.INDICATOR_EDIT,
+    // Data Factory
+    AnalyticsPermissionsEnum.DATA_FACTORY_VIEW,
+    AnalyticsPermissionsEnum.DATA_FACTORY_EDIT,
+  ],
+
+  //Readonly permissions, are only enabled for admin role
+  ADMINISTRATION: [
+    PermissionsEnum.ORG_USERS_VIEW,
+    PermissionsEnum.ORG_USERS_EDIT,
+    PermissionsEnum.ALL_ORG_VIEW,
+    PermissionsEnum.ALL_ORG_EDIT,
+    PermissionsEnum.CHANGE_SELECTED_ORGANIZATION,
+    PermissionsEnum.CHANGE_ROLES_PERMISSIONS,
+    PermissionsEnum.SUPER_ADMIN_EDIT,
+    PermissionsEnum.INTEGRATION_VIEW,
+    PermissionsEnum.ACCESS_DELETE_ACCOUNT,
+    PermissionsEnum.ACCESS_DELETE_ALL_DATA
+  ]
+}

package/src/role.model.ts

@@ -0,0 +1,31 @@
+import { IUser } from './user.model';
+import { IBasePerTenantEntityModel } from './base-entity.model';
+import { IRolePermission } from './role-permission.model';
+
+export interface IRole extends IRoleCreateInput {
+	isSystem?: boolean;
+	rolePermissions?: IRolePermission[];
+	users?: IUser[];
+}
+
+export interface IRoleCreateInput extends IBasePerTenantEntityModel {
+	name: string
+}
+
+export enum RolesEnum {
+	SUPER_ADMIN = 'SUPER_ADMIN',
+	ADMIN = 'ADMIN',
+	DATA_ENTRY = 'DATA_ENTRY',
+	EMPLOYEE = 'EMPLOYEE',
+	CANDIDATE = 'CANDIDATE',
+	MANAGER = 'MANAGER',
+	VIEWER = 'VIEWER',
+	// 有所免费用户
+	TRIAL = 'TRIAL'
+}
+
+export interface IRoleMigrateInput extends IBasePerTenantEntityModel {
+	name: string;
+	isImporting: boolean;
+	sourceId: string;
+}

package/src/schedule.ts

@@ -0,0 +1,71 @@
+export enum ScheduleTaskStatus {
+  PAUSED = 'paused',
+  ARCHIVED = 'archived',
+  SCHEDULED = 'scheduled',
+}
+export enum TaskFrequency {
+  Once = 'Once',
+  Daily = 'Daily',
+  Weekly = 'Weekly',
+  Monthly = 'Monthly',
+  Yearly = 'Yearly',
+}
+
+export type TScheduleOptions = {
+  frequency: TaskFrequency
+  time: string; // 'HH:mm'
+  dayOfWeek?: number; // 0-6 (0 = Sunday)
+  dayOfMonth?: number; // 1-31
+  month?: number; // 1-12
+  date?: string; // 'YYYY-MM-DD'
+}
+
+/**
+ * Generate cron expression: Minutes Hour Day Month Week
+ * 
+ * @param schedule 
+ * @returns 
+ */
+export function generateCronExpression(schedule: TScheduleOptions): string {
+  if (!schedule.time) throw new Error('Time is required for scheduling');
+  
+  const [hourStr, minuteStr] = schedule.time.split(':');
+  const hour = parseInt(hourStr, 10);
+  const minute = parseInt(minuteStr, 10);
+
+  if (isNaN(hour) || isNaN(minute) || hour < 0 || hour > 23 || minute < 0 || minute > 59) {
+    throw new Error('Invalid time format. Expected HH:mm with valid hour and minute.');
+  }
+
+  switch (schedule.frequency) {
+    case TaskFrequency.Once: {
+      if (!schedule.date) throw new Error('Date is required for Once schedule');
+      const date = new Date(schedule.date);
+      // if (isNaN(date.getTime())) throw new Error('Invalid date format for Once schedule');
+      return `${minute} ${hour} ${date.getDate()} ${date.getMonth() + 1} *`;
+    }
+
+    case TaskFrequency.Daily:
+      return `${minute} ${hour} * * *`;
+
+    case TaskFrequency.Weekly:
+      if (schedule.dayOfWeek === undefined || schedule.dayOfWeek < 0 || schedule.dayOfWeek > 6)
+        throw new Error('Valid dayOfWeek (0-6) is required for Weekly schedule');
+      return `${minute} ${hour} * * ${schedule.dayOfWeek}`;
+
+    case TaskFrequency.Monthly:
+      if (!schedule.dayOfMonth || schedule.dayOfMonth < 1 || schedule.dayOfMonth > 31)
+        throw new Error('Valid dayOfMonth (1-31) is required for Monthly schedule');
+      return `${minute} ${hour} ${schedule.dayOfMonth} * *`;
+
+    case TaskFrequency.Yearly: {
+      if (!schedule.date) throw new Error('Date is required for Yearly schedule');
+      const date = new Date(schedule.date);
+      // if (isNaN(date.getTime())) throw new Error('Invalid date format for Yearly schedule');
+      return `${minute} ${hour} ${date.getDate()} ${date.getMonth() + 1} *`;
+    }
+
+    default:
+      throw new Error(`Unsupported frequency: ${schedule.frequency}`);
+  }
+}

package/src/secret-token.model.ts

@@ -0,0 +1,15 @@
+import { IBaseEntityModel } from './base-entity.model';
+
+export interface ISecretToken
+	extends IBaseEntityModel {
+	entityId?: string
+	token: string;
+	validUntil?: Date;
+	expired?: boolean;
+}
+
+export interface ISecretTokenFindInput
+	extends IBaseEntityModel {
+	entityId?: string
+	token?: string;
+}

package/src/seed.model.ts

@@ -0,0 +1,50 @@
+import { CurrenciesEnum } from './currency.model';
+import { DefaultValueDateTypeEnum } from './organization.model';
+// import { ICandidateSource } from './candidate-source.model';
+import { IUser, LanguagesEnum } from './user.model';
+
+export interface IDefaultUser {
+	email: string;
+	password: string;
+	imageUrl: string;
+	firstName?: string;
+	lastName?: string;
+	preferredLanguage: LanguagesEnum;
+	// preferredComponentLayout: ComponentLayoutStyleEnum
+}
+
+export interface IDefaultEmployee extends IDefaultUser {
+	startedWorkOn?: string;
+	endWork?: string;
+	employeeLevel?: string;
+}
+
+// export interface IDefaultCandidate extends IDefaultUser {
+// 	candidateLevel?: string;
+// 	source?: ICandidateSource;
+// }
+
+export interface IDefaultOrganization {
+	name: string;
+	currency: CurrenciesEnum;
+	defaultValueDateType: DefaultValueDateTypeEnum;
+	imageUrl: string;
+}
+
+export interface ISeedUsers {
+	adminUsers: IUser[];
+	employeeUsers: IUser[];
+	candidateUsers: IUser[];
+}
+
+export interface IDefaultProductCategory {
+	name: string;
+	description: string;
+	imageUrl: string;
+}
+
+export interface IDefaultProductType {
+	name: string;
+	description: string;
+	icon: string;
+}

package/src/storage-file.model.ts

@@ -0,0 +1,46 @@
+import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model'
+import { FileStorageProviderEnum } from './file-provider'
+import { _TFile } from './types';
+
+export type TFile = _TFile & {
+  fileType?: string;
+  contents?: string;
+  description?: string;
+  size?: number
+  createdAt?: Date
+
+  storageFileId?: string
+}
+
+export interface IStorageFile extends IBasePerTenantAndOrganizationEntityModel {
+  file: string
+  url?: string
+  thumb?: string
+  fileUrl?: string
+  thumbUrl?: string
+  originalName?: string
+  encoding?: string
+  size?: number
+  mimetype?: string
+  recordedAt?: Date
+  storageProvider?: FileStorageProviderEnum
+}
+
+export interface ICreateStorageFileInput extends IBasePerTenantAndOrganizationEntityModel {
+  activityTimestamp: string
+  employeeId?: string
+  file: string
+  thumb?: string
+  recordedAt: Date | string
+}
+
+export interface IUpdateStorageFileInput extends ICreateStorageFileInput {
+  id: string
+}
+
+export type TFileDirectory = TFile & {
+  fullPath?: string
+  directory?: string
+  hasChildren?: boolean
+  children?: TFileDirectory[]
+}

package/src/tag-entity.model.ts

@@ -0,0 +1,23 @@
+import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
+import { I18nObject } from './types';
+
+export interface ITag extends IBasePerTenantAndOrganizationEntityModel {
+	name?: string;
+	label?: I18nObject
+	description?: string;
+	category?: TagCategoryEnum
+	color?: string
+	isSelected?: boolean;
+	icon?: string
+}
+
+export interface ITagName {
+	name?: string;
+}
+
+export enum TagCategoryEnum {
+  INDICATOR = 'indicator',
+  STORY = 'story',
+  TOOLSET = 'toolset',
+  XPERT = 'xpert'
+}

package/src/tenant.model.ts

@@ -0,0 +1,52 @@
+import { IImportRecord } from './import-export.model';
+import { IFeatureOrganization } from './feature.model';
+import {
+	FileStorageProviderEnum,
+	S3FileStorageProviderConfig
+} from './file-provider';
+import { IOrganization, IOrganizationCreateInput } from './organization.model';
+import { IRolePermission } from './role-permission.model';
+import { IUserCreateInput } from './user.model';
+
+export interface ITenant {
+	id?: string;
+	name?: string;
+
+	readonly createdAt?: Date;
+	readonly updatedAt?: Date;
+
+	organizations?: IOrganization[];
+	rolePermissions?: IRolePermission[];
+	featureOrganizations?: IFeatureOrganization[];
+	importRecords?: IImportRecord[];
+	settings?: ISetting[];
+}
+
+export interface ITenantCreateInput {
+	name: string;
+	
+	isImporting?: boolean;
+	sourceId?: string;
+	userSourceId?: string;
+
+	superAdmin?: IUserCreateInput
+	defaultOrganization?: IOrganizationCreateInput
+}
+
+export interface ISetting {
+	name: string;
+	value: string;
+}
+
+export interface ITenantSetting extends S3FileStorageProviderConfig {
+	fileStorageProvider?: FileStorageProviderEnum;
+	tenant_title?: string
+	tenant_title_en?: string
+	tenant_enable_feishu?: boolean
+	tenant_enable_dingtalk?: boolean
+	tenant_enable_wechat?: boolean
+	tenant_enable_github?: boolean
+	tenant_enable_google?: boolean
+}
+
+export const DEFAULT_TENANT = 'Default Tenant';

package/src/tools/index.ts

@@ -0,0 +1 @@
+export * from './sandbox'

package/src/tools/sandbox.ts

@@ -0,0 +1,5 @@
+export enum InterruptMessageType {
+    SlidesTemplate = 'slides_template',
+    SwitchGitHubRepository = 'switch_github_repository',
+    Select = 'select',
+}

package/src/translation.model.ts

@@ -0,0 +1,37 @@
+import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
+import { LanguagesEnum } from './user.model';
+
+export interface ITranslation<T>
+	extends IBasePerTenantAndOrganizationEntityModel {
+	reference?: ITranslatable<T>;
+	referenceId?: string;
+	languageCode: string;
+}
+
+export interface ITranslatable<T>
+	extends IBasePerTenantAndOrganizationEntityModel {
+	translations?: ITranslation<T>[];
+
+	translate?(languageCode : string): any;
+	translateNested?(languageCode : string, translatePropsInput: Array<any>) : any;
+}
+
+export interface TranslateInput {
+	key: string;
+	alias: string;
+}
+
+export interface TranslatePropertyInput {
+	prop: string;
+	propsTranslate: Array<TranslateInput>;
+	propAsArr?: Array<string>;
+}
+
+export const TranslationLanguageMap = {
+	'zh-CN': 'zh',
+	'zh-Hans': 'zh',
+}
+
+export function mapTranslationLanguage(languageCode: LanguagesEnum) {
+	return TranslationLanguageMap[languageCode] || languageCode
+}