@metad/contracts 3.6.7 → 3.7.0

package/src/analytics/screenshot.model.ts

@@ -1,28 +0,0 @@
-import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model'
-import { FileStorageProviderEnum } from '../file-provider'
-
-export interface IScreenshot extends IBasePerTenantAndOrganizationEntityModel {
-  file: string
-  url?: string
-  thumb?: string
-  /**
-   * @deprecated use url
-   */
-  fileUrl?: string
-  thumbUrl?: string
-  recordedAt?: Date
-  size?: number
-  storageProvider?: FileStorageProviderEnum
-}
-
-export interface IUpdateScreenshotInput extends ICreateScreenshotInput {
-  id: string
-}
-
-export interface ICreateScreenshotInput extends IBasePerTenantAndOrganizationEntityModel {
-  activityTimestamp: string
-  employeeId?: string
-  file: string
-  thumb?: string
-  recordedAt: Date | string
-}

package/src/analytics/semantic-model-entity.ts

@@ -1,50 +0,0 @@
-import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model'
-import { ScheduleTaskStatus, TScheduleOptions } from '../schedule';
-
-export type SemanticModelEntityOptions = {
-  vector: {
-    dimensions: string[];
-    // /**
-    //  * @deprecated use dimensions
-    //  */
-    // hierarchies?: string[];
-  };
-  members?: Record<string, number>;
-}
-
-export enum ModelEntityType {
-  Cube = 'cube',
-  Dimension = 'dimension'
-}
-
-/**
- * Job info
- */
-export type SemanticModelEntityJob = {
-  id: string | number
-  status?: 'completed' | 'failed' | 'processing' | 'cancel'
-  progress?: number
-  error?: string
-  createdAt?: Date
-  endAt?: Date
-  tokens?: number
-}
-
-export interface ISemanticModelEntity extends IBasePerTenantAndOrganizationEntityModel {
-  name?: string
-  caption?: string
-  type?: ModelEntityType
-  /**
-   * Schedule sync job into queue
-   */
-  schedule?: TScheduleOptions
-  timeZone?: string
-  status?: ScheduleTaskStatus
-
-  modelId?: string
-
-  // Storing semantic metadata
-  options?: SemanticModelEntityOptions
-
-  job?: SemanticModelEntityJob
-}

package/src/analytics/semantic-model-member.ts

@@ -1,49 +0,0 @@
-import { IBasePerTenantAndOrganizationEntityModel } from "../base-entity.model"
-import { ISemanticModel } from "./semantic-model"
-import { ISemanticModelEntity } from "./semantic-model-entity"
-
-export interface ISemanticModelMember extends IBasePerTenantAndOrganizationEntityModel {
-
-  modelId?: string
-  model?: ISemanticModel
-
-  entityId?: string
-  entity?: ISemanticModelEntity
-
-  cube: string
-
-  dimension: string
-
-  hierarchy: string
-
-  level: string
-
-  language: string
-
-  memberUniqueName: string
-
-  memberKey?: string
-
-  memberName: string
-
-  memberCaption: string
-
-  memberOrdinal: number
-
-  memberType: number
-
-  levelNumber: number
-
-  parentUniqueName: string
-
-  metadata?: {
-    tokens: number
-  }
-
-  // Has Vector
-  vector?: boolean
-}
-
-export function embeddingCubeCollectionName(modelKey: string, cube: string, isDraft?: boolean): string {
-	return `${modelKey}:${cube}${isDraft ? ':draft' : ''}`
-}

package/src/analytics/semantic-model.ts

