@metad/contracts 3.6.2 → 3.6.7

package/src/analytics/indicator-app.ts

@@ -0,0 +1,49 @@
+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-market.d.ts → indicator-market.ts}

@@ -1,4 +1,8 @@
-import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model';
+
+
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model'
+
+
 export interface IIndicatorMarket extends IBasePerTenantAndOrganizationEntityModel {
-    options?: Record<string, unknown>;
+    options?: Record<string, unknown>
 }

package/src/analytics/indicator.ts

@@ -0,0 +1,143 @@
+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
+}
+
+/**
+ * Fields included in the draft of Indicator, please keep it in sync with TIndicator type
+ */
+export const IndicatorDraftFields: Array<keyof IIndicator> = [
+  "code",
+  "name",
+  "type",
+  "visible",
+  "isApplication",
+  "modelId",
+  "entity",
+  "unit",
+  "principal",
+  "authentication",
+  "certificationId",
+  "validity",
+  "business",
+  "options",
+  "businessAreaId"
+]
+
+export type TIndicatorDraft = TIndicator & {
+  checklist?: ChecklistItem[]
+  version?: number
+  savedAt?: Date
+}
+
+export interface IIndicator extends IBasePerProjectEntityModel, TIndicator {
+  draft?: TIndicatorDraft
+  
+  /**
+   * Visibilty in public or secret or private
+   */
+  visibility?: Visibility
+
+  model?: ISemanticModel
+  /**
+   * Quality Certification
+   */
+  certification?: ICertification
+  
+  status?: IndicatorStatusEnum
+  embeddingStatus?: EmbeddingStatusEnum
+  error?: string
+  publishedAt?: Date
+  
+  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

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

@@ -0,0 +1,22 @@
+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/{notification-destination.d.ts → notification-destination.ts}

@@ -1,10 +1,14 @@
 import { IBasePerTenantEntityModel } from "../base-entity.model";
+
 export interface INotificationDestinationType {
-    name: string;
-    type: string;
-    icon?: string;
-    schema?: Record<string, unknown>;
+    name: string
+    type: string
+    icon?: string
+    
+    schema?: Record<string, unknown>
 }
+
 export interface INotificationDestination extends IBasePerTenantEntityModel, INotificationDestinationType {
-    options?: Record<string, unknown>;
+
+    options?: Record<string, unknown>
 }

package/src/analytics/{permission-approval-user.model.d.ts → permission-approval-user.model.ts}

@@ -1,10 +1,12 @@
-import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model';
-import { IUser } from '../user.model';
-import { IPermissionApproval } from './permission-approval.model';
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model'
+import { IUser } from '../user.model'
+import { IPermissionApproval } from './permission-approval.model'
+
 export interface IPermissionApprovalUser extends IBasePerTenantAndOrganizationEntityModel {
-    permissionApprovalId: string;
-    userId: string;
-    status: number;
-    permissionApproval: IPermissionApproval;
-    user: IUser;
+  permissionApprovalId: string
+  userId: string
+  status: number
+  
+  permissionApproval: IPermissionApproval
+  user: IUser
 }

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

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

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

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