@metad/contracts 3.6.0 → 3.6.1

package/src/ai/xpert.utils.ts

@@ -0,0 +1,214 @@
+import { IPoint } from '../types'
+import { IXpertAgent } from './xpert-agent.model'
+import { IXpert, TXpertTeamNode } from './xpert.model'
+
+// Helpers
+export function omitXpertRelations(xpert: Partial<IXpert>) {
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  const { draft, agent, agents, executors, leaders, knowledgebases, toolsets, managers, ...rest } = xpert ?? {}
+  return rest
+}
+
+export function figureOutXpert(xpert: IXpert, isDraft: boolean) {
+  return (isDraft ? xpert.draft?.team : xpert) ?? xpert
+}
+
+export function xpertLabel(agent: Partial<IXpert>) {
+  return agent.title || agent.name
+}
+
+export function createXpertGraph(xpert: IXpert, position: IPoint) {
+  const graph = xpert.graph ?? xpert.draft
+
+  const { nodes, size } = locateNodes(graph.nodes, position)
+
+  return { nodes, size, connections: graph.connections }
+}
+
+export function locateNodes(nodes: TXpertTeamNode[], position: IPoint) {
+  // Extract the area by positions of all nodes
+  const positions = nodes.map((node) => node.position)
+  const x0Positions = positions.map((pos) => pos.x)
+  const x1Positions = nodes.map((node) => node.position.x + (node.size?.width ?? 240)) // Node width min 240
+  const y0Positions = positions.map((pos) => pos.y)
+  const y1Positions = nodes.map((node) => node.position.y + (node.size?.height ?? 70)) // Node height min 70
+
+  const xRange = {
+    min: Math.min(...x0Positions),
+    max: Math.max(...x1Positions)
+  }
+
+  const yRange = {
+    min: Math.min(...y0Positions),
+    max: Math.max(...y1Positions)
+  }
+
+  const size = {
+    width: xRange.max - xRange.min + 50,
+    height: yRange.max - yRange.min + 80
+  }
+
+  nodes.forEach((node) => {
+    node.position = {
+      x: position.x + (node.position?.x ? node.position.x - xRange.min : 0) + 10,
+      y: position.y + (node.position?.y ? node.position.y - yRange.min : 0) + 40
+    }
+  })
+
+  return { size, nodes }
+}
+
+/**
+ * Create all nodes of xpert and it's area size
+ *
+ * @param xpert
+ * @returns
+ */
+export function createXpertNodes(xpert: IXpert, position: IPoint) {
+  const nodes: TXpertTeamNode[] = []
+  const agents = []
+  if (!xpert.agent.options?.hidden) {
+    agents.push(xpert.agent)
+  }
+  if (xpert.agents?.length) {
+    agents.push(...xpert.agents)
+  }
+  // Agents
+  nodes.push(
+    ...agents.map((_) => {
+      return {
+        type: 'agent',
+        key: _.key,
+        position: xpert.options?.agent?.[_.key]?.position ?? { x: 0, y: 0 },
+        size: xpert.options?.agent?.[_.key]?.size,
+        entity: _
+      } as TXpertTeamNode
+    })
+  )
+
+  // External experts
+  xpert.executors?.forEach((executor) => {
+    const position = xpert.options?.xpert?.[executor.id]?.position ?? { x: 0, y: 0 }
+    const executorGraph = createXpertNodes(executor, position)
+    nodes.push({
+      type: 'xpert',
+      key: executor.id,
+      position,
+      size: executorGraph.size,
+      entity: executor,
+      nodes: executorGraph.nodes
+    } as TXpertTeamNode)
+  })
+
+  // knowledgebases
+  nodes.push(
+    ...(xpert.knowledgebases ?? []).map((x) => {
+      return {
+        key: x.id,
+        type: 'knowledge',
+        position: xpert.options?.knowledge?.[x.id]?.position ?? { x: 0, y: 0 },
+        size: xpert.options?.knowledge?.[x.id]?.size,
+        entity: x
+      } as TXpertTeamNode
+    })
+  )
+
+  // Toolsets
+  nodes.push(
+    ...(xpert.toolsets ?? []).map((x) => {
+      return {
+        key: x.id,
+        type: 'toolset',
+        position: xpert.options?.toolset?.[x.id]?.position ?? { x: 0, y: 0 },
+        size: xpert.options?.toolset?.[x.id]?.size,
+        entity: x
+      } as TXpertTeamNode
+    })
+  )
+
+  // Extract the area by positions of all nodes
+  const positions = nodes.map((node) => node.position)
+  const x0Positions = positions.map((pos) => pos.x)
+  const x1Positions = nodes.map((node) => node.position.x + (node.size?.width ?? 240)) // Node width min 240
+  const y0Positions = positions.map((pos) => pos.y)
+  const y1Positions = nodes.map((node) => node.position.y + (node.size?.height ?? 70)) // Node height min 70
+
+  const xRange = {
+    min: Math.min(...x0Positions),
+    max: Math.max(...x1Positions)
+  }
+
+  const yRange = {
+    min: Math.min(...y0Positions),
+    max: Math.max(...y1Positions)
+  }
+
+  const size = {
+    width: xRange.max - xRange.min + 50,
+    height: yRange.max - yRange.min + 80
+  }
+
+  nodes.forEach((node) => {
+    node.position = {
+      x: position.x + (node.position?.x ? node.position.x - xRange.min : 0) + 10,
+      y: position.y + (node.position?.y ? node.position.y - yRange.min : 0) + 40
+    }
+  })
+
+  return { nodes, size }
+}
+
+export function createAgentConnections(agent: IXpertAgent, collaborators: IXpert[]) {
+  const connections = []
+  const from = agent.leaderKey
+  const to = agent.key
+  if (from && to) {
+    connections.push({
+      type: 'agent',
+      key: from + '/' + to,
+      from,
+      to
+    })
+  }
+
+  // collaborators
+  agent.collaboratorNames?.forEach((name) => {
+    const collaborator = collaborators.find((_) => _.name === name)
+    if (collaborator) {
+      const from = agent.key
+      const to = collaborator.id
+      connections.push({
+        type: 'xpert',
+        key: from + '/' + to,
+        from,
+        to
+      })
+    }
+  })
+
+  // knowledgebases
+  agent.knowledgebaseIds?.forEach((knowledgebaseId) => {
+    const from = agent.key
+    const to = knowledgebaseId
+    connections.push({
+      type: 'knowledge',
+      key: from + '/' + to,
+      from,
+      to
+    })
+  })
+
+  // toolsets
+  agent.toolsetIds?.forEach((toolsetId) => {
+    const from = agent.key
+    const to = toolsetId
+    connections.push({
+      type: 'toolset',
+      key: from + '/' + to,
+      from,
+      to
+    })
+  })
+
+  return connections
+}

