@things-factory/kpi 9.2.5 → 10.0.0-beta.10

package/server/service/index.ts

@@ -1,51 +0,0 @@
-/* EXPORT ENTITY TYPES */
-export * from './kpi-statistic/kpi-statistic'
-export * from './kpi/kpi'
-export * from './kpi/kpi-type'
-export * from './kpi-value/kpi-value'
-export * from './kpi-value/kpi-value-type'
-export * from './kpi-metric/kpi-metric'
-export * from './kpi-metric/kpi-metric-type'
-export * from './kpi-metric-value/kpi-metric-value'
-export * from './kpi-metric-value/kpi-metric-value-type'
-export * from './kpi-scope/kpi-scope'
-export * from './kpi-org-scope/kpi-org-scope'
-
-/* IMPORT ENTITIES AND RESOLVERS */
-import {
-  entities as KpiStatisticEntities,
-  resolvers as KpiStatisticResolvers,
-  subscribers as KpiStatisticSubscribers
-} from './kpi-statistic'
-import { entities as KpiEntities, resolvers as KpiResolvers } from './kpi'
-import { entities as KpiValueEntities, resolvers as KpiValueResolvers } from './kpi-value'
-import { entities as KpiMetricEntities, resolvers as KpiMetricResolvers } from './kpi-metric'
-import { entities as KpiMetricValueEntities, resolvers as KpiMetricValueResolvers } from './kpi-metric-value'
-import { entities as KpiOrgScopeEntities, resolvers as KpiOrgScopeResolvers } from './kpi-org-scope'
-import { resolvers as KpiAlertResolvers } from './kpi-alert'
-import { entities as KpiScopeEntities, resolvers as KpiScopeResolvers } from './kpi-scope'
-
-export const entities = [
-  /* ENTITIES */
-  ...KpiStatisticEntities,
-  ...KpiEntities,
-  ...KpiValueEntities,
-  ...KpiMetricEntities,
-  ...KpiMetricValueEntities,
-  ...KpiOrgScopeEntities,
-  ...KpiScopeEntities
-]
-
-export const schema = {
-  resolverClasses: [
-    /* RESOLVER CLASSES */
-    ...KpiStatisticResolvers,
-    ...KpiResolvers,
-    ...KpiValueResolvers,
-    ...KpiMetricResolvers,
-    ...KpiMetricValueResolvers,
-    ...KpiOrgScopeResolvers,
-    ...KpiAlertResolvers,
-    ...KpiScopeResolvers
-  ]
-}

package/server/service/kpi/aggregate-kpi.ts

