@things-factory/kpi 1.0.0-alpha.5

package/server/index.ts

@@ -0,0 +1,3 @@
+export * from './service'
+
+import './routes'

package/server/routes.ts

@@ -0,0 +1,26 @@
+process.on('bootstrap-module-global-public-route' as any, (app, globalPublicRouter) => {
+  /*
+   * can add global public routes to application (auth not required, tenancy not required)
+   *
+   * ex) routes.get('/path', async(context, next) => {})
+   * ex) routes.post('/path', async(context, next) => {})
+   */
+})
+
+process.on('bootstrap-module-global-private-route' as any, (app, globalPrivateRouter) => {
+  /*
+   * can add global private routes to application (auth required, tenancy not required)
+   */
+})
+
+process.on('bootstrap-module-domain-public-route' as any, (app, domainPublicRouter) => {
+  /*
+   * can add domain public routes to application (auth not required, tenancy required)
+   */
+})
+
+process.on('bootstrap-module-domain-private-route' as any, (app, domainPrivateRouter) => {
+  /*
+   * can add domain private routes to application (auth required, tenancy required)
+   */
+})

package/server/service/index.ts

@@ -0,0 +1,43 @@
+/* EXPORT ENTITY TYPES */
+export * from './kpi/kpi'
+export * from './kpi/kpi-type'
+export * from './kpi-formula/kpi-formula'
+export * from './kpi-formula/kpi-formula-type'
+export * from './kpi-category/kpi-category'
+export * from './kpi-category/kpi-category-type'
+export * from './kpi-grade/kpi-grade'
+export * from './kpi-grade/kpi-grade-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'
+
+/* IMPORT ENTITIES AND RESOLVERS */
+import { entities as KpiEntities, resolvers as KpiResolvers } from './kpi'
+import { entities as KpiFormulaEntities, resolvers as KpiFormulaResolvers } from './kpi-formula'
+import { entities as KpiCategoryEntities, resolvers as KpiCategoryResolvers } from './kpi-category'
+import { entities as KpiGradeEntities, resolvers as KpiGradeResolvers } from './kpi-grade'
+import { entities as KpiValueEntities, resolvers as KpiValueResolvers } from './kpi-value'
+import { entities as KpiMetricEntities, resolvers as KpiMetricResolvers } from './kpi-metric'
+
+export const entities = [
+  /* ENTITIES */
+  ...KpiEntities,
+  ...KpiFormulaEntities,
+  ...KpiCategoryEntities,
+  ...KpiGradeEntities,
+  ...KpiValueEntities,
+  ...KpiMetricEntities
+]
+
+export const schema = {
+  resolverClasses: [
+    /* RESOLVER CLASSES */
+    ...KpiResolvers,
+    ...KpiFormulaResolvers,
+    ...KpiCategoryResolvers,
+    ...KpiGradeResolvers,
+    ...KpiValueResolvers,
+    ...KpiMetricResolvers
+  ]
+}

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

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

package/server/service/kpi/index.ts

@@ -0,0 +1,9 @@
+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-history.ts

@@ -0,0 +1,116 @@
+import { Field, ID, ObjectType } from 'type-graphql'
+import { Column, Entity, Index, ManyToOne, PrimaryGeneratedColumn, RelationId } 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 } from '@things-factory/shell'
+
+import { Kpi, KpiStatus } from './kpi'
+
+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 })
+  active?: boolean
+
+  @Column({ nullable: true })
+  @Field({ nullable: true })
+  state?: KpiStatus
+
+  @Column({ nullable: true })
+  @Field({ nullable: true })
+  params?: string
+
+  @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
+
+  @Field(type => String, { nullable: true })
+  thumbnail?: 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
+}

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