@@ -1,237 +0,0 @@
-import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model'
-import { ITag } from '../tag-entity.model'
-import { ChecklistItem, IPoint, ISize } from '../types'
-import { IUser } from '../user.model'
-import { Visibility } from '../visibility.model'
-import { IBusinessArea } from './business-area'
-import { IDataSource } from './data-source'
-import { IIndicator } from './indicator'
-import { IModelQuery } from './model-query'
-import * as MDX from './schema'
-import { IStory } from './story'
-
-/**
- * Data agent types
- */
-export enum AgentType {
-  Local = 'local',
-  Browser = 'browser',
-  Server = 'server',
-  Wasm = 'wasm'
-}
-
-/**
- * Preferences of semantic model
- */
-export interface ISemanticModelPreferences {
-  // Cache
-  enableCache?: boolean
-  expires?: number
-  // preferred Language
-  language?: string
-  // Expose Xmla service for Semantic Model
-  exposeXmla?: boolean
-}
-
-/**
- * Model Schema Structured Data
- */
-export type TSemanticModelOptions<T = any /*Schema*/> = {
-  /**
-   * The schema for MDX cube, dimension and virtual cube
-   */
-  schema?: T
-  settings?: TSemanticModelSettings
-  /**
-   * Is embedded members of every `cube:dimension`
-   * Be cleaned up when publish
-   */
-  embedded?: Record<string, Record<string, boolean>>
-}
-
-export type TSemanticModel = {
-  key?: string
-  name?: string
-  description?: string
-  type?: string
-  agentType?: AgentType
-
-  dataSourceId?: string
-  businessAreaId?: string
-
-  catalog?: string
-  cube?: string
-  // Storing semantic metadata
-  options?: TSemanticModelOptions<any>
-
-  // Roles
-  roles?: Array<IModelRole>
-}
-
-/**
- * Common settings for semantic model space
- */
-export type TSemanticModelSettings = {
-  canvas?: {
-    position: IPoint
-    scale: number
-  };
-  nodes?: {key: string; position?: IPoint; size?: ISize}[]
-  /**
-   * @experimental A hierarchy of intermediate states that are not yet fixed
-   */
-  hierarchies?: any[] // PropertyHierarchy[]
-
-  /**
-   * Ignore unknown property when query model in story
-   */
-  ignoreUnknownProperty?: boolean
-}
-
-export type TSemanticModelDraft<T = any> = TSemanticModel & {
-  schema?: T
-  settings?: TSemanticModelSettings
-  savedAt?: Date
-  checklist?: ChecklistItem[]
-  version?: number
-
-  /**
-   * @legacy Table defination for wasm database
-   */
-  tables?: any[] // Array<TableEntity>
-  /**
-   * @legacy DB Initialization for wasm database
-   */
-  dbInitialization?: string
-
-  // Is embedded every `cube:dimension`
-  embedded?: Record<string, Record<string, boolean>>
-}
-
-export interface ISemanticModel extends IBasePerTenantAndOrganizationEntityModel, TSemanticModel {
-  /**
-   * Draft on current version
-   */
-  draft?: TSemanticModelDraft
-
-  /**
-   * Publish date of latest
-   */
-  publishAt?: Date
-  releaseNotes?: string
-
-  tags?: ITag[]
-  
-  dataSource?: IDataSource
-  
-  businessArea?: IBusinessArea
-  
-  // Storing model configuration
-  preferences?: ISemanticModelPreferences
-
-  visibility?: Visibility
-
-  status?: SemanticModelStatusEnum
-  /**
-   * Model owner, can be transfered
-   */
-  owner?: IUser
-  ownerId?: string
-
-  members?: IUser[]
-  // Stories
-  stories?: Array<IStory>
-  // Indicators
-  indicators?: Array<IIndicator>
-  // Query
-  queries?: Array<IModelQuery>
-
-  version?: number
-}
-
-/**
- * Types of semantic model
- */
-export enum ModelTypeEnum {
-  XMLA = 'XMLA',
-  SQL = 'SQL'
-}
-
-/**
- * Role in semantic model
- */
-export interface IModelRole extends IBasePerTenantAndOrganizationEntityModel {
-  modelId: string
-  model?: ISemanticModel
-  key: string
-  name: string
-  type?: null | '' | RoleTypeEnum
-  options: MDX.Role
-  index?: number
-  users?: IUser[]
-}
-
-/**
- * Role types
- */
-export enum RoleTypeEnum {
-  single = 'single',
-  union = 'union'
-}
-
-/**
- * Status of semantic model
- */
-export enum SemanticModelStatusEnum {
-  /**
-   * Using
-   */
-  Progressing = 'progressing',
-
-  /**
-   * Archived
-   */
-  Archived = 'archived'
-}
-
-export interface ISemanticModelCache extends IBasePerTenantAndOrganizationEntityModel {
-  key: string
-  language?: string
-  modelId?: string
-  model?: ISemanticModel
-  query?: string
-  data?: string
-}
-
-
-/**
- * @deprecated Equivalent to `VirtualCube` in the ocap framework
- */
-export type TVirtualCube = {
-  name: string
-  caption?: string
-  description?: string
-  cubeUsages: MDX.CubeUsage[]
-  virtualCubeDimensions: MDX.VirtualCubeDimension[]
-  virtualCubeMeasures: MDX.VirtualCubeMeasure[]
-  calculatedMembers: MDX.CalculatedMember[]
-}
-
-export function extractSemanticModelDraft<S>(model: TSemanticModel): TSemanticModelDraft<S> {
-  return {
-    key: model.key,
-    name: model.name,
-    description: model.description,
-    type: model.type,
-    agentType: model.agentType,
-
-    dataSourceId: model.dataSourceId,
-    businessAreaId: model.businessAreaId,
-
-    catalog: model.catalog,
-    cube: model.cube,
-    schema: model.options?.schema as S,
-    settings: model.options?.settings,
-    roles: model.roles,
-  }
-}