@@ -1,103 +0,0 @@
-import { getRepository } from '@things-factory/shell'
-import { Kpi } from './kpi'
-import { KpiMetric } from '../kpi-metric/kpi-metric'
-import { KpiValue, KpiValueInputType } from '../kpi-value/kpi-value'
-import { KpiOrgScope } from '../kpi-org-scope/kpi-org-scope'
-import { KpiFormulaService } from './kpi-formula.service'
-import { aggregateKpiMetricValue } from '../kpi-metric/aggregate-kpi-metric'
-import { KpiValueScoreService } from '../kpi-value/kpi-value-score.service'
-
-/**
- * KPI 단위 집계/산식 자동화 함수
- * @param kpiId KPI ID
- * @param domainId 도메인 ID
- * @param context ResolverContext
- * @returns 저장된 KPI Value 배열
- */
-export async function aggregateKpiValue(kpiId: string, domainId: string, context: ResolverContext) {
-  const tx = context.state?.tx || getRepository(Kpi).manager
-  const scoreService = new KpiValueScoreService()
-
-  // 1. KPI 정보 조회
-  const kpi = await getRepository(Kpi).findOne({ where: { id: kpiId, domain: { id: domainId } } })
-  if (!kpi) throw new Error('KPI 정보 없음')
-  if (!kpi.active) throw new Error('비활성화된 KPI')
-  if (!kpi.formula) throw new Error('KPI formula 없음')
-
-  // 2. formula 파싱 및 metric code별 값 집계
-  const formulaService = new KpiFormulaService()
-  const metricCodes = formulaService.extractMetricCodes(kpi.formula)
-  const codeValueMap: Record<string, any[]> = {}
-  for (const code of metricCodes) {
-    // code로 metric 찾기
-    const metric = await getRepository(KpiMetric).findOne({ where: { name: code, domain: { id: domainId } } })
-    if (!metric) throw new Error(`KPI formula metric '${code}' not found`)
-    codeValueMap[code] = await aggregateKpiMetricValue(metric.id, domainId, context)
-  }
-  // org/date/period별로 값 매핑(가장 최근 기준, org key 조합)
-  const orgKey = v => [v.date, v.period, v.org].join('|')
-  const orgMap: Record<string, any> = {}
-  for (const code of metricCodes) {
-    for (const v of codeValueMap[code]) {
-      const key = orgKey(v)
-      orgMap[key] = orgMap[key] || { ...v, _values: {} }
-      orgMap[key]._values[code] = v.value
-    }
-  }
-  // formula 계산 (js eval)
-  const savedValues = []
-  for (const key in orgMap) {
-    const ctx = orgMap[key]._values
-    let value = null
-    try {
-      value = Function(...Object.keys(ctx), `return (${kpi.formula})`)(...Object.values(ctx))
-    } catch (e) {
-      value = null
-    }
-    const valueDate = orgMap[key].date
-    const org = orgMap[key].org
-    const version = kpi.version || 1
-    if (value == null || isNaN(value)) continue
-    // KpiOrgScope 처리 (org 문자열로 찾기 또는 생성)
-    const kpiOrgScopeRepo = getRepository(KpiOrgScope, context.state?.tx)
-    let kpiOrgScope = await kpiOrgScopeRepo.findOne({
-      where: { org: org, domain: { id: domainId } }
-    })
-    if (!kpiOrgScope) {
-      // 새 KpiOrgScope 생성
-      kpiOrgScope = await kpiOrgScopeRepo.save({
-        entityType: 'AutoAggregate',
-        entityId: `auto-${Date.now()}-${Math.random().toString(36).substr(2, 9)}`,
-        entityName: org,
-        org: org,
-        domain: kpi.domain
-      })
-    }
-
-    // upsert(동일 KPI, valueDate, kpiOrgScope, version) 기준으로 저장
-    const repo = getRepository(KpiValue, context.state?.tx)
-    const existing = await repo.findOne({
-      where: { kpi: { id: kpi.id }, valueDate, kpiOrgScope: { id: kpiOrgScope.id }, version, domain: { id: domainId } }
-    })
-    let entity = existing || repo.create()
-    entity.kpi = kpi
-    entity.kpiId = kpi.id
-    entity.version = version
-    entity.valueDate = valueDate
-    entity.value = value
-    entity.kpiOrgScope = kpiOrgScope
-    entity.kpiOrgScopeId = kpiOrgScope.id
-    entity.inputType = KpiValueInputType.AUTO
-    entity.source = 'AUTO'
-    entity.domain = kpi.domain
-    entity.creator = context.state?.user
-    entity.updater = context.state?.user
-
-    // 성과 점수 자동 계산 및 저장
-    await scoreService.calculateAndSaveScore(entity, kpi)
-
-    entity = await repo.save(entity)
-    savedValues.push(entity)
-  }
-  return savedValues
-}

package/server/service/kpi/event-subscriber.ts

@@ -1,29 +0,0 @@
-import { EventSubscriber } from 'typeorm'
-
-import { HistoryEntitySubscriber } from '@operato/typeorm-history'
-
-import { Kpi } from './kpi'
-import { KpiHistory } from './kpi-history'
-
-@EventSubscriber()
-export class KpiHistoryEntitySubscriber extends HistoryEntitySubscriber<Kpi, KpiHistory> {
-  public get entity() {
-    return Kpi
-  }
-
-  public get historyEntity() {
-    return KpiHistory
-  }
-
-  public async afterInsert(event): Promise<void> {
-    if (event.entity.state == 'RELEASE') {
-      await super.afterInsert(event as any)
-    }
-  }
-
-  public async afterUpdate(event): Promise<void> {
-    if (event.entity.state == 'RELEASE') {
-      await super.afterUpdate(event as any)
-    }
-  }
-}

package/server/service/kpi/index.ts