@@ -0,0 +1,198 @@
+import { Resolver, Mutation, Arg, Ctx, Directive } from 'type-graphql'
+import { In } from 'typeorm'
+import { getRepository } from '@things-factory/shell'
+
+import { createAttachment, deleteAttachmentsByRef } from '@things-factory/attachment-base'
+import { Kpi } from './kpi'
+import { NewKpi, KpiPatch } from './kpi-type'
+
+@Resolver(Kpi)
+export class KpiMutation {
+  @Directive('@transaction')
+  @Mutation(returns => Kpi, { description: 'To create new Kpi' })
+  async createKpi(@Arg('kpi') kpi: NewKpi, @Ctx() context: ResolverContext): Promise<Kpi> {
+    const { domain, user, tx } = context.state
+
+    const result = await getRepository(Kpi, tx).save({
+      ...kpi,
+      domain,
+      creator: user,
+      updater: user
+    })
+
+    if (kpi.thumbnail) {
+      await createAttachment(
+        null,
+        {
+          attachment: {
+            file: kpi.thumbnail,
+            refType: Kpi.name,
+            refBy: result.id
+          }
+        },
+        context
+      )
+    }
+
+    return result
+  }
+
+  @Directive('@transaction')
+  @Mutation(returns => Kpi, { description: 'To modify Kpi information' })
+  async updateKpi(
+    @Arg('id') id: string,
+    @Arg('patch') patch: KpiPatch,
+    @Ctx() context: ResolverContext
+  ): Promise<Kpi> {
+    const { domain, user, tx } = context.state
+
+    const repository = getRepository(Kpi, tx)
+    const kpi = await repository.findOne({
+      where: { domain: { id: domain.id }, id }
+    })
+
+    const result = await repository.save({
+      ...kpi,
+      ...patch,
+      updater: user
+    })
+
+    if (patch.thumbnail) {
+      await deleteAttachmentsByRef(null, { refBys: [result.id] }, context)
+      await createAttachment(
+        null,
+        {
+          attachment: {
+            file: patch.thumbnail,
+            refType: Kpi.name,
+            refBy: result.id
+          }
+        },
+        context
+      )
+    }
+
+    return result
+  }
+
+  @Directive('@transaction')
+  @Mutation(returns => [Kpi], { description: "To modify multiple Kpis' information" })
+  async updateMultipleKpi(
+    @Arg('patches', type => [KpiPatch]) patches: KpiPatch[],
+    @Ctx() context: ResolverContext
+  ): Promise<Kpi[]> {
+    const { domain, user, tx } = context.state
+
+    let results = []
+    const _createRecords = patches.filter((patch: any) => patch.cuFlag.toUpperCase() === '+')
+    const _updateRecords = patches.filter((patch: any) => patch.cuFlag.toUpperCase() === 'M')
+    const kpiRepo = getRepository(Kpi, tx)
+
+    if (_createRecords.length > 0) {
+      for (let i = 0; i < _createRecords.length; i++) {
+        const newRecord = _createRecords[i]
+
+        const result = await kpiRepo.save({
+          ...newRecord,
+          domain,
+          creator: user,
+          updater: user
+        })
+
+        if (newRecord.thumbnail) {
+          await createAttachment(
+            null,
+            {
+              attachment: {
+                file: newRecord.thumbnail,
+                refType: Kpi.name,
+                refBy: result.id
+              }
+            },
+            context
+          )
+        }
+
+        results.push({ ...result, cuFlag: '+' })
+      }
+    }
+
+    if (_updateRecords.length > 0) {
+      for (let i = 0; i < _updateRecords.length; i++) {
+        const updateRecord = _updateRecords[i]
+        const kpi = await kpiRepo.findOneBy({ id: updateRecord.id })
+
+        const result = await kpiRepo.save({
+          ...kpi,
+          ...updateRecord,
+          updater: user
+        })
+
+        if (updateRecord.thumbnail) {
+          await deleteAttachmentsByRef(null, { refBys: [result.id] }, context)
+          await createAttachment(
+            null,
+            {
+              attachment: {
+                file: updateRecord.thumbnail,
+                refType: Kpi.name,
+                refBy: result.id
+              }
+            },
+            context
+          )
+        }
+
+        results.push({ ...result, cuFlag: 'M' })
+      }
+    }
+
+    return results
+  }
+
+  @Directive('@transaction')
+  @Mutation(returns => Boolean, { description: 'To delete Kpi' })
+  async deleteKpi(@Arg('id') id: string, @Ctx() context: ResolverContext): Promise<boolean> {
+    const { domain, tx } = context.state
+
+    await getRepository(Kpi, tx).delete({ domain: { id: domain.id }, id })
+    await deleteAttachmentsByRef(null, { refBys: [id] }, context)
+
+    return true
+  }
+
+  @Directive('@transaction')
+  @Mutation(returns => Boolean, { description: 'To delete multiple Kpis' })
+  async deleteKpis(
+    @Arg('ids', type => [String]) ids: string[],
+    @Ctx() context: ResolverContext
+  ): Promise<boolean> {
+    const { domain, tx } = context.state
+
+    await getRepository(Kpi, tx).delete({
+      domain: { id: domain.id },
+      id: In(ids)
+    })
+
+    await deleteAttachmentsByRef(null, { refBys: ids }, context)
+
+    return true
+  }
+
+  @Directive('@transaction')
+  @Mutation(returns => Boolean, { description: 'To import multiple Kpis' })
+  async importKpis(
+    @Arg('kpis', type => [KpiPatch]) kpis: KpiPatch[],
+    @Ctx() context: ResolverContext
+  ): Promise<boolean> {
+    const { domain, tx } = context.state
+
+    await Promise.all(
+      kpis.map(async (kpi: KpiPatch) => {
+        const createdKpi: Kpi = await getRepository(Kpi, tx).save({ domain, ...kpi })
+      })
+    )
+
+    return true
+  }
+}

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

