@things-factory/kpi 1.0.0-alpha.5 → 9.0.9

package/server/service/kpi-value/kpi-value-mutation.ts

@@ -4,22 +4,46 @@ import { getRepository } from '@things-factory/shell'
 
 import { KpiValue } from './kpi-value'
 import { NewKpiValue, KpiValuePatch } from './kpi-value-type'
+import { Kpi } from '../kpi/kpi'
+import { KpiValueInputType } from './kpi-value'
 
 @Resolver(KpiValue)
 export class KpiValueMutation {
   @Directive('@transaction')
-  @Mutation(returns => KpiValue, { description: 'To create new KpiValue' })
-  async createKpiValue(@Arg('kpiValue') kpiValue: NewKpiValue, @Ctx() context: ResolverContext): Promise<KpiValue> {
+  @Mutation(returns => KpiValue, { description: 'Create a new KPI value with the provided details.' })
+  async createKpiValue(
+    @Arg('kpiValue', { description: 'Input object containing details for the new KPI value.' }) kpiValue: NewKpiValue,
+    @Ctx() context: ResolverContext
+  ): Promise<KpiValue> {
     const { domain, user, tx } = context.state
 
-    const result = await getRepository(KpiValue, tx).save({
-      ...kpiValue,
-      domain,
+    let kpi = kpiValue.kpiId ? await getRepository(Kpi).findOne({ where: { id: kpiValue.kpiId } }) : undefined
+
+    let inputType: KpiValueInputType | undefined = undefined
+    if (kpiValue.inputType) {
+      if (typeof kpiValue.inputType === 'string') {
+        inputType = KpiValueInputType[kpiValue.inputType as keyof typeof KpiValueInputType]
+      } else {
+        inputType = kpiValue.inputType
+      }
+    }
+
+    const entity: Partial<KpiValue> = {
+      kpi,
+      kpiId: kpiValue.kpiId,
+      version: kpiValue.version,
+      valueDate: kpiValue.valueDate,
+      value: kpiValue.value,
+      groupId: kpiValue.groupId,
+      groupType: kpiValue.groupType,
+      source: kpiValue.source,
+      domain: domain,
       creator: user,
       updater: user
-    })
+    }
+    if (inputType) entity.inputType = inputType
 
-    return result
+    return await getRepository(KpiValue, tx).save(entity)
   }
 
   @Directive('@transaction')
@@ -36,13 +60,28 @@ export class KpiValueMutation {
       where: { domain: { id: domain.id }, id }
     })
 
-    const result = await repository.save({
+    let kpi = patch.kpiId ? await getRepository(Kpi).findOne({ where: { id: patch.kpiId } }) : kpiValue.kpi
+
+    let inputType: KpiValueInputType | undefined = undefined
+    if (patch.inputType) {
+      if (typeof patch.inputType === 'string') {
+        inputType = KpiValueInputType[patch.inputType as keyof typeof KpiValueInputType]
+      } else {
+        inputType = patch.inputType
+      }
+    } else {
+      inputType = kpiValue.inputType
+    }
+
+    const entity: any = {
       ...kpiValue,
       ...patch,
+      kpi,
       updater: user
-    })
+    }
+    if (inputType) entity.inputType = inputType
 
-    return result
+    return await repository.save(entity)
   }
 
   @Directive('@transaction')
@@ -67,7 +106,7 @@ export class KpiValueMutation {
           domain,
           creator: user,
           updater: user
-        })
+        } as any)
 
         results.push({ ...result, cuFlag: '+' })
       }
@@ -82,7 +121,7 @@ export class KpiValueMutation {
           ...kpiValue,
           ...updateRecord,
           updater: user
-        })
+        } as any)
 
         results.push({ ...result, cuFlag: 'M' })
       }
@@ -114,7 +153,6 @@ export class KpiValueMutation {
       id: In(ids)
     })
 
-
     return true
   }
 