@@ -1,9 +0,0 @@
-import { Kpi } from './kpi'
-import { KpiHistory } from './kpi-history'
-import { KpiHistoryEntitySubscriber } from './event-subscriber'
-import { KpiQuery } from './kpi-query'
-import { KpiMutation } from './kpi-mutation'
-
-export const entities = [Kpi, KpiHistory]
-export const resolvers = [KpiQuery, KpiMutation]
-export const subscribers = [KpiHistoryEntitySubscriber]

package/server/service/kpi/kpi-formula.service.ts

@@ -1,164 +0,0 @@
-import { getRepository } from '@things-factory/shell'
-import { KpiMetric } from '../kpi-metric/kpi-metric'
-import { Kpi } from './kpi'
-import { KpiValue } from '../kpi-value/kpi-value'
-import { KpiOrgScope } from '../kpi-org-scope/kpi-org-scope'
-
-/**
- * KPI formula 파싱/검증/매핑 유효성 검사 서비스
- * - formula에서 Metric 코드(변수명) 추출
- * - 각 Metric의 존재/매핑 유효성 검사
- * - 구문 오류, 미정의 Metric, 매핑 오류 등 에러 리포팅
- */
-export class KpiFormulaService {
-  /**
-   * formula 문자열에서 Metric 코드(변수명) 추출
-   * @param formula KPI formula (예: 'defect_count / total_count * 100')
-   * @returns string[] 추출된 Metric 코드 리스트
-   */
-  extractMetricCodes(formula: string): string[] {
-    // 변수명: 알파벳/언더스코어로 시작, 숫자/알파벳/언더스코어 포함
-    const regex = /[a-zA-Z_][a-zA-Z0-9_]*/g
-    // 숫자/예약어/연산자 제외(후처리 필요)
-    const reserved = new Set(['if', 'else', 'return', 'true', 'false'])
-    return Array.from(new Set((formula.match(regex) || []).filter(code => isNaN(Number(code)) && !reserved.has(code))))
-  }
-
-  /**
-   * formula 내 Metric 코드의 존재/매핑 유효성 검사 + 순환참조 검출
-   * @param formula KPI formula
-   * @param visited 순환참조 검출용 Set (재귀 호출 시 사용)
-   * @returns { valid: boolean, errors: string[] }
-   */
-  async validateFormula(
-    formula: string,
-    visited: Set<string> = new Set()
-  ): Promise<{ valid: boolean; errors: string[] }> {
-    const errors: string[] = []
-    const metricCodes = this.extractMetricCodes(formula)
-    const metricRepo = getRepository(KpiMetric)
-    for (const code of metricCodes) {
-      if (visited.has(code)) {
-        errors.push(`순환참조 감지: ${Array.from(visited).join(' → ')} → ${code}`)
-        continue
-      }
-      visited.add(code)
-      const metric = await metricRepo.findOne({ where: { name: code } })
-      if (!metric) {
-        errors.push(`Metric '${code}' is not defined.`)
-        visited.delete(code)
-        continue
-      }
-      if (!metric.dataSetId || !metric.fieldName) {
-        errors.push(`Metric '${code}' is not mapped to a dataset field.`)
-      }
-      // metric이 formula를 가지고 있다면 재귀적으로 순환참조 검증
-      if ((metric as any).formula) {
-        const subResult = await this.validateFormula((metric as any).formula, new Set(visited))
-        if (!subResult.valid) errors.push(...subResult.errors)
-      }
-      visited.delete(code)
-    }
-    // (선택) formula 구문 오류, 괄호 불일치 등 추가 검사 가능
-    // ...
-    return { valid: errors.length === 0, errors }
-  }
-
-  /**
-   * 계층 구조 KPI의 값을 자식 KPI들로부터 집계 계산
-   * @param kpiId 부모 KPI ID
-   * @param valueDate 계산 대상 날짜
-   * @param org 조직 단위
-   * @returns Promise<number | null> 집계된 값
-   */
-  async calculateHierarchicalValue(kpiId: string, valueDate: string, org?: string): Promise<number | null> {
-    const kpiRepo = getRepository(Kpi)
-    const kpi = await kpiRepo.findOne({
-      where: { id: kpiId },
-      relations: ['children']
-    })
-
-    if (!kpi || !kpi.children || kpi.children.length === 0) {
-      return null
-    }
-
-    const childValues: number[] = []
-    const childWeights: number[] = []
-
-    for (const child of kpi.children) {
-      let childValue: number | null = null
-      
-      if (child.isLeaf) {
-        // Leaf KPI인 경우 KpiValue에서 실제 값을 가져옴
-        const kpiValueRepo = getRepository(KpiValue)
-        let kpiValue: KpiValue | null = null
-        if (org) {
-          const kpiOrgScope = await getRepository(KpiOrgScope).findOne({
-            where: { org: org, domain: { id: child.domain?.id } }
-          })
-          if (kpiOrgScope) {
-            kpiValue = await kpiValueRepo.findOne({ 
-              where: { 
-                kpi: { id: child.id }, 
-                valueDate,
-                kpiOrgScope: { id: kpiOrgScope.id }
-              }
-            })
-          }
-        } else {
-          // org가 없는 경우 kpiOrgScope 없이 조회 
-          kpiValue = await kpiValueRepo.findOne({ 
-            where: { 
-              kpi: { id: child.id }, 
-              valueDate,
-              kpiOrgScope: null
-            }
-          })
-        }
-        childValue = kpiValue?.value || null
-      } else {
-        // 중간 노드인 경우 재귀적으로 계산
-        childValue = await this.calculateHierarchicalValue(child.id, valueDate, org)
-      }
-
-      if (childValue !== null) {
-        childValues.push(childValue)
-        childWeights.push(child.weight || 1)
-      }
-    }
-
-    if (childValues.length === 0) {
-      return null
-    }
-
-    // 가중 평균 계산
-    const totalWeight = childWeights.reduce((sum, weight) => sum + weight, 0)
-    const weightedSum = childValues.reduce((sum, value, index) => sum + value * childWeights[index], 0)
-    
-    return totalWeight > 0 ? weightedSum / totalWeight : null
-  }
-
-  /**
-   * KPI가 순환 참조를 생성하는지 확인
-   * @param kpiId KPI ID
-   * @param parentId 설정하려는 부모 KPI ID
-   * @returns Promise<boolean> 순환 참조 여부
-   */
-  async hasCircularReference(kpiId: string, parentId: string): Promise<boolean> {
-    if (kpiId === parentId) {
-      return true
-    }
-
-    const kpiRepo = getRepository(Kpi)
-    const parent = await kpiRepo.findOne({
-      where: { id: parentId },
-      relations: ['parent']
-    })
-
-    if (!parent || !parent.parent) {
-      return false
-    }
-
-    return await this.hasCircularReference(kpiId, parent.parent.id)
-  }
-}

