@metad/contracts 3.6.0 → 3.6.1

package/src/integration/fastgpt.ts

@@ -0,0 +1,32 @@
+// import { IntegrationEnum, IntegrationFeatureEnum, TIntegrationProvider } from '../integration.model';
+
+
+// export const IntegrationFastGPTProvider: TIntegrationProvider = {
+//   name: IntegrationEnum.FastGPT,
+//   label: {
+//     en_US: 'FastGPT',
+//     zh_Hans: 'FastGPT'
+//   },
+//   description: {
+//     en_US: 'FastGPT is a knowledge base Q&A system based on LLM large language models.',
+//     zh_Hans: 'FastGPT 是一个基于 LLM 大语言模型的知识库问答系统。'
+//   },
+//   avatar: 'fastgpt.svg',
+//   schema: {
+//     type: 'object',
+//     properties: {
+//         url: {
+//             type: 'string',
+//             description: 'The url of FastGPT server'
+//         },
+//         apiKey: {
+//             type: 'string',
+//             description: 'The API Key of the FastGPT server'
+//         },
+//     }
+//   },
+//   features: [
+//     IntegrationFeatureEnum.KNOWLEDGE
+//   ],
+//   helpUrl: 'https://doc.fastgpt.io/docs/introduction/development/openapi/dataset'
+// }

package/src/integration/firecrawl.ts

@@ -0,0 +1,46 @@
+import { IntegrationEnum, TIntegrationProvider } from '../integration.model'
+import { ParameterTypeEnum } from '../types'
+
+export const IntegrationFirecrawlProvider: TIntegrationProvider = {
+  name: IntegrationEnum.FIRECRAWL,
+  label: {
+    en_US: 'Firecrawl',
+  },
+  avatar: 'firecrawl.png',
+  schema: {
+    type: 'object',
+    required: ['apiKey'],
+    parameters: [
+      {
+        name: 'apiKey',
+        type: ParameterTypeEnum.SECRET_INPUT,
+        label: {
+          en_US: 'API Key'
+        },
+        placeholder: {
+          zh_Hans: '从 firecrawl.dev 获取 API Key',
+          en_US: 'Get an API Key from firecrawl.dev'
+        },
+        help: {
+          title: {
+            en_US: 'Get an API Key',
+            zh_Hans: '获取一个 API Key',
+          },
+          url: {
+            en_US: 'https://firecrawl.dev'
+          }
+        }
+      },
+      {
+        name: 'apiUrl',
+        type: ParameterTypeEnum.STRING,
+        label: {
+          en_US: 'Base URL'
+        },
+        placeholder: {
+          en_US: 'https://api.firecrawl.dev'
+        },
+      }
+    ]
+  },
+}

package/src/integration/github.ts