@@ -128,7 +166,7 @@ export class KpiValueMutation {
 
     await Promise.all(
       kpiValues.map(async (kpiValue: KpiValuePatch) => {
-        const createdKpiValue: KpiValue = await getRepository(KpiValue, tx).save({ domain, ...kpiValue })
+        const createdKpiValue: KpiValue = await getRepository(KpiValue, tx).save({ domain, ...kpiValue } as any)
       })
     )
 

package/server/service/kpi-value/kpi-value-query.ts

@@ -3,11 +3,15 @@ import { Domain, getQueryBuilderFromListParams, getRepository, ListParam } from
 import { User } from '@things-factory/auth-base'
 import { KpiValue } from './kpi-value'
 import { KpiValueList } from './kpi-value-type'
+import { Kpi } from '../kpi/kpi'
 
 @Resolver(KpiValue)
 export class KpiValueQuery {
-  @Query(returns => KpiValue!, { nullable: true, description: 'To fetch a KpiValue' })
-  async kpiValue(@Arg('id') id: string, @Ctx() context: ResolverContext): Promise<KpiValue> {
+  @Query(returns => KpiValue!, { nullable: true, description: 'Fetch a single KPI value by its unique identifier.' })
+  async kpiValue(
+    @Arg('id', { description: 'Unique identifier of the KPI value to fetch.' }) id: string,
+    @Ctx() context: ResolverContext
+  ): Promise<KpiValue> {
     const { domain } = context.state
 
     return await getRepository(KpiValue).findOne({
@@ -45,4 +49,10 @@ export class KpiValueQuery {
   async creator(@Root() kpiValue: KpiValue): Promise<User> {
     return kpiValue.creatorId && (await getRepository(User).findOneBy({ id: kpiValue.creatorId }))
   }
+
+  @FieldResolver(type => Kpi)
+  async kpi(@Root() kpiValue: KpiValue): Promise<Kpi | null> {
+    if (!kpiValue.kpiId) return null
+    return await getRepository(Kpi).findOneBy({ id: kpiValue.kpiId })
+  }
 }

package/server/service/kpi-value/kpi-value-type.ts

@@ -1,47 +1,102 @@
 import type { FileUpload } from 'graphql-upload/GraphQLUpload.js'
 import GraphQLUpload from 'graphql-upload/GraphQLUpload.js'
-import { ObjectType, Field, InputType, Int, ID, registerEnumType } from 'type-graphql'
+import { ObjectType, Field, InputType, Int, ID, registerEnumType, Float } from 'type-graphql'
 
 import { ObjectRef, ScalarObject } from '@things-factory/shell'
 
-import { KpiValue, KpiValueStatus } from './kpi-value'
+import { KpiValue, KpiValueInputType } from './kpi-value'
 
-@InputType()
+@InputType({ description: 'Input type for creating a new KPI value. Used in mutations to provide KPI value details.' })
 export class NewKpiValue {
-  @Field()
-  name: string
+  @Field(type => ID, { description: 'ID of the KPI to which this value belongs.' })
+  kpiId: string
 
-  @Field({ nullable: true })
-  description?: string
+  @Field(type => Int, { description: 'Version of the KPI definition at the time this value is calculated.' })
+  version: number
 
-  @Field(type => KpiValueStatus, { nullable: true })
-  state?: KpiValueStatus
+  @Field({ description: 'Date or period for which this KPI value is recorded (e.g., day, month, quarter).' })
+  valueDate: string
 
-  @Field({ nullable: true })
-  active?: boolean
+  @Field(type => Float, { description: 'The calculated numeric value for this KPI and period.' })
+  value: number
 
-  @Field({ nullable: true })
-  params?: string
+  @Field(type => ScalarObject, {
+    nullable: true,
+    description:
+      'Extended or non-numeric information related to this KPI value, stored as JSON5. Can include grade, status, comments, or other metadata.'
+  })
+  meta?: any
+
+  @Field({
+    nullable: true,
+    description: 'ID of the group (organization, department, project, etc.) this value is associated with.'
+  })
+  groupId?: string
+
+  @Field({ nullable: true, description: 'Type of the group (e.g., USER, DEPT, PROJECT) for this value.' })
+  groupType?: string
+
+  @Field(type => KpiValueInputType, {
+    nullable: true,
+    description: 'Indicates whether this value was entered manually or generated automatically.'
+  })
+  inputType?: KpiValueInputType
+
+  @Field({ nullable: true, description: 'Source of the value (e.g., system, user, external integration).' })
+  source?: string
 }
 
-@InputType()
+@InputType({
+  description: 'Input type for updating an existing KPI value. Used in mutations to patch KPI value details.'
+})
 export class KpiValuePatch {
-  @Field(type => ID, { nullable: true })
+  @Field(type => ID, { nullable: true, description: 'ID of the KPI value to update.' })
   id?: string
 
-  @Field({ nullable: true })
-  name?: string
+  @Field(type => ID, { nullable: true, description: 'ID of the KPI to which this value belongs.' })
+  kpiId?: string
+
+  @Field(type => Int, {
+    nullable: true,
+    description: 'Version of the KPI definition at the time this value is calculated.'
+  })
+  version?: number
+
+  @Field({
+    nullable: true,
+    description: 'Date or period for which this KPI value is recorded (e.g., day, month, quarter).'
+  })
+  valueDate?: string
+
+  @Field(type => Float, { nullable: true, description: 'The calculated numeric value for this KPI and period.' })
+  value?: number
+
+  @Field(type => ScalarObject, {
+    nullable: true,
+    description:
+      'Extended or non-numeric information related to this KPI value, stored as JSON5. Can include grade, status, comments, or other metadata.'
+  })
+  meta?: any
+
+  @Field({
+    nullable: true,
+    description: 'ID of the group (organization, department, project, etc.) this value is associated with.'
+  })
+  groupId?: string
+
+  @Field({ nullable: true, description: 'Type of the group (e.g., USER, DEPT, PROJECT) for this value.' })
+  groupType?: string
 
-  @Field({ nullable: true })
-  description?: string
+  @Field(type => KpiValueInputType, {
+    nullable: true,
+    description: 'Indicates whether this value was entered manually or generated automatically.'
+  })
+  inputType?: KpiValueInputType
 
-  @Field(type => KpiValueStatus, { nullable: true })
-  state?: KpiValueStatus
+  @Field({ nullable: true, description: 'Source of the value (e.g., system, user, external integration).' })
+  source?: string
 
-  @Field({ nullable: true })
-  active?: boolean
-  
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'Custom flag for update operations (internal use).' })
   cuFlag?: string
 }
 

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

@@ -8,77 +8,129 @@ import {
   ManyToOne,
   PrimaryGeneratedColumn
 } from 'typeorm'
-import { ObjectType, Field, Int, ID, registerEnumType } from 'type-graphql'
+import { ObjectType, Field, Int, ID, registerEnumType, Float } from 'type-graphql'
 
-import { Domain } from '@things-factory/shell'
 import { User } from '@things-factory/auth-base'
+import { Domain, ScalarObject, json5Transformer } from '@things-factory/shell'
+import { config } from '@things-factory/env'
+import { Kpi } from '../kpi/kpi'
 
-export enum KpiValueStatus {
-  STATUS_A = 'STATUS_A',
-  STATUS_B = 'STATUS_B'
+const ORMCONFIG = config.get('ormconfig', {})
+const DATABASE_TYPE = ORMCONFIG.type
+
+export enum KpiValueInputType {
+  MANUAL = 'MANUAL',
+  AUTO = 'AUTO'
 }
 
-registerEnumType(KpiValueStatus, {
-  name: 'KpiValueStatus',
-  description: 'state enumeration of a kpiValue'
+registerEnumType(KpiValueInputType, {
+  name: 'KpiValueInputType',
+  description: 'Type of the input (Manual or Auto)'
 })
 
 @Entity()
-@Index('ix_kpi_value_0', (kpiValue: KpiValue) => [kpiValue.domain, kpiValue.name], {
-  unique: true
-})
+@Index('ix_kpi_value_latest', ['domain', 'kpi', 'valueDate', 'groupId', 'groupType', 'version'], { unique: true })
+@Index('ix_kpi_value_latest_for_query', ['domain', 'kpi', 'valueDate', 'groupId', 'groupType'], { unique: false })
 @ObjectType({ description: 'Entity for KpiValue' })
 export class KpiValue {
   @PrimaryGeneratedColumn('uuid')
-  @Field(type => ID)
+  @Field(type => ID, { description: 'Unique identifier for this KPI value record.' })
   readonly id: string
 
   @ManyToOne(type => Domain)
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'Domain (tenant) to which this KPI value belongs.' })
   domain?: Domain
 
   @RelationId((kpiValue: KpiValue) => kpiValue.domain)
+  @Field({ nullable: true, description: 'ID of the domain (tenant) for this KPI value.' })
   domainId?: string
 
-  @Column()
-  @Field({ nullable: true })
-  name?: string
+  @ManyToOne(() => Kpi)
+  @Field(type => Kpi, {
+    nullable: true,
+    description: 'Reference to the KPI definition for which this value is calculated.'
+  })
+  kpi: Kpi
+
+  @RelationId((kpiValue: KpiValue) => kpiValue.kpi)
+  @Field({ description: 'ID of the referenced KPI.' })
+  kpiId: string
+
+  @Column('int')
+  @Field(type => Int, { description: 'Version of the KPI definition at the time this value was calculated.' })
+  version: number
+
+  @Column({ type: 'date' })
+  @Field({ description: 'Date or period for which this KPI value is recorded (e.g., day, month, quarter).' })
+  valueDate: string
+
+  @Column('float')
+  @Field(type => Float, { description: 'The calculated numeric value for this KPI and period.' })
+  value: number
 
   @Column({ nullable: true })
-  @Field({ nullable: true })
-  description?: string
+  @Field({
+    nullable: true,
+    description: 'ID of the group (organization, department, project, etc.) this value is associated with.'
+  })
+  groupId?: string
 
-  @Column({ nullable: false, default: false })
-  @Field({ nullable: true })
-  active?: boolean
+  @Column({ nullable: true })
+  @Field({ nullable: true, description: 'Type of the group (e.g., USER, DEPT, PROJECT) for this value.' })
+  groupType?: string
 
   @Column({ nullable: true })
-  @Field({ nullable: true })
-  state?: KpiValueStatus
+  @Field({
+    nullable: true,
+    description: 'Indicates whether this value was entered manually or generated automatically.'
+  })
+  inputType?: KpiValueInputType
 
   @Column({ nullable: true })
-  @Field({ nullable: true })
-  params?: string
+  @Field({ nullable: true, description: 'Source of the value (e.g., system, user, external integration).' })
+  source?: string
+
+  @Column({
+    nullable: true,
+    type:
+      DATABASE_TYPE == 'mysql' || DATABASE_TYPE == 'mariadb'
+        ? 'longtext'
+        : DATABASE_TYPE == 'oracle'
+          ? 'clob'
+          : DATABASE_TYPE == 'mssql'
+            ? 'nvarchar'
+            : 'varchar',
+    length: DATABASE_TYPE == 'mssql' ? 'MAX' : undefined,
+    transformer: json5Transformer
+  })
+  @Field(type => ScalarObject, {
+    nullable: true,
+    description:
+      'Extended or non-numeric information related to this KPI value, stored as JSON5. Can include grade, status, comments, or other metadata.'
+  })
+  meta?: any
 
   @CreateDateColumn()
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'Timestamp when this KPI value record was created.' })
   createdAt?: Date
 
   @UpdateDateColumn()
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'Timestamp when this KPI value record was last updated.' })
   updatedAt?: Date
 
   @ManyToOne(type => User, { nullable: true })
-  @Field(type => User, { nullable: true })
+  @Field(type => User, { nullable: true, description: 'User who created this KPI value record.' })
   creator?: User
 
   @RelationId((kpiValue: KpiValue) => kpiValue.creator)
+  @Field({ nullable: true, description: 'ID of the user who created this KPI value record.' })
   creatorId?: string
 
   @ManyToOne(type => User, { nullable: true })
-  @Field(type => User, { nullable: true })
+  @Field(type => User, { nullable: true, description: 'User who last updated this KPI value record.' })
   updater?: User
 
   @RelationId((kpiValue: KpiValue) => kpiValue.updater)
+  @Field({ nullable: true, description: 'ID of the user who last updated this KPI value record.' })
   updaterId?: string
 }

package/things-factory.config.js

@@ -1,10 +1,18 @@
 import route from './dist-client/route'
-import bootstrap from './dist-client/bootstrap'
+// import bootstrap from './dist-client/bootstrap'
 
 export default {
   route,
   routes: [
-    { tagname: 'kpi-main', page: 'kpi-main' }
-  ],
-  bootstrap
+    { tagname: 'kpi-overview', page: 'kpi-overview' },
+    { tagname: 'kpi-dashboard', page: 'kpi-dashboard' },
+    { tagname: 'kpi-list-page', page: 'kpi-list' },
+    { tagname: 'kpi-category-list-page', page: 'kpi-category-list' },
+    { tagname: 'kpi-metric-list-page', page: 'kpi-metric-list' },
+    { tagname: 'kpi-value-list-page', page: 'kpi-value-list' },
+    { tagname: 'kpi-value-manual-entry-page', page: 'kpi-value-manual-entry' },
+    { tagname: 'kpi-grade-list-page', page: 'kpi-grade-list' },
+    { tagname: 'kpi-history-list-page', page: 'kpi-history-list' }
+  ]
+  // bootstrap
 }