package/server/service/kpi/kpi-grade.types.ts

@@ -1,28 +0,0 @@
-/**
- * KPI 성과 점수 lookup table 타입 정의
- * 복잡한 성과 점수 변환을 수식으로 표현하기 어려운 경우 사용
- */
-export interface KpiScore {
-  /** 성과 지수명 (예: A, B, C, 우수, 양호 등) */
-  name: string
-
-  /** 성과 점수 변환 기준 최소값 */
-  minValue: number
-
-  /** 성과 점수 변환 기준 최대값 */
-  maxValue: number
-
-  /** 성과 지수 점수 (선택사항) */
-  score?: number
-
-  /** 성과 지수 색상 (선택사항) */
-  color?: string
-
-  /** 성과 지수 설명 (선택사항) */
-  description?: string
-}
-
-/**
- * KPI 성과 점수 lookup table 배열 타입
- */
-export type KpiScores = KpiScore[]

package/server/service/kpi/kpi-history.ts

@@ -1,126 +0,0 @@
-import { Field, ID, ObjectType } from 'type-graphql'
-import { Column, Entity, Index, ManyToOne, PrimaryGeneratedColumn, RelationId, JoinColumn } from 'typeorm'
-
-import {
-  HistoryActionColumn,
-  HistoryActionType,
-  HistoryEntityInterface,
-  HistoryOriginalIdColumn
-} from '@operato/typeorm-history'
-import { Role, User } from '@things-factory/auth-base'
-import { config } from '@things-factory/env'
-import { Domain, ScalarObject } from '@things-factory/shell'
-
-import { Kpi, KpiStatus, KpiPeriodType } from './kpi'
-import { KpiScores } from './kpi-grade.types'
-
-const ORMCONFIG = config.get('ormconfig', {})
-const DATABASE_TYPE = ORMCONFIG.type
-
-@Entity()
-@Index('ix_kpi_history_0', (kpiHistory: KpiHistory) => [kpiHistory.originalId, kpiHistory.version], { unique: true })
-@Index('ix_kpi_history_1', (kpiHistory: KpiHistory) => [kpiHistory.domain, kpiHistory.originalId, kpiHistory.version], {
-  unique: true
-})
-@ObjectType({ description: 'History Entity of Kpi' })
-export class KpiHistory implements HistoryEntityInterface<Kpi> {
-  @PrimaryGeneratedColumn('uuid')
-  @Field(type => ID)
-  readonly id: string
-
-  @Column({ nullable: true, default: 1 })
-  @Field({ nullable: true })
-  version?: number = 1
-
-  @ManyToOne(type => Domain)
-  @Field({ nullable: true })
-  domain?: Domain
-
-  @RelationId((kpi: Kpi) => kpi.domain)
-  domainId?: string
-
-  @Column()
-  @Field()
-  name: string
-
-  @Column({ nullable: true })
-  @Field({ nullable: true })
-  description?: string
-
-  @Column({ nullable: true })
-  @Field({ nullable: true, description: 'Calculation formula for the KPI.' })
-  formula?: string
-
-  @Column({ nullable: false, default: false })
-  @Field({ nullable: true, description: 'Whether this KPI is active (usable) or not.' })
-  active?: boolean
-
-  @Column({ nullable: true })
-  @Field({ nullable: true, description: 'Current state of the KPI (DRAFT, RELEASED, ARCHIVED).' })
-  state?: KpiStatus
-
-  @Field(type => String, { nullable: true, description: 'Thumbnail image or file path for this KPI.' })
-  thumbnail?: string
-
-  @Column({ type: 'simple-json', nullable: true })
-  @Field(type => ScalarObject, {
-    nullable: true,
-    description: 'Grade configuration for this KPI version'
-  })
-  grades?: KpiScores
-
-  @Column({ type: 'float', nullable: true, default: 1 })
-  @Field({ nullable: true, description: 'Weight for aggregation in parent category.' })
-  weight?: number
-
-  @Column({ default: 'DAY' })
-  @Field(type => KpiPeriodType, { nullable: true })
-  periodType: KpiPeriodType
-
-  @Column({ nullable: true })
-  @Field({ nullable: true })
-  createdAt?: Date
-
-  @Column({ nullable: true })
-  @Field({ nullable: true })
-  updatedAt?: Date
-
-  @Column({ nullable: true })
-  @Field({ nullable: true })
-  deletedAt?: Date
-
-  @ManyToOne(type => User, { nullable: true })
-  @Field(type => User, { nullable: true })
-  creator?: User
-
-  @RelationId((kpi: Kpi) => kpi.creator)
-  creatorId?: string
-
-  @ManyToOne(type => User, { nullable: true })
-  @Field(type => User, { nullable: true })
-  updater?: User
-
-  @RelationId((kpi: Kpi) => kpi.updater)
-  updaterId?: string
-
-  @HistoryOriginalIdColumn()
-  public originalId!: string
-
-  @HistoryActionColumn({
-    nullable: false,
-    type:
-      DATABASE_TYPE == 'postgres' || DATABASE_TYPE == 'mysql' || DATABASE_TYPE == 'mariadb'
-        ? 'enum'
-        : DATABASE_TYPE == 'oracle'
-          ? 'varchar2'
-          : DATABASE_TYPE == 'mssql'
-            ? 'nvarchar'
-            : 'varchar',
-    enum:
-      DATABASE_TYPE == 'postgres' || DATABASE_TYPE == 'mysql' || DATABASE_TYPE == 'mariadb'
-        ? HistoryActionType
-        : undefined,
-    length: DATABASE_TYPE == 'postgres' || DATABASE_TYPE == 'mysql' || DATABASE_TYPE == 'mariadb' ? undefined : 32
-  })
-  public action!: HistoryActionType
-}