@@ -0,0 +1,149 @@
+import { Endpoints } from "@octokit/types";
+import { IIntegration, IntegrationEnum, TIntegrationProvider } from '../integration.model';
+
+
+export const IntegrationGitHubProvider: TIntegrationProvider = {
+  name: IntegrationEnum.GITHUB,
+  label: {
+    en_US: 'GitHub',
+    zh_Hans: 'GitHub'
+  },
+  description: {
+    en_US: 'GitHub is a proprietary developer platform that allows developers to create, store, manage, and share their code. It uses Git to provide distributed version control and GitHub itself provides access control, bug tracking, software feature requests, task management, continuous integration, and wikis for every project.',
+    zh_Hans: 'GitHub 是一个专有的开发者平台，允许开发者创建、存储、管理和分享他们的代码。它使用 Git 提供分布式版本控制，GitHub 本身为每个项目提供访问控制、错误跟踪、软件功能请求、任务管理、持续集成和知识。'
+  },
+  avatar: 'github.svg',
+  webhook: true,
+  schema: {
+    type: 'object',
+    properties: {
+        appName: {
+            type: 'string',
+            description: 'The App Name of the GitHub App'
+        },
+        appId: {
+            type: 'string',
+            description: 'The App ID of the GitHub App'
+        },
+        clientId: {
+            type: 'string',
+            description: 'The Client ID of the GitHub App'
+        },
+        clientSecret: {
+            type: 'string',
+            description: 'The Client Secret of the GitHub App'
+        },
+        privateKey: {
+            type: 'textarea',
+            description: 'The private key of the GitHub App'
+        },
+        webhookSecret: {
+            type: 'string',
+            description: 'The webhook secret of the GitHub App'
+        }
+    }
+  },
+  // webhookUrl: (integration: IIntegration, baseUrl: string) => {
+  //   return `${baseUrl}/api/github/${integration.id}/webhook`
+  // }
+}
+
+export type TGithubAuth = {
+  redirectUri: string;
+  integrationId: string;
+  access_token: string;
+  expires_in: number;
+  refresh_token: string;
+  refresh_token_expires_in: number;
+  token_type: string;
+  scope: string;
+  installation_token: string;
+  repository: string
+};
+
+type GitHubInstallationsResponse =
+  Endpoints["GET /user/installations"]["response"]["data"];
+type GitHubInstallation = GitHubInstallationsResponse["installations"][0];
+
+export interface Installation {
+  id: number;
+  accountName: string;
+  accountType: "User" | "Organization";
+  avatarUrl: string;
+}
+
+/**
+ * Transform GitHub API installation data to our simplified format
+ */
+export const transformInstallation = (
+  installation: GitHubInstallation,
+): Installation => {
+  if (!installation.account) {
+    throw new Error("Installation account is null");
+  }
+
+  // Handle both User and Organization account types
+  let accountName: string;
+  if ("login" in installation.account && installation.account.login) {
+    accountName = installation.account.login;
+  } else if ("slug" in installation.account && installation.account.slug) {
+    accountName = installation.account.slug;
+  } else if ("name" in installation.account && installation.account.name) {
+    accountName = installation.account.name;
+  } else {
+    accountName = "Unknown";
+  }
+
+  const accountType = installation.target_type as "User" | "Organization";
+
+  return {
+    id: installation.id,
+    accountName,
+    accountType,
+    avatarUrl: installation.account.avatar_url,
+  };
+};
+
+export type TRepositoryReturn = {
+  repositories: Repository[]
+  pagination: {
+    page: number
+    perPage: number
+    hasMore: boolean
+    totalCount: number
+  }
+}
+
+/**
+ * Repository interface representing GitHub repository data
+ */
+export interface Repository {
+  id: number;
+  name: string;
+  full_name: string;
+  description: string | null;
+  private: boolean;
+  fork: boolean;
+  html_url: string;
+  default_branch: string;
+  permissions: {
+    admin: boolean;
+    maintain: boolean;
+    push: boolean;
+    triage: boolean;
+    pull: boolean;
+  };
+  has_issues: boolean;
+}
+
+/**
+ * Branch interface representing GitHub branch data
+ */
+export interface Branch {
+  name: string;
+  commit: {
+    sha: string;
+    url: string;
+  };
+  protected: boolean;
+}

package/src/integration/index.ts

@@ -0,0 +1,15 @@
+import { IntegrationEnum, TIntegrationProvider } from '../integration.model'
+import { IntegrationDingTalkProvider } from './dingtalk'
+import { IntegrationGitHubProvider } from './github'
+// import { IntegrationLarkProvider } from './lark'
+// import { IntegrationWeComProvider } from './wecom'
+
+export * from './github'
+export * from './lark'
+
+export const INTEGRATION_PROVIDERS: Partial<Record<IntegrationEnum, TIntegrationProvider>> = {
+  // [IntegrationEnum.LARK]: IntegrationLarkProvider,
+  [IntegrationEnum.DINGTALK]: IntegrationDingTalkProvider,
+  // [IntegrationEnum.WECOM]: IntegrationWeComProvider,
+  [IntegrationEnum.GITHUB]: IntegrationGitHubProvider,
+}

package/src/integration/lark.ts

@@ -0,0 +1,79 @@
+import { IIntegration, IntegrationEnum, TIntegrationProvider } from '../integration.model'
+
+export type TIntegrationLarkOptions = {
+  isLark?: boolean
+  appId: string
+  appSecret: string
+  verificationToken: string
+  encryptKey: string
+  xpertId: string
+  preferLanguage: string
+}
+
+export const IntegrationLarkProvider: TIntegrationProvider = {
+  name: IntegrationEnum.LARK,
+  label: {
+    en_US: 'Lark',
+    zh_Hans: '飞书'
+  },
+  avatar: 'lark.png',
+  webhook: true,
+  schema: {
+    type: 'object',
+    properties: {
+      isLark: { type: 'boolean', title: {
+        en_US: 'Is Lark',
+        zh_Hans: '国际版'
+      } },
+      appId: { type: 'string', title: 'App ID' },
+      appSecret: { type: 'string', title: 'App Secret' },
+      verificationToken: { type: 'string', title: 'Verification Token' },
+      encryptKey: {
+        type: 'string',
+        title: {
+          en_US: 'Encrypt Key'
+          // zh_Hans: '加密密钥'
+        }
+      },
+      xpertId: {
+        type: 'remote-select',
+        title: {
+          en_US: 'Xpert',
+          zh_Hans: '数字专家'
+        },
+        placeholder: {
+          en_US: 'Choose a corresponding digital expert',
+          zh_Hans: '选择一个对应的数字专家'
+        },
+        selectUrl: '/api/xpert/select-options'
+      },
+      preferLanguage: {
+        type: 'select',
+        title: {
+          en_US: 'Preferred Language',
+          zh_Hans: '首选语言'
+        },
+        options: [
+          {
+            value: 'en',
+            label: {
+              en_US: 'English',
+              zh_Hans: '英语'
+            }
+          }, {
+            value: 'zh',
+            label: {
+              en_US: 'Chinese',
+              zh_Hans: '中文'
+            }
+          }
+        ]
+      },
+    },
+    required: ['appId', 'appSecret'],
+    secret: ['appSecret', 'verificationToken', 'encryptKey']
+  },
+  // webhookUrl: (integration: IIntegration, baseUrl: string) => {
+  //   return `${baseUrl}/api/lark/webhook/${integration.id}`
+  // }
+}