package/src/analytics/story-template.model.ts

@@ -1,34 +0,0 @@
-import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model'
-import { ITag } from '../tag-entity.model'
-import { IScreenshot } from './screenshot.model'
-import { IStory } from './story'
-
-export interface IStoryTemplate extends IBasePerTenantAndOrganizationEntityModel {
-  key?: string
-  name?: string
-  description?: string
-  type?: StoryTemplateType
-  isPublic?: boolean
-  
-  tags?: ITag[]
-
-  options?: {
-    story?: {
-      options?: Record<string, unknown>
-    }
-    pages?: any[]
-  }
-
-  storyId?: string
-  story?: IStory
-  previewId?: string
-  preview?: IScreenshot
-  thumbnail?: string
-  
-  storyCount?: number
-}
-
-export enum StoryTemplateType {
-  Template = 'Template',
-  Theme = 'Theme'
-}

package/src/analytics/story-widget.ts

@@ -1,15 +0,0 @@
-import { IBasePerTenantEntityModel } from '../base-entity.model'
-import { IStory } from './story'
-import { IStoryPoint } from './story-point'
-
-export interface IStoryWidget extends IBasePerTenantEntityModel {
-  key?: string
-  name?: string
-
-  storyId: string
-  story?: IStory
-  pointId: string
-  point?: IStoryPoint
-
-  options?: Record<string, unknown>
-}

package/src/analytics/story.ts

@@ -1,109 +0,0 @@
-import { ITag } from '../tag-entity.model'
-import { Visibility } from '../visibility.model'
-import { IBusinessArea } from './business-area'
-import { ICollection } from './collection.model'
-import { IFavorite } from './favorite'
-import { IBasePerProjectEntityModel } from './project.model'
-import { IScreenshot } from './screenshot.model'
-import { ISemanticModel } from './semantic-model'
-import { IStoryPoint } from './story-point'
-import { IStoryTemplate } from './story-template.model'
-
-export interface IStory extends IBasePerProjectEntityModel {
-  name?: string
-  description?: string
-  tags?: ITag[]
-
-  status?: StoryStatusEnum
-
-  collection?: ICollection
-  collectionId?: string
-  
-  /**
-   * Released story destination
-   */
-  businessArea?: IBusinessArea
-  businessAreaId?: string
-
-  modelId?: string
-  /**
-   * Story's models space
-   */
-  model?: ISemanticModel
-  /**
-   * Story relative models
-   */
-  models?: ISemanticModel[]
-
-  visibility?: Visibility
-
-  points?: IStoryPoint[]
-
-  options?: Record<string, unknown>
-
-  thumbnail?: string
-  previewId?: string
-  preview?: IScreenshot
-
-  templateId?: string
-  // From template
-  template?: IStoryTemplate
-  // Save as template
-  asTemplate?: IStoryTemplate
-
-  pv?: number
-}
-
-export enum StoryStatusEnum {
-  /**
-   * 草稿
-   */
-	DRAFT = 'DRAFT',
-  /**
-   * 重新编辑
-   */
-	CHANGING = 'CHANGING',
-  /**
-   * 审阅中
-   */
-	REVIEW = 'REVIEW',
-  /**
-   * 通过
-   */
-	APPROVED = 'APPROVED',
-  /**
-   * 退回
-   */
-	REJECTED = 'REJECTED',
-  /**
-   * 已发布
-   */
-	RELEASED = 'RELEASED',
-  /**
-   * 下线存档
-   */
-	ARCHIVED = 'ARCHIVED',
-}
-
-export interface Accessibility {
-  access?: AccessEnum
-  bookmark?: IFavorite
-}
-
-/**
- * 用户对某个实体的访问权限
- */
-export enum AccessEnum {
-  /**
-   * 可看到
-   */
-  View = 'View',
-  /**
-   * 可读取详情
-   */
-  Read = 'Read',
-  /**
-   * 可编辑
-   */
-  Write = 'Write'
-}

package/src/analytics/subscription.ts

