@metad/contracts 3.6.2 → 3.6.7

package/src/analytics/schema.ts

@@ -0,0 +1,300 @@
+/**
+ * Here is the intermediate type definition converted from the actual schema type to the xmla file format.
+ * But the type definition here can also be referenced by the actual schema definition.
+ */
+
+export interface Schema {
+  name: string
+  description?: string
+  Cube: Cube[]
+  VirtualCube?: VirtualCube[]
+  Dimension?: Dimension[]
+  Role?: Role[]
+}
+
+export interface Cube {
+  __id__?: string
+  name: string
+  caption?: string
+  Table: Table[] | Table
+  View: View[] | View
+  DimensionUsage?: DimensionUsage[]
+  Dimension: Dimension[]
+  Measure: Measure[]
+  CalculatedMember?: CalculatedMember[]
+}
+
+export interface Table {
+  name: string
+}
+
+export interface View extends SQLExpression {
+  alias: string
+  _?: string
+}
+
+/**
+ * Mondrian 仅支持三种 Dimension 类型,
+ * 更丰富的语义可以通过 Semantics 来定义
+ */
+export enum DimensionType {
+  StandardDimension = 'StandardDimension',
+  TimeDimension = 'TimeDimension',
+  MeasuresDimension = 'MeasuresDimension'
+}
+
+export interface Dimension {
+  __id__?: string
+  name: string
+  label?: string
+  foreignKey?: string
+  type?: DimensionType
+  caption?: string
+  description?: string
+  Hierarchy: Hierarchy[]
+}
+
+export interface DimensionUsage {
+  __id__?: string
+  name: string
+  source: string
+  foreignKey: string
+  caption?: string
+  description?: string
+}
+
+export interface Hierarchy {
+  __id__?: string
+  name?: string
+  label?: string
+  hasAll: boolean
+  allMemberName?: string
+  defaultMember?: string
+  primaryKey: string
+  primaryKeyTable?: string
+  Table?: Table[] | Table
+  Level?: Level[]
+  Join?: Join
+}
+
+export interface Level {
+  __id__?: string
+  name: string
+  label?: string
+  column: string
+  nameColumn?: string
+  ordinalColumn?: string
+  parentColumn?: string
+  nullParentValue?: number
+  uniqueMembers: boolean
+  type?: string
+  table?: string
+  Closure?: Closure
+  KeyExpression?: KeyExpression
+  NameExpression?: NameExpression
+  CaptionExpression?: CaptionExpression
+  OrdinalExpression?: OrdinalExpression
+  ParentExpression?: ParentExpression
+  Property?: Property[]
+}
+
+export interface SQLExpression {
+  SQL: SQL | SQL[]
+}
+
+export interface KeyExpression {
+  SQL: SQL
+}
+
+export interface NameExpression {
+  SQL: SQL
+}
+
+export interface CaptionExpression {
+  SQL: SQL
+}
+
+export interface OrdinalExpression {
+  SQL: SQL
+}
+
+export interface ParentExpression {
+  SQL: SQL
+}
+
+export interface SQL {
+  dialect: string
+  _?: string
+}
+
+export interface Property {
+  name: string
+  column: string
+  PropertyExpression?: SQLExpression
+}
+
+export interface Closure {
+  parentColumn: string
+  childColumn: string
+  Table: Table
+}
+
+export interface Measure {
+  __id__?: string
+  name: string
+  caption?: string
+  label?: string
+  column: string
+  aggregator: string
+  formatString?: string
+  MeasureExpression?: MeasureExpression
+}
+
+export interface MeasureExpression {
+  SQL: SQL
+}
+
+export interface CalculatedMember {
+  __id__?: string
+  name: string
+  caption?: string
+  description?: string
+  dimension?: string
+  hierarchy?: string
+  // formula: string
+  Formula?: string | string[]
+  parent?: string
+  visible?: boolean
+  CalculatedMemberProperty?: CalculatedMemberProperty[]
+}
+
+export interface CalculatedMemberProperty {
+  name: string
+  caption?: string
+  description?: string
+  expression?: string
+  value: string
+}
+
+export interface NamedSet {
+  name: string
+  caption?: string
+  description?: string
+  formula?: string
+  Formula?: string[]
+}
+
+export interface Join {
+  leftKey?: string
+  rightAlias?: string
+  rightKey?: string
+  Table?: Table | Table[]
+  Join?: Join
+}
+
+// VirtualCube
+export interface VirtualCube {
+  name: string
+  caption?: string
+  description?: string
+  CubeUsages: {
+    CubeUsage: CubeUsage[] | CubeUsage
+  }
+  VirtualCubeDimension: VirtualCubeDimension[] | VirtualCubeDimension
+  VirtualCubeMeasure: VirtualCubeMeasure[] | VirtualCubeMeasure
+  CalculatedMember: CalculatedMember[] | CalculatedMember
+}
+
+export interface CubeUsage {
+  cubeName: string
+  ignoreUnrelatedDimensions?: boolean
+}
+
+export interface VirtualCubeDimension {
+  cubeName: string
+  cubeCaption?: string
+  __shared__?: boolean
+  name: string
+  /**
+   * @deprecated use caption
+   */
+  label?: string
+  caption?: string
+}
+
+export interface VirtualCubeMeasure {
+  cubeName: string
+  cubeCaption?: string
+  name: string
+  /**
+   * @deprecated use caption
+   */
+  label?: string
+  caption?: string
+  visible: boolean
+}
+
+export interface Role {
+  name: string
+  SchemaGrant?: SchemaGrant[]
+  schemaGrant?: SchemaGrant
+  // Union roles
+  roleUsages?: string[]
+}
+
+/**
+ * enumerates the allowable access rights.
+ */
+export enum Access {
+  /**
+   * No access to an object and its children.
+   */
+  none = 'none',
+  /**
+   * A grant that covers none of the children unless explicitly granted.
+   */
+  custom = 'custom',
+  /**
+   * Access to all shared dimensions (applies to schema grant).
+   */
+  all_dimensions = 'all_dimensions',
+  /**
+   * All access to an object and its children.
+   */
+  all = 'all',
+}
+
+export enum RollupPolicy {
+  full = 'full',
+  partial = 'partial',
+  hidden = 'hidden'
+}
+
+export interface SchemaGrant {
+  access: Access
+  cubeGrants: CubeGrant[]
+}
+
+export interface CubeGrant {
+  cube: string
+  access: Access
+  hierarchyGrants: HierarchyGrant[]
+}
+
+export interface HierarchyGrant {
+  hierarchy: string
+  caption?: string
+  access: Access
+  rollupPolicy: RollupPolicy
+  topLevel: string
+  topLevelCaption?: string
+  bottomLevel: string
+  bottomLevelCaption?: string
+  memberGrants: MemberGrant[]
+}
+
+export interface MemberGrant {
+  member: string
+  caption?: string
+  access: Access
+}

package/src/analytics/screenshot.model.ts

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

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

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

@@ -0,0 +1,237 @@
+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-point.d.ts → story-point.ts}

@@ -1,11 +1,16 @@
 import { IStoryWidget } from './story-widget';
 import { IBasePerTenantEntityModel } from '../base-entity.model';
 import { IStory } from './story';
+
+
 export interface IStoryPoint extends IBasePerTenantEntityModel {
-    key?: string;
-    name?: string;
-    storyId: string;
-    story?: IStory;
-    options?: Record<string, unknown>;
-    widgets?: IStoryWidget[];
+	key?: string
+	name?: string
+
+	storyId: string
+	story?: IStory
+
+	options?: Record<string, unknown>
+
+	widgets?: IStoryWidget[]
 }

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

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