@metad/contracts 3.6.0-beta.1 → 3.6.0

package/src/analytics/ai.ts

@@ -1,79 +0,0 @@
-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

@@ -1,40 +0,0 @@
-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

@@ -1,43 +0,0 @@
-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

@@ -1,20 +0,0 @@
-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

@@ -1,12 +0,0 @@
-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

@@ -1,16 +0,0 @@
-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

@@ -1,22 +0,0 @@
-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

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

package/src/analytics/comment.model.ts

@@ -1,14 +0,0 @@
-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

@@ -1,19 +0,0 @@
-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

@@ -1,72 +0,0 @@
-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

@@ -1,18 +0,0 @@
-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

@@ -1,19 +0,0 @@
-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

@@ -1,15 +0,0 @@
-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

@@ -1,30 +0,0 @@
-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

@@ -1,39 +0,0 @@
-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 }

package/src/analytics/indicator-app.ts

@@ -1,49 +0,0 @@
-import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model'
-
-/**
- * Store user states for the indicator app
- */
-export interface IIndicatorApp extends IBasePerTenantAndOrganizationEntityModel {
-  options?: {
-    /**
-     * The indicators user favorited
-     */
-    favorites?: string[];
-    /**
-     * The order of the indicators user sorted
-     */
-    order?: string[];
-    /**
-     * Time granularity
-     */
-    timeGranularity?: TimeGranularity;
-    /**
-     * Limit the lookback period in trend analysis for every time granularity
-     */
-    lookback?: Record<TimeGranularity, number>;
-    /**
-     * Tag type show in indicator list
-     */
-    tagType?: IndicatorTagEnum;
-
-    /**
-     * Periods for detail view
-     */
-    detailPeriods?: string
-  }
-}
-
-export enum TimeGranularity {
-  Year = 'Year',
-  Quarter = 'Quarter',
-  Month = 'Month',
-  Week = 'Week',
-  Day = 'Day'
-  // @todo more
-}
-
-export enum IndicatorTagEnum {
-  UNIT,
-  MOM,
-  YOY
-}

package/src/analytics/indicator.ts

@@ -1,127 +0,0 @@
-import { EmbeddingStatusEnum } from '../ai'
-import { ITag } from '../tag-entity.model'
-import { ChecklistItem } from '../types'
-import { Visibility } from '../visibility.model'
-import { IBusinessArea } from './business-area'
-import { ICertification } from './certification.model'
-import { IComment } from './comment.model'
-import { IPermissionApproval } from './permission-approval.model'
-import { IBasePerProjectEntityModel } from './project.model'
-import { ISemanticModel } from './semantic-model'
-
-/**
- * Common fields of Indicator (draft and entity)
- */
-export type TIndicator = {
-  // Indicator business code
-  code?: string
-  // Name of the indicator
-  name?: string
-  /**
-   * Indicator Type
-   */
-  type?: IndicatorType
-  /**
-   * Visible in model
-   */
-  visible?: boolean
-
-  /**
-   * Available in indicator market app
-   */
-  isApplication?: boolean
-
-  modelId?: string
-  
-  entity?: string
-  unit?: string
-  principal?: string
-  /**
-   * @deprecated use certificationId
-   */
-  authentication?: string
-  
-  certificationId?: string
-
-  validity?: string
-  business?: string
-
-  options?: {
-    dimensions?: Array<string>
-    filters?: Array<any>
-    formula?: string
-    measure?: string
-    aggregator?: string
-    calendar?: string
-  }
-
-  businessAreaId?: string
-}
-
-export type TIndicatorDraft = TIndicator & {
-  checklist?: ChecklistItem[]
-  version?: number
-  savedAt?: Date
-}
-
-export interface IIndicator extends IBasePerProjectEntityModel, TIndicator {
-  draft?: TIndicatorDraft
-  /**
-   * Is active: Activate / Deactivate
-   * 
-   * @deprecated use status instead
-   */
-  isActive?: boolean
-  
-  /**
-   * Visibilty in public or secret or private
-   */
-  visibility?: Visibility
-
-  model?: ISemanticModel
-  /**
-   * Quality Certification
-   */
-  certification?: ICertification
-  
-  status?: IndicatorStatusEnum
-  embeddingStatus?: EmbeddingStatusEnum
-  error?: string
-  
-  businessArea?: IBusinessArea
-
-  permissionApprovals?: IPermissionApproval[]
-  tags?: ITag[]
-  comments?: IComment[]
-}
-
-export const IndicatorOptionFields = ['dimensions', 'filters', 'formula', 'measure', 'aggregator', 'calendar']
-
-/**
- * Indicator Type:
- * * Basic indicators
- * * Derivative Indicators
- */
-export enum IndicatorType {
-  BASIC = 'BASIC',
-  DERIVE = 'DERIVE'
-}
-
-/**
- * Status of the indicator
- */
-export enum IndicatorStatusEnum {
-  /**
-   * draft
-   */
-  DRAFT = 'DRAFT',
-
-  /**
-   * Published
-   */
-  RELEASED = 'RELEASED',
-  /**
-   * Offline Archive
-   */
-  ARCHIVED = 'ARCHIVED'
-}