package/src/integration/wecom.ts

@@ -0,0 +1,16 @@
+import { IntegrationEnum, TIntegrationProvider } from '../integration.model'
+
+export const IntegrationWeComProvider: TIntegrationProvider = {
+  name: IntegrationEnum.WECOM,
+  label: {
+    en_US: 'WeCom',
+    zh_Hans: '企业微信'
+  },
+  avatar: 'wecom.webp',
+  webhook: true,
+  schema: {
+    type: 'object',
+    properties: {}
+  },
+  pro: true
+}

package/src/integration.model.ts

@@ -0,0 +1,119 @@
+import {
+	IBasePerTenantAndOrganizationEntityModel
+} from './base-entity.model';
+import { IOrganizationProjectsUpdateInput } from './organization-projects.model';
+import { IOrganizationUpdateInput } from './organization.model';
+import { ITag } from './tag-entity.model';
+import { I18nObject, IconDefinition, TAvatar, TParameterSchema } from './types';
+
+
+export interface IIntegration<T = any> extends IBasePerTenantAndOrganizationEntityModel {
+	name: string
+	description?: string
+	/**
+     * avatar object
+     */
+	avatar?: TAvatar
+	slug: string;
+	provider: string | IntegrationEnum
+
+	/**
+	 * Integration features: ['knowledge', 'agent', ...]
+	 */
+	features?: IntegrationFeatureEnum[]
+
+	/**
+	 * Custom options for different providers
+	 */
+	options?: T
+
+	tags?: ITag[]
+}
+
+export interface IIntegrationFilter {
+	integrationTypeId: string;
+	searchQuery: string;
+	filter: string;
+}
+
+export interface IIntegrationMapSyncProject 
+	extends IBasePerTenantAndOrganizationEntityModel {
+	organizationProjectInput: IOrganizationProjectsUpdateInput;
+	integrationId: string;
+	sourceId: number;
+}
+
+export interface IIntegrationMapSyncOrganization 
+	extends IBasePerTenantAndOrganizationEntityModel {
+	organizationInput: IOrganizationUpdateInput;
+	integrationId: string;
+	sourceId: number;
+}
+
+/**
+ * @deprecated use Plugins instead
+ */
+export enum IntegrationEnum {
+	UPWORK = 'Upwork',
+	HUBSTAFF = 'Hubstaff',
+	LARK = 'Lark',
+	DINGTALK = 'DingTalk',
+	WECOM = 'WeCom',
+	FIRECRAWL = 'firecrawl',
+	KNOWLEDGEBASE = 'knowledgebase',
+	GITHUB = 'github',
+	RAGFlow = 'ragflow',
+	Dify = 'dify',
+	FastGPT = 'fastgpt',
+}
+
+export enum IntegrationFeatureEnum {
+	KNOWLEDGE = 'knowledge',
+	AGENT = 'agent',
+	SSO = 'sso',
+}
+
+export enum IntegrationFilterEnum {
+	ALL = 'All',
+	FREE = 'Free',
+	PAID = 'Paid'
+}
+
+export const DEFAULT_INTEGRATION_PAID_FILTERS = [
+	{
+		label: IntegrationFilterEnum.ALL,
+		value: 'all'
+	},
+	{
+		label: IntegrationFilterEnum.FREE,
+		value: 'false'
+	},
+	{
+		label: IntegrationFilterEnum.PAID,
+		value: 'true'
+	}
+];
+
+export interface IDateRangeActivityFilter {
+	start: Date;
+	end: Date;
+}
+
+export type TIntegrationProvider = {
+	name: string
+	label: I18nObject
+	description?: I18nObject
+	avatar?: string
+	icon?: IconDefinition
+	webhook?: boolean
+	schema?: TParameterSchema
+	features?: IntegrationFeatureEnum[]
+	helpUrl?: string
+	/**
+	 * Webhook URL generator, for example:
+	 * `{{apiBaseUrl}}/api/integration/webhook/{{integrationId}}`
+	 */
+	webhookUrl?: string
+	// webhookUrl?: (integration: IIntegration, baseUrl: string) => string
+	pro?: boolean
+}