package/translations/en.json

@@ -1 +1,12 @@
-{}
+{
+  "title.kpi list": "KPI List",
+  "title.kpi category list": "KPI Catogory List",
+  "title.kpi grade list": "KPI Grade List",
+  "title.kpi metric list": "KPI Metric List",
+  "title.kpi value list": "KPI Value List",
+  "title.kpi performance board": "KPI Performance Board",
+  "title.kpi management center": "KPI Management Center",
+  "title.kpi overview": "KPI Overview",
+  "title.kpi value manual entry": "KPI Value Manual Entry",
+  "button.enter-kpi-value": "Enter KPI Value"
+}

package/translations/ja.json

@@ -1 +1,12 @@
-{}
+{
+  "title.kpi list": "KPI リスト",
+  "title.kpi category list": "KPI カテゴリ リスト",
+  "title.kpi grade list": "KPI グレード リスト",
+  "title.kpi metric list": "KPI メトリック リスト",
+  "title.kpi value list": "KPI 値 リスト",
+  "title.kpi performance board": "KPI パフォーマンス ボード",
+  "title.kpi management center": "KPI 管理 センター",
+  "title.kpi overview": "KPI 概要",
+  "title.kpi value manual entry": "KPI 値 手入力",
+  "button.enter-kpi-value": "KPI 値 入力"
+}

