@things-factory/kpi 1.0.0-alpha.5

package/server/service/kpi-metric/kpi-metric-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 { KpiMetric, KpiMetricStatus } from './kpi-metric'
+
+const ORMCONFIG = config.get('ormconfig', {})
+const DATABASE_TYPE = ORMCONFIG.type
+
+@Entity()
+@Index(
+  'ix_kpi-metric_history_0',
+  (kpiMetricHistory: KpiMetricHistory) => [kpiMetricHistory.originalId, kpiMetricHistory.version],
+  { unique: true }
+)
+@Index(
+  'ix_kpi-metric_history_1',
+  (kpiMetricHistory: KpiMetricHistory) => [kpiMetricHistory.domain, kpiMetricHistory.originalId, kpiMetricHistory.version],
+  { unique: true }
+)
+@ObjectType({ description: 'History Entity of KpiMetric' })
+export class KpiMetricHistory implements HistoryEntityInterface<KpiMetric> {
+  @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((kpiMetric: KpiMetric) => kpiMetric.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?: KpiMetricStatus
+
+  @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((kpiMetric: KpiMetric) => kpiMetric.creator)
+  creatorId?: string
+
+  @ManyToOne(type => User, { nullable: true })
+  @Field(type => User, { nullable: true })
+  updater?: User
+
+  @RelationId((kpiMetric: KpiMetric) => kpiMetric.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-metric/kpi-metric-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 { KpiMetric } from './kpi-metric'
+import { NewKpiMetric, KpiMetricPatch } from './kpi-metric-type'
+
+@Resolver(KpiMetric)
+export class KpiMetricMutation {
+  @Directive('@transaction')
+  @Mutation(returns => KpiMetric, { description: 'To create new KpiMetric' })
+  async createKpiMetric(@Arg('kpiMetric') kpiMetric: NewKpiMetric, @Ctx() context: ResolverContext): Promise<KpiMetric> {
+    const { domain, user, tx } = context.state
+
+    const result = await getRepository(KpiMetric, tx).save({
+      ...kpiMetric,
+      domain,
+      creator: user,
+      updater: user
+    })
+
+    if (kpiMetric.thumbnail) {
+      await createAttachment(
+        null,
+        {
+          attachment: {
+            file: kpiMetric.thumbnail,
+            refType: KpiMetric.name,
+            refBy: result.id
+          }
+        },
+        context
+      )
+    }
+
+    return result
+  }
+
+  @Directive('@transaction')
+  @Mutation(returns => KpiMetric, { description: 'To modify KpiMetric information' })
+  async updateKpiMetric(
+    @Arg('id') id: string,
+    @Arg('patch') patch: KpiMetricPatch,
+    @Ctx() context: ResolverContext
+  ): Promise<KpiMetric> {
+    const { domain, user, tx } = context.state
+
+    const repository = getRepository(KpiMetric, tx)
+    const kpiMetric = await repository.findOne({
+      where: { domain: { id: domain.id }, id }
+    })
+
+    const result = await repository.save({
+      ...kpiMetric,
+      ...patch,
+      updater: user
+    })
+
+    if (patch.thumbnail) {
+      await deleteAttachmentsByRef(null, { refBys: [result.id] }, context)
+      await createAttachment(
+        null,
+        {
+          attachment: {
+            file: patch.thumbnail,
+            refType: KpiMetric.name,
+            refBy: result.id
+          }
+        },
+        context
+      )
+    }
+
+    return result
+  }
+
+  @Directive('@transaction')
+  @Mutation(returns => [KpiMetric], { description: "To modify multiple KpiMetrics' information" })
+  async updateMultipleKpiMetric(
+    @Arg('patches', type => [KpiMetricPatch]) patches: KpiMetricPatch[],
+    @Ctx() context: ResolverContext
+  ): Promise<KpiMetric[]> {
+    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 kpiMetricRepo = getRepository(KpiMetric, tx)
+
+    if (_createRecords.length > 0) {
+      for (let i = 0; i < _createRecords.length; i++) {
+        const newRecord = _createRecords[i]
+
+        const result = await kpiMetricRepo.save({
+          ...newRecord,
+          domain,
+          creator: user,
+          updater: user
+        })
+
+        if (newRecord.thumbnail) {
+          await createAttachment(
+            null,
+            {
+              attachment: {
+                file: newRecord.thumbnail,
+                refType: KpiMetric.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 kpiMetric = await kpiMetricRepo.findOneBy({ id: updateRecord.id })
+
+        const result = await kpiMetricRepo.save({
+          ...kpiMetric,
+          ...updateRecord,
+          updater: user
+        })
+
+        if (updateRecord.thumbnail) {
+          await deleteAttachmentsByRef(null, { refBys: [result.id] }, context)
+          await createAttachment(
+            null,
+            {
+              attachment: {
+                file: updateRecord.thumbnail,
+                refType: KpiMetric.name,
+                refBy: result.id
+              }
+            },
+            context
+          )
+        }
+
+        results.push({ ...result, cuFlag: 'M' })
+      }
+    }
+
+    return results
+  }
+
+  @Directive('@transaction')
+  @Mutation(returns => Boolean, { description: 'To delete KpiMetric' })
+  async deleteKpiMetric(@Arg('id') id: string, @Ctx() context: ResolverContext): Promise<boolean> {
+    const { domain, tx } = context.state
+
+    await getRepository(KpiMetric, tx).delete({ domain: { id: domain.id }, id })
+    await deleteAttachmentsByRef(null, { refBys: [id] }, context)
+
+    return true
+  }
+
+  @Directive('@transaction')
+  @Mutation(returns => Boolean, { description: 'To delete multiple KpiMetrics' })
+  async deleteKpiMetrics(
+    @Arg('ids', type => [String]) ids: string[],
+    @Ctx() context: ResolverContext
+  ): Promise<boolean> {
+    const { domain, tx } = context.state
+
+    await getRepository(KpiMetric, 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 KpiMetrics' })
+  async importKpiMetrics(
+    @Arg('kpiMetrics', type => [KpiMetricPatch]) kpiMetrics: KpiMetricPatch[],
+    @Ctx() context: ResolverContext
+  ): Promise<boolean> {
+    const { domain, tx } = context.state
+
+    await Promise.all(
+      kpiMetrics.map(async (kpiMetric: KpiMetricPatch) => {
+        const createdKpiMetric: KpiMetric = await getRepository(KpiMetric, tx).save({ domain, ...kpiMetric })
+      })
+    )
+
+    return true
+  }
+}

package/server/service/kpi-metric/kpi-metric-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 { KpiMetric } from './kpi-metric'
+import { KpiMetricList } from './kpi-metric-type'
+
+@Resolver(KpiMetric)
+export class KpiMetricQuery {
+  @Query(returns => KpiMetric!, { nullable: true, description: 'To fetch a KpiMetric' })
+  async kpiMetric(@Arg('id') id: string, @Ctx() context: ResolverContext): Promise<KpiMetric> {
+    const { domain } = context.state
+
+    return await getRepository(KpiMetric).findOne({
+      where: { domain: { id: domain.id }, id }
+    })
+  }
+
+  @Query(returns => KpiMetricList, { description: 'To fetch multiple KpiMetrics' })
+  async kpiMetrics(@Args(type => ListParam) params: ListParam, @Ctx() context: ResolverContext): Promise<KpiMetricList> {
+    const { domain } = context.state
+
+    const queryBuilder = getQueryBuilderFromListParams({
+      domain,
+      params,
+      repository: await getRepository(KpiMetric),
+      searchables: ['name', 'description']
+    })
+
+    const [items, total] = await queryBuilder.getManyAndCount()
+
+    return { items, total }
+  }
+
+  @FieldResolver(type => String)
+  async thumbnail(@Root() kpiMetric: KpiMetric): Promise<string | undefined> {
+    const attachment: Attachment = await getRepository(Attachment).findOne({
+      where: {
+        domain: { id: kpiMetric.domainId },
+        refType: KpiMetric.name,
+        refBy: kpiMetric.id
+      }
+    })
+
+    return attachment?.fullpath
+  }
+
+  @FieldResolver(type => Domain)
+  async domain(@Root() kpiMetric: KpiMetric): Promise<Domain> {
+    return kpiMetric.domainId && (await getRepository(Domain).findOneBy({ id: kpiMetric.domainId }))
+  }
+
+  @FieldResolver(type => User)
+  async updater(@Root() kpiMetric: KpiMetric): Promise<User> {
+    return kpiMetric.updaterId && (await getRepository(User).findOneBy({ id: kpiMetric.updaterId }))
+  }
+
+  @FieldResolver(type => User)
+  async creator(@Root() kpiMetric: KpiMetric): Promise<User> {
+    return kpiMetric.creatorId && (await getRepository(User).findOneBy({ id: kpiMetric.creatorId }))
+  }
+}

package/server/service/kpi-metric/kpi-metric-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 { KpiMetric, KpiMetricStatus } from './kpi-metric'
+
+@InputType()
+export class NewKpiMetric {
+  @Field()
+  name: string
+
+  @Field({ nullable: true })
+  description?: string
+
+  @Field(type => KpiMetricStatus, { nullable: true })
+  state?: KpiMetricStatus
+
+  @Field({ nullable: true })
+  active?: boolean
+
+  @Field({ nullable: true })
+  params?: string
+
+  @Field(type => GraphQLUpload, { nullable: true })
+  thumbnail?: FileUpload
+}
+
+@InputType()
+export class KpiMetricPatch {
+  @Field(type => ID, { nullable: true })
+  id?: string
+
+  @Field({ nullable: true })
+  name?: string
+
+  @Field({ nullable: true })
+  description?: string
+
+  @Field(type => KpiMetricStatus, { nullable: true })
+  state?: KpiMetricStatus
+
+  @Field({ nullable: true })
+  active?: boolean
+
+  @Field(type => GraphQLUpload, { nullable: true })
+  thumbnail?: FileUpload
+  
+  @Field({ nullable: true })
+  cuFlag?: string
+}
+
+@ObjectType()
+export class KpiMetricList {
+  @Field(type => [KpiMetric])
+  items: KpiMetric[]
+
+  @Field(type => Int)
+  total: number
+}

package/server/service/kpi-metric/kpi-metric.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 KpiMetricStatus {
+  STATUS_A = 'STATUS_A',
+  STATUS_B = 'STATUS_B'
+}
+
+registerEnumType(KpiMetricStatus, {
+  name: 'KpiMetricStatus',
+  description: 'state enumeration of a kpiMetric'
+})
+
+@Entity()
+@Index('ix_kpi_metric_0', (kpiMetric: KpiMetric) => [kpiMetric.domain, kpiMetric.name], {
+  where: '"deleted_at" IS NULL',
+  unique: true
+})
+@ObjectType({ description: 'Entity for KpiMetric' })
+export class KpiMetric {
+  @PrimaryGeneratedColumn('uuid')
+  @Field(type => ID)
+  readonly id: string
+  
+  @VersionColumn()
+  @Field({ nullable: true })
+  version?: number = 1
+
+  @ManyToOne(type => Domain)
+  @Field({ nullable: true })
+  domain?: Domain
+
+  @RelationId((kpiMetric: KpiMetric) => kpiMetric.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?: KpiMetricStatus
+
+  @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((kpiMetric: KpiMetric) => kpiMetric.creator)
+  creatorId?: string
+
+  @ManyToOne(type => User, { nullable: true })
+  @Field(type => User, { nullable: true })
+  updater?: User
+
+  @RelationId((kpiMetric: KpiMetric) => kpiMetric.updater)
+  updaterId?: string
+
+  @Field(type => String, { nullable: true })
+  thumbnail?: string
+}

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

@@ -0,0 +1,7 @@
+import { KpiValue } from './kpi-value'
+import { KpiValueQuery } from './kpi-value-query'
+import { KpiValueMutation } from './kpi-value-mutation'
+
+export const entities = [KpiValue]
+export const resolvers = [KpiValueQuery, KpiValueMutation]
+export const subscribers = []

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

@@ -0,0 +1,137 @@
+import { Resolver, Mutation, Arg, Ctx, Directive } from 'type-graphql'
+import { In } from 'typeorm'
+import { getRepository } from '@things-factory/shell'
+
+import { KpiValue } from './kpi-value'
+import { NewKpiValue, KpiValuePatch } from './kpi-value-type'
+
+@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> {
+    const { domain, user, tx } = context.state
+
+    const result = await getRepository(KpiValue, tx).save({
+      ...kpiValue,
+      domain,
+      creator: user,
+      updater: user
+    })
+
+    return result
+  }
+
+  @Directive('@transaction')
+  @Mutation(returns => KpiValue, { description: 'To modify KpiValue information' })
+  async updateKpiValue(
+    @Arg('id') id: string,
+    @Arg('patch') patch: KpiValuePatch,
+    @Ctx() context: ResolverContext
+  ): Promise<KpiValue> {
+    const { domain, user, tx } = context.state
+
+    const repository = getRepository(KpiValue, tx)
+    const kpiValue = await repository.findOne({
+      where: { domain: { id: domain.id }, id }
+    })
+
+    const result = await repository.save({
+      ...kpiValue,
+      ...patch,
+      updater: user
+    })
+
+    return result
+  }
+
+  @Directive('@transaction')
+  @Mutation(returns => [KpiValue], { description: "To modify multiple KpiValues' information" })
+  async updateMultipleKpiValue(
+    @Arg('patches', type => [KpiValuePatch]) patches: KpiValuePatch[],
+    @Ctx() context: ResolverContext
+  ): Promise<KpiValue[]> {
+    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 kpiValueRepo = getRepository(KpiValue, tx)
+
+    if (_createRecords.length > 0) {
+      for (let i = 0; i < _createRecords.length; i++) {
+        const newRecord = _createRecords[i]
+
+        const result = await kpiValueRepo.save({
+          ...newRecord,
+          domain,
+          creator: user,
+          updater: user
+        })
+
+        results.push({ ...result, cuFlag: '+' })
+      }
+    }
+
+    if (_updateRecords.length > 0) {
+      for (let i = 0; i < _updateRecords.length; i++) {
+        const updateRecord = _updateRecords[i]
+        const kpiValue = await kpiValueRepo.findOneBy({ id: updateRecord.id })
+
+        const result = await kpiValueRepo.save({
+          ...kpiValue,
+          ...updateRecord,
+          updater: user
+        })
+
+        results.push({ ...result, cuFlag: 'M' })
+      }
+    }
+
+    return results
+  }
+
+  @Directive('@transaction')
+  @Mutation(returns => Boolean, { description: 'To delete KpiValue' })
+  async deleteKpiValue(@Arg('id') id: string, @Ctx() context: ResolverContext): Promise<boolean> {
+    const { domain, tx } = context.state
+
+    await getRepository(KpiValue, tx).delete({ domain: { id: domain.id }, id })
+
+    return true
+  }
+
+  @Directive('@transaction')
+  @Mutation(returns => Boolean, { description: 'To delete multiple KpiValues' })
+  async deleteKpiValues(
+    @Arg('ids', type => [String]) ids: string[],
+    @Ctx() context: ResolverContext
+  ): Promise<boolean> {
+    const { domain, tx } = context.state
+
+    await getRepository(KpiValue, tx).delete({
+      domain: { id: domain.id },
+      id: In(ids)
+    })
+
+
+    return true
+  }
+
+  @Directive('@transaction')
+  @Mutation(returns => Boolean, { description: 'To import multiple KpiValues' })
+  async importKpiValues(
+    @Arg('kpiValues', type => [KpiValuePatch]) kpiValues: KpiValuePatch[],
+    @Ctx() context: ResolverContext
+  ): Promise<boolean> {
+    const { domain, tx } = context.state
+
+    await Promise.all(
+      kpiValues.map(async (kpiValue: KpiValuePatch) => {
+        const createdKpiValue: KpiValue = await getRepository(KpiValue, tx).save({ domain, ...kpiValue })
+      })
+    )
+
+    return true
+  }
+}