package/src/analytics/ai.ts

@@ -0,0 +1,79 @@
+export enum ChatDashboardMessageType {
+    /**
+     * Display data preview using analytical card event
+     */
+    AnalyticalCard = 'AnalyticalCard',
+    /**
+     * Create or edit a cube event
+     */
+    Cube = 'Cube',
+    /**
+     * Edit a virtual cube event
+     */
+    VirtualCube = 'VirtualCube',
+    /**
+     * Create or edit members (calculated members or dimension sets) event
+     */
+    Members = 'Members',
+    /**
+     * List indicators event
+     */
+    ListIndicators = 'ListIndicators',
+    /**
+     * Create or edit an indicator event
+     */
+    Indicator = 'Indicator',
+
+    Indicators = 'Indicators',
+}
+
+export enum BIInterruptMessageType {
+    SwitchProject = 'switch_project',
+    SwitchSemanticModel = 'switch_semantic_model',
+    DeleteArtifact = 'delete_artifact',
+}
+
+export type TMessageContentCube = {
+    type: ChatDashboardMessageType.Cube,
+    data: {
+        modelId: string
+        cubeName: string
+    }
+}
+
+export type TMessageContentVirtualCube = {
+    type: ChatDashboardMessageType.VirtualCube,
+    data: {
+        modelId: string
+        cubeName: string
+    }
+}
+
+export type TMessageContentMembers = {
+    type: ChatDashboardMessageType.Members,
+    data: {
+        modelId: string
+        cubeName: string
+        members: {
+            __id__: string
+            name: string
+            label?: string
+            caption?: string
+            description?: string
+            formula: string
+            formatting?: {
+                unit?: string;
+                decimal?: number;
+            }
+        }[]
+    }
+}
+
+export type TMessageContentIndicator = {
+    type: ChatDashboardMessageType.Indicator,
+    data: {
+        modelId?: string
+        cubeName?: string
+        indicatorId: string
+    }
+}