package/translations/ko.json

@@ -1 +1,12 @@
-{}
+{
+  "title.kpi list": "KPI 목록",
+  "title.kpi category list": "KPI 카테고리 목록",
+  "title.kpi grade list": "KPI 등급 목록",
+  "title.kpi metric list": "KPI 지표 목록",
+  "title.kpi value list": "KPI 값 목록",
+  "title.kpi performance board": "KPI 성과 보드",
+  "title.kpi management center": "KPI 관리 센터",
+  "title.kpi overview": "KPI 개요",
+  "title.kpi value manual entry": "KPI 값 수기 입력",
+  "button.enter-kpi-value": "KPI 값 입력"
+}

package/translations/ms.json

@@ -1 +1,12 @@
-{}
+{
+  "title.kpi list": "Senarai KPI",
+  "title.kpi category list": "Senarai Kategori KPI",
+  "title.kpi grade list": "Senarai Gred KPI",
+  "title.kpi metric list": "Senarai Metrik KPI",
+  "title.kpi value list": "Senarai Nilai KPI",
+  "title.kpi performance board": "Papan KPI",
+  "title.kpi management center": "Pusat Pengurusan KPI",
+  "title.kpi overview": "Pengenalan KPI",
+  "title.kpi value manual entry": "KPI 値 手入力",
+  "button.enter-kpi-value": "KPI 値 入力"
+}