package/src/invite.model.ts

@@ -0,0 +1,144 @@
+import { IRole } from './role.model';
+import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
+import { IUser, IUserRegistrationInput, LanguagesEnum } from './user.model';
+import { IOrganization } from './organization.model';
+import { IOrganizationContact } from './organization-contact.model';
+import { IOrganizationDepartment } from './organization-department.model';
+import { IEmployee } from './employee.model';
+
+export interface IInvite extends IBasePerTenantAndOrganizationEntityModel {
+	token: string;
+	email: string;
+	roleId: string;
+	invitedById: string;
+	status: string;
+	expireDate: Date;
+	actionDate?: Date;
+	role?: IRole;
+	invitedBy?: IUser;
+	organizationContacts?: IOrganizationContact[];
+	departments?: IOrganizationDepartment[];
+}
+
+export interface IInviteAcceptInput extends IUserRegistrationInput {
+	inviteId: string;
+	organization: IOrganization;
+	originalUrl?: string;
+}
+
+export interface IInviteResendInput {
+	id: string;
+	invitedById: string;
+	email: string;
+	roleName: string;
+	organization: IOrganization;
+	departmentNames?: string[];
+	clientNames?: string[];
+	inviteType: any;
+
+}
+
+export interface ICreateEmailInvitesInput
+	extends IBasePerTenantAndOrganizationEntityModel {
+	emailIds: string[];
+	projectIds?: string[];
+	organizationContactIds?: string[];
+	departmentIds?: string[];
+	roleId: string;
+	invitedById: string;
+	inviteType: any;
+	startedWorkOn: Date;
+	appliedDate?: Date;
+	invitationExpirationPeriod?: number | string;
+}
+
+export interface ICreateOrganizationContactInviteInput
+	extends IBasePerTenantAndOrganizationEntityModel {
+	emailId: string;
+	organizationContactId: string;
+	roleId: string;
+	invitedById: string;
+	originalUrl: string;
+	languageCode: LanguagesEnum;
+}
+
+export interface ICreateEmailInvitesOutput {
+	items: IInvite[];
+	total: number;
+	ignored: number;
+}
+
+export interface IInviteFindInput
+	extends IBasePerTenantAndOrganizationEntityModel {
+	invitationType?: InvitationTypeEnum;
+}
+
+export interface IPublicInviteFindInput {
+	email: string;
+	token: string;
+}
+
+export interface IInviteUpdateInput {
+	status: InviteStatusEnum;
+}
+
+export enum InviteStatusEnum {
+	INVITED = 'INVITED',
+	ACCEPTED = 'ACCEPTED'
+}
+
+export enum InvitationTypeEnum {
+	USER = 'USER',
+	EMPLOYEE = 'EMPLOYEE',
+	CANDIDATE = 'CANDIDATE'
+}
+
+export enum InvitationExpirationEnum {
+	DAY = 1,
+	WEEK = 7,
+	TWO_WEEK = 14,
+	MONTH = 30,
+	NEVER = 'Never'
+}
+
+export interface IInviteViewModel {
+	email: string;
+	expireDate: string;
+	createdDate: string;
+	imageUrl: string;
+	fullName: string;
+	roleName?: string;
+	status: string;
+	projectNames: string[];
+	clientNames: string[];
+	departmentNames: string[];
+	id: string;
+	inviteUrl: string;
+}
+
+export interface IInviteUserModel
+	extends IBasePerTenantAndOrganizationEntityModel {
+	email: string;
+	role: string;
+	registerUrl: string;
+	languageCode: LanguagesEnum;
+	invitedBy: IUser;
+	originUrl?: string;
+}
+export interface IInviteEmployeeModel
+	extends IBasePerTenantAndOrganizationEntityModel {
+	email: string;
+	registerUrl: string;
+	languageCode: LanguagesEnum;
+	invitedBy: IUser;
+	organizationContacts?: IOrganizationContact[];
+	departments?: IOrganizationDepartment[];
+	originUrl?: string;
+}
+
+export interface IJoinEmployeeModel extends IBasePerTenantAndOrganizationEntityModel {
+    email: string;
+    employee: IEmployee;
+    organization: IOrganization;
+    languageCode: LanguagesEnum;
+}

package/src/language.model.ts

@@ -0,0 +1,22 @@
+import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
+
+export interface ILanguage extends IBasePerTenantAndOrganizationEntityModel {
+	name?: string;
+	code?: string;
+	is_system?: boolean;
+	description?: string;
+	color?: string;
+	isSelected?: boolean;
+}
+
+export interface ILanguageName {
+	name?: string;
+}
+
+export interface ILanguageFindInput {
+	name?: string;
+	code?: string;
+	is_system?: boolean;
+	description?: string;
+	color?: string;
+}