package/src/analytics/approval-policy.model.ts

@@ -0,0 +1,40 @@
+import { IBasePerTenantAndOrganizationEntityModel } from "../base-entity.model";
+
+export interface IApprovalPolicy
+	extends IBasePerTenantAndOrganizationEntityModel {
+	name: string;
+	description: string;
+	approvalType: string;
+}
+
+export interface IApprovalPolicyFindInput
+	extends IBasePerTenantAndOrganizationEntityModel {
+	name?: string;
+	description?: string;
+	approvalType?: string;
+}
+
+export interface IApprovalPolicyCreateInput
+	extends IApprovalPolicyFindInput {
+	name?: string;
+}
+
+export interface IApprovalPolicyUpdateInput
+	extends IApprovalPolicyCreateInput {
+	id?: string;
+}
+
+export enum ApprovalPolicyTypesEnum {
+	TIME_OFF = 1,
+	EQUIPMENT_SHARING = 2,
+	BUSINESS_TRIP = 3
+}
+
+export enum ApprovalPolicyTypesStringEnum {
+	TIME_OFF = 'TIME_OFF',
+	EQUIPMENT_SHARING = 'EQUIPMENT_SHARING',
+	BUSINESS_TRIP = 'BUSINESS_TRIP',
+	INDICATOR = 'INDICATOR',
+	STORY = 'STORY',
+	BUSINESS_AREA = 'BUSINESS_AREA',
+}

package/src/analytics/business-area-user.model.ts

@@ -0,0 +1,43 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model';
+import { LanguagesEnum, IUser } from '../user.model';
+import { IBusinessArea } from './business-area';
+
+export enum BusinessAreaRole {
+	Adminer,
+	Modeler,
+	Viewer
+}
+
+export interface IBusinessAreaUser
+	extends IBasePerTenantAndOrganizationEntityModel {
+	businessAreaId: string
+	businessArea?: IBusinessArea
+	userId: string;
+	isDefault: boolean;
+	isActive: boolean;
+	user?: IUser;
+	role: BusinessAreaRole
+}
+
+export interface IBusinessAreaUserFindInput
+	extends IBasePerTenantAndOrganizationEntityModel {
+	businessAreaId?: string
+	id?: string;
+	userId?: string;
+	isDefault?: boolean;
+	isActive?: boolean;
+}
+
+export interface IBusinessAreaUserCreateInput
+	extends IBasePerTenantAndOrganizationEntityModel {
+	businessAreaId: string
+	userId: string;
+	isDefault?: boolean;
+	isActive?: boolean;
+}
+
+export interface IBusinessAreaUserDeleteInput {
+	userbusinessAreaId: string;
+	requestingUser: IUser;
+	language?: LanguagesEnum;
+}

package/src/analytics/business-area.ts

@@ -0,0 +1,20 @@
+import { IBasePerTenantEntityModel } from "../base-entity.model";
+import { ITag } from "../tag-entity.model";
+import { IStory } from "./story";
+
+export interface IBusinessArea extends IBasePerTenantEntityModel {
+    type?: BusinessType
+    name?: string
+    parentId?: string
+    level?: number
+    tags?: ITag[]
+    stories?: Array<IStory>
+
+    children?: Array<IBusinessArea>
+}
+
+export enum BusinessType {
+    SEMANTIC_MODEL = 'SEMANTIC_MODEL',
+    STORY = 'STORY',
+    INDICATOR = 'INDICATOR'
+}

package/src/analytics/certification.model.ts

@@ -0,0 +1,12 @@
+import { IBasePerTenantEntityModel } from '../base-entity.model'
+import { IUser } from '../user.model'
+
+export interface ICertification extends IBasePerTenantEntityModel {
+  name?: string
+  description?: string
+  /**
+   * Certification owner
+   */
+  owner?: IUser
+  ownerId?: string
+}

package/src/analytics/chatbi-conversation.model.ts

@@ -0,0 +1,16 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model'
+import { IIndicator } from './indicator'
+
+export interface IChatBIConversation extends IBasePerTenantAndOrganizationEntityModel {
+  key: string
+  name?: string
+  modelId?: string
+  entity?: string
+  command?: string
+  options?: {
+    messages: any[]
+    indicators?: IIndicator
+    answer?: any
+    examples: string[]
+  }
+}