@@ -1,43 +0,0 @@
-import { IBasePerTenantEntityModel } from "../base-entity.model";
-import { INotificationDestination } from "./notification-destination";
-import { IStory } from "./story";
-
-export interface ISubscription extends IBasePerTenantEntityModel {
-
-	name: string
-    type: SubscriptionType
-    description?: string
-    /**
-     * 启动订阅
-     */
-    enable?: boolean
-    storyId?: string
-    story?: IStory
-    pointId?: string
-    widgetId?: string
-    destinationId?: string
-    /**
-     * 目的地
-     */
-    destination?: INotificationDestination
-
-    selectedDateType?: string
-    sendDate?: string
-    sendTime?: string
-    miOffice?: boolean
-    selectedUser?: string
-    selectedGroup?: string
-    notifyEveryone?: boolean
-    subscriptionDetail?: string
-    navigationButton?: boolean
-    buttonDesc?: string
-    linkSetting?: string
-    linkUrl?: string
-
-	options?: Record<string, unknown>
-}
-
-export enum SubscriptionType {
-    CHART = 'CHART',
-    INDICATOR = 'INDICATOR'
-}

package/src/analytics/visit.model.ts

@@ -1,39 +0,0 @@
-import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model'
-import { IIndicator } from './indicator'
-import { ISemanticModel } from './semantic-model'
-import { IStory } from './story'
-
-export interface IVisit extends IBasePerTenantAndOrganizationEntityModel {
-  type: VisitTypeEnum
-  entity: VisitEntityEnum
-  entityId: string
-  entityName?: string
-  businessAreaId?: string
-  visitAt?: number
-  visits?: number
-
-  story?: IStory
-  model?: ISemanticModel
-  indicator?: IIndicator
-}
-
-export enum VisitEntityEnum {
-  DataSource = 'DataSource',
-  SemanticModel = 'SemanticModel',
-  Story = 'Story',
-  Widget = 'Widget',
-  Indicator = 'Indicator'
-}
-
-export enum VisitTypeEnum {
-  View = 'View',
-  Data = 'Data'
-}
-
-export interface IEntityVisits {
-  entity?: VisitEntityEnum
-  entityId: string
-  entityName: string
-  pv?: number
-  uv?: number
-}

package/src/analytics/webSocket.ts

@@ -1,53 +0,0 @@
-import { ISemanticModel } from "./semantic-model"
-
-export interface AgentEventRequest {
-    url?: string
-    headers: {
-      [key: string]: string[]
-    }
-    body?: any
-    catalog?: string
-    table?: string
-    forceRefresh?: boolean
-    auth?: {
-        username: string
-        password: string
-    }
-}
-export interface AgentEventResponse extends AgentEventRequest {
-    status: number
-    statusText: string
-}
-
-export enum AgentEventType {
-    request = 'request',
-    response = 'response',
-    error = 'error'
-}
-
-export interface AgentEvent {
-    type?: 'connected'
-    id: string
-    event: AgentEventType
-    data: {
-        organizationId?: string
-        dataSource?: {
-            id: string
-            name: string
-            type: string
-            updatedAt?: Date
-        }
-        modelId?: string
-        semanticModel?: ISemanticModel
-        request: AgentEventRequest
-        response?: AgentEventResponse
-        error?: string
-    }
-}
-
-export enum LocalAgentType {
-	TENANT,
-	USER
-}
-
-export const TENANT_AGENT_LOCAL_URL = 'agent-local-url'

package/src/api-key.model.ts

@@ -1,11 +0,0 @@
-import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model'
-
-export interface IApiKey extends IBasePerTenantAndOrganizationEntityModel {
-  token: string
-  name?: string
-  type?: string
-  entityId?: string
-  validUntil?: Date
-  expired?: boolean
-  lastUsedAt?: Date
-}

package/src/base-entity.model.ts

@@ -1,34 +0,0 @@
-import { ITenant } from './tenant.model'
-import { IOrganization } from './organization.model'
-import { ID } from './types'
-import { IUser } from './user.model'
-
-// Common properties for entities with relations
-export interface IBaseRelationsEntityModel {
-	relations?: string[]; // List of related entities
-}
-
-export interface IBaseSoftDeleteEntityModel {
-  deletedAt?: Date
-}
-
-export interface IBaseEntityModel extends IBaseSoftDeleteEntityModel {
-  id?: ID
-
-  createdById?: ID
-  createdBy?: IUser
-  updatedById?: ID
-  updatedBy?: IUser
-  readonly createdAt?: Date
-  readonly updatedAt?: Date
-}
-
-export interface IBasePerTenantEntityModel extends IBaseEntityModel {
-  tenantId?: string
-  tenant?: ITenant
-}
-
-export interface IBasePerTenantAndOrganizationEntityModel extends IBasePerTenantEntityModel {
-  organizationId?: string
-  organization?: IOrganization
-}