@metad/contracts 3.6.1 → 3.6.2

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'
-}

package/src/analytics/model-query-log.model.ts

@@ -1,45 +0,0 @@
-import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model'
-import { IIndicator } from './indicator'
-import { ISemanticModel } from './semantic-model'
-
-export type TQueryOptions = {
-  rows?: any
-  columns?: any
-  cube?: string
-  /**
-   * Indicators modified by the client
-   */
-  indicators?: IIndicator[]
-  calculatedMeasures?: any[] // CalculatedProperty[]
-} & Record<string, any>
-
-export enum QueryStatusEnum {
-  PENDING = 'pending', // Query submitted, waiting for execution
-  RUNNING = 'running', // Query is executing
-  SUCCESS = 'success', // Query succeeded
-  FAILED = 'failed',   // Query failed
-}
-
-
-export interface ISemanticModelQueryLog extends IBasePerTenantAndOrganizationEntityModel {
-  /**
-   * Unique ID of the client query
-   */
-  key?: string
-  modelId: string
-  model?: ISemanticModel
-  cube?: string
-  status: QueryStatusEnum
-  /**
-   * Structural parameters for query
-   */
-  params: TQueryOptions
-  /**
-   * Statement of query
-   */
-  query?: string
-  result: any
-  executionTime: number; // Execution time (milliseconds)
-  waitingTime: number; // Query waiting time (milliseconds)
-  error?: string
-}

package/src/analytics/model-query.ts

@@ -1,22 +0,0 @@
-import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model'
-import { ISemanticModel } from './semantic-model'
-
-export interface IModelQuery extends IBasePerTenantAndOrganizationEntityModel {
-  key: string
-  modelId: string
-  model?: ISemanticModel
-  name: string
-  /**
-   * Index of the query in the list of queries in model
-   */
-  index?: number
-  /**
-   * The details
-   */
-  options?: {
-    type?: 'sql' | 'mdx'
-    entities?: string[]
-    statement?: string
-    conversations?: any[]
-  }
-}

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

@@ -1,58 +0,0 @@
-import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model'
-import { ITag } from '../tag-entity.model'
-import { IUser } from '../user.model'
-import { ApprovalPolicyTypesStringEnum, IApprovalPolicy } from './approval-policy.model'
-import { IIndicator } from './indicator'
-import { IPermissionApprovalUser } from './permission-approval-user.model'
-
-export interface IPermissionApproval extends IBasePerTenantAndOrganizationEntityModel {
-  status: number
-  // createdBy: string;
-  createdByName: string
-  min_count: number
-  permissionId: string
-  permissionType: ApprovalPolicyTypesStringEnum
-  approvalPolicy: IApprovalPolicy
-  approvalPolicyId: string
-  indicator: IIndicator
-  indicatorId: string
-  userApprovals?: IPermissionApprovalUser[]
-  // employeeApprovals?: IPermissionApprovalEmployee[];
-  // teamApprovals?: IPermissionApprovalTeam[];
-  tags?: ITag[]
-  // employees?: IEmployee[];
-  // teams?: IOrganizationTeam[];
-}
-
-export interface IPermissionApprovalCreateInput extends IBasePerTenantAndOrganizationEntityModel {
-  id?: string
-  userApprovals?: IPermissionApprovalUser[]
-  users?: IUser[]
-  permissionType?: ApprovalPolicyTypesStringEnum
-  permissionId?: string
-  indicatorId?: string
-  status?: number
-  approvalPolicyId?: string
-  tags?: ITag[]
-}
-
-export enum PermissionApprovalStatusTypesEnum {
-  REQUESTED = 1,
-  APPROVED = 2,
-  REFUSED = 3
-}
-
-export const PermissionApprovalStatus = {
-  REQUESTED: 1,
-  APPROVED: 2,
-  REFUSED: 3
-}
-
-export interface IPermissionApprovalFindInput extends IBasePerTenantAndOrganizationEntityModel {
-  id?: string
-}
-
-export interface IApprovalsData {
-  icon: string
-  title: string
-}