package/src/analytics/chatbi-model.model.ts

@@ -0,0 +1,22 @@
+import { IXpert } from '../ai'
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model'
+import { IIntegration } from '../integration.model'
+import { ISemanticModel } from './semantic-model'
+
+export interface IChatBIModel extends IBasePerTenantAndOrganizationEntityModel {
+  modelId: string
+  model?: ISemanticModel
+  entity: string
+  entityCaption?: string
+  entityDescription?: string
+  visits?: number
+  options?: ChatBIModelOptions
+
+  // ManyToMany
+  xperts?: IXpert[]
+  integrations?: IIntegration[]
+}
+
+export type ChatBIModelOptions = {
+  suggestions: string[]
+}

package/src/analytics/collection.model.ts

@@ -0,0 +1,8 @@
+import { IBasePerProjectEntityModel } from './project.model'
+
+
+export interface ICollection extends IBasePerProjectEntityModel {
+  name?: string
+  parentId?: string
+  level?: number
+}

package/src/analytics/comment.model.ts

@@ -0,0 +1,14 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model'
+import { IIndicator } from './indicator'
+
+
+export interface IComment extends IBasePerTenantAndOrganizationEntityModel {
+  content?: string
+  parentId?: string
+  level?: number
+
+  options?: any
+
+  indicatorId?: string
+  indicator?: IIndicator
+}

package/src/analytics/data-source-type.ts

@@ -0,0 +1,19 @@
+import { IBasePerTenantEntityModel } from '../base-entity.model'
+
+export interface IDataSourceType extends IBasePerTenantEntityModel {
+  name?: string
+  type?: string
+  syntax?: DataSourceSyntaxEnum
+  protocol?: DataSourceProtocolEnum
+  configuration?: Record<string, unknown>
+}
+
+export enum DataSourceSyntaxEnum {
+  SQL = 'sql',
+  MDX = 'mdx'
+}
+
+export enum DataSourceProtocolEnum {
+  SQL = 'sql',
+  XMLA = 'xmla'
+}

package/src/analytics/data-source.ts

@@ -0,0 +1,72 @@
+import { IBasePerTenantAndOrganizationEntityModel, IBasePerTenantEntityModel } from '../base-entity.model'
+import { IUser } from '../user.model'
+import { IDataSourceType } from './data-source-type'
+import { ISemanticModel } from './semantic-model'
+
+export interface IDataSource extends IBasePerTenantAndOrganizationEntityModel {
+  name?: string
+  typeId?: string
+  type?: IDataSourceType
+  useLocalAgent?: boolean
+  authType?: AuthenticationEnum
+
+  options?: Record<string, unknown>
+
+  models?: ISemanticModel[]
+  authentications?: IDataSourceAuthentication[]
+}
+
+export interface IDataSourceAuthentication extends IBasePerTenantEntityModel {
+  dataSourceId: string
+  userId: string
+  username: string
+  password: string
+  validUntil?: Date
+
+  dataSource?: IDataSource
+  user?: IUser
+}
+
+export enum AuthenticationEnum {
+  NONE = 'NONE',
+  BASIC = 'BASIC'
+}
+
+export enum DataSourceTypeEnum {
+  NONE = 'NONE',
+}
+
+export interface IDSSchema {
+  catalog?: string
+  schema?: string
+  name: string
+  label?: string
+  type?: string
+  tables?: Array<IDSTable>
+}
+
+export interface IDSTable {
+  schema?: string
+  name?: string
+  label?: string
+  columns?: Array<IColumnDef>
+}
+
+export interface IColumnDef {
+  name: string
+  label?: string
+  /**
+   * Types in javascript
+   */
+  type: 'number' | 'string' | 'boolean'
+  /**
+   * Original data type in database
+   */
+  dataType: string
+  nullable?: boolean
+  position?: number
+  /**
+   * 应该等同于 label
+   */
+  comment?: string
+}

package/src/analytics/favorite.ts

@@ -0,0 +1,18 @@
+import { BusinessType } from './business-area'
+import { IIndicator } from './indicator'
+import { IBasePerProjectEntityModel } from './project.model'
+import { ISemanticModel } from './semantic-model'
+import { IStory } from './story'
+
+export interface IFavorite extends IBasePerProjectEntityModel {
+  type?: BusinessType
+
+  modelId?: string
+  model?: ISemanticModel
+
+  storyId?: string
+  story?: IStory
+
+  indicatorId?: string
+  indicator?: IIndicator
+}