@@ -0,0 +1,62 @@
+import { Resolver, Query, FieldResolver, Root, Args, Arg, Ctx, Directive } from 'type-graphql'
+import { Attachment } from '@things-factory/attachment-base'
+import { Domain, getQueryBuilderFromListParams, getRepository, ListParam } from '@things-factory/shell'
+import { User } from '@things-factory/auth-base'
+import { Kpi } from './kpi'
+import { KpiList } from './kpi-type'
+
+@Resolver(Kpi)
+export class KpiQuery {
+  @Query(returns => Kpi!, { nullable: true, description: 'To fetch a Kpi' })
+  async kpi(@Arg('id') id: string, @Ctx() context: ResolverContext): Promise<Kpi> {
+    const { domain } = context.state
+
+    return await getRepository(Kpi).findOne({
+      where: { domain: { id: domain.id }, id }
+    })
+  }
+
+  @Query(returns => KpiList, { description: 'To fetch multiple Kpis' })
+  async kpis(@Args(type => ListParam) params: ListParam, @Ctx() context: ResolverContext): Promise<KpiList> {
+    const { domain } = context.state
+
+    const queryBuilder = getQueryBuilderFromListParams({
+      domain,
+      params,
+      repository: await getRepository(Kpi),
+      searchables: ['name', 'description']
+    })
+
+    const [items, total] = await queryBuilder.getManyAndCount()
+
+    return { items, total }
+  }
+
+  @FieldResolver(type => String)
+  async thumbnail(@Root() kpi: Kpi): Promise<string | undefined> {
+    const attachment: Attachment = await getRepository(Attachment).findOne({
+      where: {
+        domain: { id: kpi.domainId },
+        refType: Kpi.name,
+        refBy: kpi.id
+      }
+    })
+
+    return attachment?.fullpath
+  }
+
+  @FieldResolver(type => Domain)
+  async domain(@Root() kpi: Kpi): Promise<Domain> {
+    return kpi.domainId && (await getRepository(Domain).findOneBy({ id: kpi.domainId }))
+  }
+
+  @FieldResolver(type => User)
+  async updater(@Root() kpi: Kpi): Promise<User> {
+    return kpi.updaterId && (await getRepository(User).findOneBy({ id: kpi.updaterId }))
+  }
+
+  @FieldResolver(type => User)
+  async creator(@Root() kpi: Kpi): Promise<User> {
+    return kpi.creatorId && (await getRepository(User).findOneBy({ id: kpi.creatorId }))
+  }
+}

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