package/src/analytics/project.model.ts

@@ -1,56 +0,0 @@
-import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model'
-import { IStorageFile } from '../storage-file.model'
-import { IUser } from '../user.model'
-import { ICertification } from './certification.model'
-import { IIndicator } from './indicator'
-import { ISemanticModel } from './semantic-model'
-import { IStory } from './story'
-
-export interface IProject extends IBasePerTenantAndOrganizationEntityModel {
-  name?: string
-  description?: string
-  options?: any
-  /**
-   * Project owner, can be transfered
-   */
-  owner?: IUser
-  ownerId?: string
-  status?: ProjectStatusEnum
-
-  stories?: IStory[]
-  indicators?: IIndicator[]
-  /**
-   * Project Members
-   */
-  members?: IUser[]
-  /**
-   * Semantic model bound in the project
-   */
-  models?: ISemanticModel[]
-  /**
-   * Certifications available in the project
-   */
-  certifications?: ICertification[]
-
-  /**
-   * Files in the project
-   */
-  files?: IStorageFile[]
-}
-
-export enum ProjectStatusEnum {
-  /**
-   * In use
-   */
-  Progressing = 'Progressing',
-
-  /**
-   * Archived
-   */
-  Archived = 'Archived'
-}
-
-export interface IBasePerProjectEntityModel extends IBasePerTenantAndOrganizationEntityModel {
-  projectId?: string
-  project?: IProject
-}

package/src/analytics/role-permissions.ts

@@ -1,36 +0,0 @@
-export enum AnalyticsPermissionsEnum {
-    /**
-     * Edit Certification
-     */
-    CERTIFICATION_EDIT = 'CERTIFICATION_EDIT',
-    // DataSource
-    DATA_SOURCE_VIEW = 'DATA_SOURCE_VIEW',
-    DATA_SOURCE_EDIT = 'DATA_SOURCE_EDIT',
-    // Notification Destination
-    NOTIFICATION_DESTINATION_VIEW = 'NOTIFICATION_DESTINATION_VIEW',
-    NOTIFICATION_DESTINATION_EDIT = 'NOTIFICATION_DESTINATION_EDIT',
-    // Subscription
-    SUBSCRIPTION_VIEW = 'SUBSCRIPTION_VIEW',
-    SUBSCRIPTION_EDIT = 'SUBSCRIPTION_EDIT',
-    // Semantic Model
-    MODELS_VIEW = 'MODELS_VIEW',
-    MODELS_EDIT = 'MODELS_EDIT',
-    // Story
-    STORIES_VIEW = 'STORIES_VIEW',
-    STORIES_EDIT = 'STORIES_EDIT',
-    // BusinessGroup
-    BUSINESS_AREA_VIEW = 'BUSINESS_AREA_VIEW',
-    BUSINESS_AREA_EDIT = 'BUSINESS_AREA_EDIT',
-    // Indicator
-    INDICATOR_VIEW = 'INDICATOR_VIEW',
-    INDICATOR_MARTKET_VIEW = 'INDICATOR_MARTKET_VIEW',
-    INDICATOR_EDIT = 'INDICATOR_EDIT',
-    // Data Factory
-    DATA_FACTORY_VIEW = 'DATA_FACTORY_VIEW',
-    DATA_FACTORY_EDIT = 'DATA_FACTORY_EDIT',
-
-    // Permission application approval view, you can browse all permission applications
-    PERMISSION_APPROVAL_VIEW = 'PERMISSION_APPROVAL_VIEW',
-    // Permission application creation permission, cannot browse other applications
-	PERMISSION_APPROVAL_EDIT = 'PERMISSION_APPROVAL_EDIT',
-}

package/src/analytics/schema.ts

@@ -1,300 +0,0 @@
-/**
- * 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
-}