package/src/analytics/features.ts

@@ -0,0 +1,19 @@
+export enum AnalyticsFeatures {
+	FEATURE_BUSINESS_AREA = 'FEATURE_BUSINESS_AREA',
+	FEATURE_INDICATOR = 'FEATURE_INDICATOR',
+	FEATURE_INDICATOR_MARKET = 'FEATURE_INDICATOR_MARKET',
+	FEATURE_INDICATOR_REGISTER = 'FEATURE_INDICATOR_REGISTER',
+	FEATURE_INDICATOR_APP = 'FEATURE_INDICATOR_APP',
+	FEATURE_STORY = 'FEATURE_STORY',
+	FEATURE_STORY_CREATION = 'FEATURE_STORY_CREATION',
+	FEATURE_STORY_VIEWER = 'FEATURE_STORY_VIEWER',
+	FEATURE_STORY_MARKET = 'FEATURE_STORY_MARKET',
+	FEATURE_MODEL = 'FEATURE_MODEL',
+	FEATURE_MODEL_CREATION = 'FEATURE_MODEL_CREATION',
+	FEATURE_MODEL_VIEWER = 'FEATURE_MODEL_VIEWER',
+	FEATURE_SUBSCRIPTION = 'FEATURE_SUBSCRIPTION',
+	FEATURE_HOME_TREND = 'FEATURE_HOME_TREND',
+	FEATURE_HOME_CATALOG = 'FEATURE_HOME_CATALOG',
+	FEATURE_PROJECT = 'FEATURE_PROJECT',
+	FEATURE_DATA_FACTORY = 'FEATURE_DATA_FACTORY'
+}

package/src/analytics/feed-model.ts

@@ -0,0 +1,15 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model'
+
+export interface IFeed extends IBasePerTenantAndOrganizationEntityModel {
+  type: FeedTypeEnum
+  entityId?: string
+  hidden?: boolean
+  options?: any
+}
+
+export enum FeedTypeEnum {
+  StoryWidget = 'StoryWidget',
+  IndicatorWidget = 'IndicatorWidget',
+  Recents = 'Recents',
+  Ranking = 'Ranking'
+}

package/src/analytics/gateway.ts

@@ -0,0 +1,30 @@
+import { TQueryOptions } from './model-query-log.model'
+
+export type TGatewayQueryEvent = {
+  id: string
+  organizationId: string
+  dataSourceId: string
+  modelId?: string
+  isDraft: boolean
+  body: {
+    /**
+     * @deprecated use statement
+     */
+    mdx?: string
+    statement?: string
+    query?: TQueryOptions
+    /**
+     * Is use indicators draft, corresponding to `DataSourceOptions['isIndicatorsDraft']` in the ocap framework.
+     */
+    isIndicatorsDraft?: boolean
+  }
+  acceptLanguage?: string
+  forceRefresh: boolean
+}
+
+export type TGatewayRespEvent = any
+
+export type TGatewayRespError = {
+  message: string
+  status: number
+}

package/src/analytics/index.ts

@@ -0,0 +1,39 @@
+import * as MDX from './schema'
+
+export * from './ai'
+export * from './business-area'
+export * from './business-area-user.model'
+export * from './collection.model'
+export * from './data-source'
+export * from './data-source-type'
+export * from './favorite'
+export * from './features'
+export * from './feed-model'
+export * from './indicator'
+export * from './indicator-app'
+export * from './indicator-market'
+export * from './model-query'
+export * from './notification-destination'
+export * from './role-permissions'
+export * from './semantic-model'
+export * from './semantic-model-entity'
+export * from './semantic-model-member'
+export * from './story'
+export * from './story-point'
+export * from './story-widget'
+export * from './subscription'
+export * from './visit.model'
+export * from './webSocket'
+export * from './approval-policy.model'
+export * from './permission-approval.model'
+export * from './permission-approval-user.model'
+export * from './project.model'
+export * from './comment.model'
+export * from './story-template.model'
+export * from './screenshot.model'
+export * from './certification.model'
+export * from './chatbi-conversation.model'
+export * from './chatbi-model.model'
+export * from './model-query-log.model'
+export * from './gateway'
+export { MDX }