package/translations/zh.json

@@ -1 +1,12 @@
-{}
+{
+  "title.kpi list": "KPI 列表",
+  "title.kpi category list": "KPI 分类列表",
+  "title.kpi grade list": "KPI 等级列表",
+  "title.kpi metric list": "KPI 指标列表",
+  "title.kpi value list": "KPI 值列表",
+  "title.kpi performance board": "KPI 绩效看板",
+  "title.kpi management center": "KPI 管理中心",
+  "title.kpi overview": "KPI 概述",
+  "title.kpi value manual entry": "KPI 值手动输入",
+  "button.enter-kpi-value": "KPI 值手动输入"
+}

package/client/pages/kpe-metric/kpe-metric-importer.ts

@@ -1,90 +0,0 @@
-import '@material/web/icon/icon.js'
-import '@operato/data-grist'
-
-import gql from 'graphql-tag'
-import { css, html, LitElement } from 'lit'
-import { property } from 'lit/decorators.js'
-
-import { client } from '@operato/graphql'
-import { i18next } from '@operato/i18n'
-import { isMobileDevice } from '@operato/utils'
-import { ButtonContainerStyles } from '@operato/styles'
-
-export class KpeMetricImporter extends LitElement {
-  static styles = [
-    ButtonContainerStyles,
-    css`
-      :host {
-        display: flex;
-        flex-direction: column;
-
-        background-color: #fff;
-      }
-
-      ox-grist {
-        flex: 1;
-      }
-    `
-  ]
-
-  @property({ type: Array }) kpeMetrics: any[] = []
-  @property({ type: Object }) columns = {
-    list: { fields: ['name', 'description'] },
-    pagination: { infinite: true },
-    columns: [
-      {
-        type: 'string',
-        name: 'name',
-        header: i18next.t('field.name'),
-        width: 150
-      },
-      {
-        type: 'string',
-        name: 'description',
-        header: i18next.t('field.description'),
-        width: 200
-      },
-      {
-        type: 'checkbox',
-        name: 'active',
-        header: i18next.t('field.active'),
-        width: 60
-      }
-    ]
-  }
-
-
-  render() {
-    return html`
-      <ox-grist
-        .mode=${isMobileDevice() ? 'LIST' : 'GRID'}
-        .config=${this.columns}
-        .data=${
-          { 
-            records: this.kpeMetrics 
-          }
-        }
-      ></ox-grist>
-
-      <div class="button-container">
-        <button @click="${this.save.bind(this)}"><md-icon>save</md-icon>${i18next.t('button.save')}</button>
-      </div>
-    `
-  }
-
-  async save() {
-    const response = await client.mutate({
-      mutation: gql`
-        mutation importKpeMetrics($kpeMetrics: [KpeMetricPatch!]!) {
-          importKpeMetrics(kpeMetrics: $kpeMetrics)
-        }
-      `,
-      variables: { kpeMetrics: this.kpeMetrics }
-    })
-
-    if (response.errors?.length) return
-
-    this.dispatchEvent(new CustomEvent('imported'))
-  }
-}
-