@@ -0,0 +1,61 @@
+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 { ObjectRef, ScalarObject } from '@things-factory/shell'
+
+import { Kpi, KpiStatus } from './kpi'
+
+@InputType()
+export class NewKpi {
+  @Field()
+  name: string
+
+  @Field({ nullable: true })
+  description?: string
+
+  @Field(type => KpiStatus, { nullable: true })
+  state?: KpiStatus
+
+  @Field({ nullable: true })
+  active?: boolean
+
+  @Field({ nullable: true })
+  params?: string
+
+  @Field(type => GraphQLUpload, { nullable: true })
+  thumbnail?: FileUpload
+}
+
+@InputType()
+export class KpiPatch {
+  @Field(type => ID, { nullable: true })
+  id?: string
+
+  @Field({ nullable: true })
+  name?: string
+
+  @Field({ nullable: true })
+  description?: string
+
+  @Field(type => KpiStatus, { nullable: true })
+  state?: KpiStatus
+
+  @Field({ nullable: true })
+  active?: boolean
+
+  @Field(type => GraphQLUpload, { nullable: true })
+  thumbnail?: FileUpload
+  
+  @Field({ nullable: true })
+  cuFlag?: string
+}
+
+@ObjectType()
+export class KpiList {
+  @Field(type => [Kpi])
+  items: Kpi[]
+
+  @Field(type => Int)
+  total: number
+}

package/server/service/kpi/kpi.ts

@@ -0,0 +1,98 @@
+import {
+  CreateDateColumn,
+  UpdateDateColumn,
+  DeleteDateColumn,
+  Entity,
+  Index,
+  Column,
+  RelationId,
+  ManyToOne,
+  VersionColumn,
+  PrimaryGeneratedColumn
+} from 'typeorm'
+import { ObjectType, Field, Int, ID, registerEnumType } from 'type-graphql'
+
+import { Domain } from '@things-factory/shell'
+import { User } from '@things-factory/auth-base'
+
+export enum KpiStatus {
+  STATUS_A = 'STATUS_A',
+  STATUS_B = 'STATUS_B'
+}
+
+registerEnumType(KpiStatus, {
+  name: 'KpiStatus',
+  description: 'state enumeration of a kpi'
+})
+
+@Entity()
+@Index('ix_kpi_0', (kpi: Kpi) => [kpi.domain, kpi.name], {
+  where: '"deleted_at" IS NULL',
+  unique: true
+})
+@ObjectType({ description: 'Entity for Kpi' })
+export class Kpi {
+  @PrimaryGeneratedColumn('uuid')
+  @Field(type => ID)
+  readonly id: string
+  
+  @VersionColumn()
+  @Field({ nullable: true })
+  version?: number = 1
+
+  @ManyToOne(type => Domain)
+  @Field({ nullable: true })
+  domain?: Domain
+
+  @RelationId((kpi: Kpi) => kpi.domain)
+  domainId?: string
+
+  @Column()
+  @Field({ nullable: true })
+  name?: string
+
+  @Column({ nullable: true })
+  @Field({ nullable: true })
+  description?: string
+
+  @Column({ nullable: false, default: false })
+  @Field({ nullable: true })
+  active?: boolean
+
+  @Column({ nullable: true })
+  @Field({ nullable: true })
+  state?: KpiStatus
+
+  @Column({ nullable: true })
+  @Field({ nullable: true })
+  params?: string
+
+  @CreateDateColumn()
+  @Field({ nullable: true })
+  createdAt?: Date
+
+  @UpdateDateColumn()
+  @Field({ nullable: true })
+  updatedAt?: Date
+
+  @DeleteDateColumn()
+  @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
+
+  @Field(type => String, { nullable: true })
+  thumbnail?: string
+}

package/server/service/kpi-category/index.ts

@@ -0,0 +1,7 @@
+import { KpiCategory } from './kpi-category'
+import { KpiCategoryQuery } from './kpi-category-query'
+import { KpiCategoryMutation } from './kpi-category-mutation'
+
+export const entities = [KpiCategory]
+export const resolvers = [KpiCategoryQuery, KpiCategoryMutation]
+export const subscribers = []