@things-factory/dataset 8.0.0-alpha.8 → 8.0.0-beta.0

package/server/service/data-set/data-set-query.ts

@@ -1,5 +1,5 @@
 import { Arg, Args, Ctx, Directive, FieldResolver, Query, Resolver, Root } from 'type-graphql'
-import { In } from 'typeorm'
+import { Brackets, In } from 'typeorm'
 
 import { Attachment } from '@things-factory/attachment-base'
 import { Role, User } from '@things-factory/auth-base'
@@ -19,6 +19,7 @@ var parser = require('cron-parser')
 
 @Resolver(DataSet)
 export class DataSetQuery {
+  // 데이터셋을 ID로 조회
   @Directive('@privilege(category: "data-set", privilege: "query", domainOwnerGranted: true)')
   @Query(returns => DataSet, { description: 'To fetch a DataSet' })
   async dataSet(@Arg('id') id: string, @Ctx() context: ResolverContext): Promise<DataSet> {
@@ -29,6 +30,7 @@ export class DataSetQuery {
     })
   }
 
+  // 데이터셋을 이름으로 조회
   @Directive('@privilege(category: "data-set", privilege: "query", domainOwnerGranted: true)')
   @Query(returns => DataSet, { description: 'To fetch a DataSet by name' })
   async dataSetByName(@Arg('name') name: string, @Ctx() context: ResolverContext): Promise<DataSet> {
@@ -39,6 +41,7 @@ export class DataSetQuery {
     })
   }
 
+  // 여러 데이터셋을 조회
   @Directive('@privilege(category: "data-set", privilege: "query", domainOwnerGranted: true)')
   @Query(returns => DataSetList, { description: 'To fetch multiple DataSets' })
   async dataSets(@Args(type => ListParam) params: ListParam, @Ctx() context: ResolverContext): Promise<DataSetList> {
@@ -57,6 +60,7 @@ export class DataSetQuery {
     return { items, total }
   }
 
+  // 데이터 입력을 위한 데이터셋 조회
   @Query(returns => DataSetList, { description: 'To fetch multiple DataSets for data entry manually' })
   async dataSetsForEntry(
     @Args(type => ListParam) params: ListParam,
@@ -64,7 +68,7 @@ export class DataSetQuery {
   ): Promise<DataSetList> {
     var { domain, user } = context.state
 
-    /* 조회한 사용자가 entry-role을 가진 data-set 리스트만 반환 */
+    // 조회한 사용자가 entry-role을 가진 data-set 리스트만 반환
     user = await getRepository(User).findOne({
       where: { id: user.id },
       relations: ['roles']
@@ -86,12 +90,21 @@ export class DataSetQuery {
       searchables: ['name', 'description']
     })
       .andWhere('dataset.active = :active', { active: true })
-      .andWhere('dataset.entryRole IN (:...roles)', { roles })
+      .andWhere(
+        new Brackets(qb => {
+          qb.where('dataset.supervisoryRole IN (:...roles)').orWhere('dataset.entryRole IN (:...roles)')
+        })
+      )
+      .setParameter('roles', roles)
       .getManyAndCount()
 
-    return { items, total }
+    return {
+      items,
+      total
+    }
   }
 
+  // 데이터 보고를 위한 데이터셋 조회
   @Query(returns => DataSetList, { description: 'To fetch multiple DataSets to see data report' })
   async dataSetsForReport(
     @Args(type => ListParam) params: ListParam,
@@ -99,7 +112,7 @@ export class DataSetQuery {
   ): Promise<DataSetList> {
     var { domain, user } = context.state
 
-    /* 조회한 사용자가 supervisory 역할을 가진 data-set 리스트만 반환 */
+    // 조회한 사용자가 supervisory 역할을 가진 data-set 리스트만 반환
     user = await getRepository(User).findOne({
       where: { id: user.id },
       relations: ['roles']
@@ -124,9 +137,10 @@ export class DataSetQuery {
     return { items, total }
   }
 
+  // 데이터셋의 상태를 조회
   @FieldResolver(type => DataSetState)
   async status(@Root() dataSet: DataSet): Promise<DataSetState> {
-    // get information from scheduler service
+    // 스케줄러 서비스에서 정보 가져오기
     return {
       id: '',
       scheduleId: '',
@@ -136,6 +150,7 @@ export class DataSetQuery {
     }
   }
 
+  // 데이터셋의 데이터 항목을 조회
   @FieldResolver(type => [DataItem])
   async dataItems(@Root() dataSet: DataSet): Promise<DataItem[]> {
     if (dataSet.dataItems instanceof Array) {
@@ -145,6 +160,7 @@ export class DataSetQuery {
     return []
   }
 
+  // 데이터셋의 entry 역할을 조회
   @FieldResolver(type => Role)
   async entryRole(@Root() dataSet: DataSet): Promise<Role> {
     return (
@@ -156,7 +172,8 @@ export class DataSetQuery {
     )
   }
 
-  @FieldResolver(type => Role)
+  // 데이터셋의 supervisory 역할을 조회
+  @FieldResolver(type => Role, { description: 'Retrieves the supervisory role for the dataset' })
   async supervisoryRole(@Root() dataSet: DataSet): Promise<Role> {
     return (
       dataSet.supervisoryRole ||
@@ -167,7 +184,19 @@ export class DataSetQuery {
     )
   }
 
-  @FieldResolver(type => [AssigneeItem])
+  // 데이터셋의 resolver 역할을 조회
+  @FieldResolver(type => Role, { description: 'Retrieves the resolver role for the dataset' })
+  async resolverRole(@Root() dataSet: DataSet): Promise<Role> {
+    return (
+      dataSet.resolverRole ||
+      (dataSet.resolverRoleId &&
+        (await getRepository(Role).findOneBy({
+          id: dataSet.resolverRoleId
+        })))
+    )
+  }
+
+  @FieldResolver(type => [AssigneeItem], { description: 'Retrieves the assignee items for the dataset' })
   async assignees(@Root() dataSet: DataSet, @Ctx() context: ResolverContext): Promise<AssigneeItem[]> {
     const { domain, user } = context.state
     const { assignees } = dataSet
@@ -208,7 +237,7 @@ export class DataSetQuery {
     return assigneeItemList
   }
 
-  @FieldResolver(type => [ApprovalLineItem])
+  @FieldResolver(type => [ApprovalLineItem], { description: 'Retrieves the approval line items for the dataset' })
   async approvalLine(@Root() dataSet: DataSet, @Ctx() context: ResolverContext): Promise<ApprovalLineItem[]> {
     const { domain, user } = context.state
     const { reviewApprovalLine } = dataSet
@@ -250,21 +279,21 @@ export class DataSetQuery {
     return approvalLineItems
   }
 
-  @FieldResolver(type => Board, { nullable: true })
+  @FieldResolver(type => Board, { nullable: true, description: 'Retrieves the entry board for the dataset' })
   async entryBoard(@Root() dataSet: DataSet): Promise<Board> {
     if (dataSet.entryType == 'board' && dataSet.entryView) {
       return await getRepository(Board).findOneBy({ id: dataSet.entryView })
     }
   }
 
-  @FieldResolver(type => Board, { nullable: true })
+  @FieldResolver(type => Board, { nullable: true, description: 'Retrieves the monitor board for the dataset' })
   async monitorBoard(@Root() dataSet: DataSet): Promise<Board> {
     if (dataSet.monitorType == 'board' && dataSet.monitorView) {
       return await getRepository(Board).findOneBy({ id: dataSet.monitorView })
     }
   }
 
-  @FieldResolver(type => DataKeySet, { nullable: true })
+  @FieldResolver(type => DataKeySet, { nullable: true, description: 'Retrieves the data key set for the dataset' })
   async dataKeySet(@Root() dataSet: DataSet): Promise<DataKeySet> {
     return (
       dataSet.dataKeySet ||
@@ -275,7 +304,7 @@ export class DataSetQuery {
     )
   }
 
-  @FieldResolver(type => Scenario)
+  @FieldResolver(type => Scenario, { description: 'Retrieves the normal scenario for the dataset.' })
   async normalScenario(@Root() dataSet: DataSet): Promise<Scenario> {
     return (
       dataSet.normalScenario ||
@@ -286,7 +315,7 @@ export class DataSetQuery {
     )
   }
 
-  @FieldResolver(type => Scenario)
+  @FieldResolver(type => Scenario, { description: 'Retrieves the outlier scenario for the dataset.' })
   async outlierScenario(@Root() dataSet: DataSet): Promise<Scenario> {
     return (
       dataSet.outlierScenario ||
@@ -297,22 +326,25 @@ export class DataSetQuery {
     )
   }
 
+  // 데이터셋의 도메인을 조회
   @FieldResolver(type => Domain)
   async domain(@Root() dataSet: DataSet): Promise<Domain> {
     return dataSet.domainId && (await getRepository(Domain).findOneBy({ id: dataSet.domainId }))
   }
 
+  // 데이터셋의 업데이트한 사용자를 조회
   @FieldResolver(type => User)
   async updater(@Root() dataSet: DataSet): Promise<User> {
     return dataSet.updaterId && (await getRepository(User).findOneBy({ id: dataSet.updaterId }))
   }
 
+  // 데이터셋의 생성자를 조회
   @FieldResolver(type => User)
   async creator(@Root() dataSet: DataSet): Promise<User> {
     return dataSet.creatorId && (await getRepository(User).findOneBy({ id: dataSet.creatorId }))
   }
 
-  @FieldResolver(type => Date, { nullable: true })
+  @FieldResolver(type => Date, { nullable: true, description: 'Retrieves the latest collection time for the dataset.' })
   async latestCollectedAt(@Root() dataSet: DataSet): Promise<Date> {
     const sample = await getRepository(DataSample).findOne({
       select: ['id', 'collectedAt'],
@@ -323,7 +355,7 @@ export class DataSetQuery {
     return sample?.collectedAt
   }
 
-  @FieldResolver(type => Date, { nullable: true })
+  @FieldResolver(type => Date, { nullable: true, description: 'Retrieves the next schedule time for the dataset.' })
   async nextSchedule(@Root() dataSet: DataSet): Promise<Date> {
     const { domainId, schedule, timezone } = dataSet
 
@@ -338,7 +370,7 @@ export class DataSetQuery {
     return interval.next().toDate()
   }
 
-  @FieldResolver(type => Date, { nullable: true })
+  @FieldResolver(type => Date, { nullable: true, description: 'Retrieves the previous schedule time for the dataset.' })
   async prevSchedule(@Root() dataSet: DataSet): Promise<Date> {
     const { domainId, schedule, timezone } = dataSet
 
@@ -353,7 +385,10 @@ export class DataSetQuery {
     return interval.prev().toDate()
   }
 
-  @FieldResolver(type => Date, { nullable: true })
+  @FieldResolver(type => Date, {
+    nullable: true,
+    description: 'Retrieves the next summary schedule time for the dataset.'
+  })
   async nextSummarySchedule(@Root() dataSet: DataSet): Promise<Date> {
     const { domainId, summarySchedule, timezone } = dataSet
 
@@ -367,20 +402,19 @@ export class DataSetQuery {
 
     return interval.next().toDate()
 
-    // /* FIXME: getSchedules 의 파라미터를 수정해야한다. scheduler 가 없거나 커넥션이 끊겨있어서 오래걸리는 문제는 어떻게 ?? 비동기로 처리한다. 어떻게???
-    //   client: {
-    //     application: Application,
-    //     group: `${domain.id}`,
-    //     type: 'data-set',
-    //     key: dataSet.id,
-    //     operation: 'summary'
-    //   },
-    // */
+    // FIXME: getSchedules 의 파라미터를 수정해야한다. scheduler 가 없거나 커넥션이 끊겨있어서 오래걸리는 문제는 어떻게 ?? 비동기로 처리한다. 어떻게???
+    // client: {
+    //   application: Application,
+    //   group: `${domain.id}`,
+    //   type: 'data-set',
+    //   key: dataSet.id,
+    //   operation: 'summary'
+    // }
     // const schedule = getSchedules('name', 'group', false)
     // return schedule.nextSchedule
   }
 
-  @FieldResolver(type => String)
+  @FieldResolver(type => String, { description: 'Retrieves the report template for the dataset.' })
   async reportTemplate(@Root() dataset: DataSet): Promise<string | undefined> {
     const attachment: Attachment = await getRepository(Attachment).findOne({
       where: {
@@ -392,4 +426,36 @@ export class DataSetQuery {
 
     return attachment?.path
   }
+
+  @FieldResolver(returns => Boolean, { description: 'Whether the user is a supervisor for this dataset' })
+  async isSupervisor(@Root() dataset: DataSet, @Ctx() context: ResolverContext): Promise<boolean> {
+    const { user, domain } = context.state
+
+    const foundUser = await getRepository(User).findOne({
+      where: { id: user.id },
+      relations: ['roles']
+    })
+
+    const roles = foundUser.roles
+      .filter(role => role.domainId === domain.id || (domain.parentId && role.domainId === domain.parentId))
+      .map(role => role.id)
+
+    return roles.includes(dataset.supervisoryRoleId)
+  }
+
+  @FieldResolver(returns => Boolean, { description: 'Whether the user is allowed to enter data for this dataset' })
+  async isEntryAllowed(@Root() dataset: DataSet, @Ctx() context: ResolverContext): Promise<boolean> {
+    const { user, domain } = context.state
+
+    const foundUser = await getRepository(User).findOne({
+      where: { id: user.id },
+      relations: ['roles']
+    })
+
+    const roles = foundUser.roles
+      .filter(role => role.domainId === domain.id || (domain.parentId && role.domainId === domain.parentId))
+      .map(role => role.id)
+
+    return roles.includes(dataset.entryRoleId)
+  }
 }

package/server/service/data-set/data-set-type.ts

@@ -4,7 +4,6 @@ import { Field, ID, InputType, Int, ObjectType } from 'type-graphql'
 
 import { ApprovalLineItem } from '@things-factory/organization'
 import { ObjectRef, ScalarObject } from '@things-factory/shell'
-import { AssigneeItem } from '@things-factory/worklist'
 
 import { DataItemPatch } from './data-item-type'
 import { DataSet, DataSetEntryType, DataSetMonitorType, DataSetReportType, DataSetSummaryPeriodType } from './data-set'
@@ -29,8 +28,8 @@ export class NewDataSet {
   @Field(type => ObjectRef, { nullable: true })
   supervisoryRole?: ObjectRef
 
-  @Field(type => ScalarObject, { nullable: true })
-  assignees?: AssigneeItem[]
+  @Field(type => ObjectRef, { nullable: true })
+  resolverRole?: ObjectRef
 
   @Field(type => ScalarObject, { nullable: true })
   reviewApprovalLine?: ApprovalLineItem[]
@@ -91,6 +90,12 @@ export class NewDataSet {
 
   @Field({ nullable: true })
   summaryPeriod?: DataSetSummaryPeriodType
+
+  @Field({
+    nullable: true,
+    description: 'The maximum allowed time limit (in seconds) for completing the data entry operation'
+  })
+  timeLimit?: number
 }
 
 @InputType()
@@ -116,8 +121,8 @@ export class DataSetPatch {
   @Field(type => ObjectRef, { nullable: true })
   entryRole?: ObjectRef
 
-  @Field(type => ScalarObject, { nullable: true })
-  assignees?: AssigneeItem[]
+  @Field(type => ObjectRef, { nullable: true })
+  resolverRole?: ObjectRef
 
   @Field(type => ScalarObject, { nullable: true })
   reviewApprovalLine?: ApprovalLineItem[]
@@ -179,6 +184,12 @@ export class DataSetPatch {
   @Field({ nullable: true })
   summaryPeriod?: DataSetSummaryPeriodType
 
+  @Field({
+    nullable: true,
+    description: 'The maximum allowed time limit (in seconds) for completing the data entry operation'
+  })
+  timeLimit?: number
+
   @Field()
   cuFlag: string
 }

package/server/service/data-set/data-set.ts

@@ -150,6 +150,16 @@ export class DataSet {
   @RelationId((dataSet: DataSet) => dataSet.supervisoryRole)
   supervisoryRoleId?: string
 
+  @ManyToOne(type => Role, { nullable: true })
+  @Field(type => Role, {
+    nullable: true,
+    description: 'The final authority on resolving outlier related to that dataset.'
+  })
+  resolverRole?: Role
+
+  @RelationId((dataSet: DataSet) => dataSet.resolverRole)
+  resolverRoleId?: string
+
   @Column('simple-json', { nullable: true })
   @Field(type => [AssigneeItem], { nullable: true, description: 'Who to contact for OOC issues' })
   assignees?: AssigneeItem[]
@@ -285,6 +295,13 @@ export class DataSet {
   @Field({ nullable: true, description: 'The summary schedule ID of the dataset' })
   summaryScheduleId?: string
 
+  @Column({ nullable: true })
+  @Field({
+    nullable: true,
+    description: 'The maximum allowed time limit (in seconds) for completing the data entry operation'
+  })
+  timeLimit?: number
+
   @CreateDateColumn()
   @Field({ nullable: true, description: 'The date and time the dataset was created' })
   createdAt?: Date

package/server/service/data-set-history/data-set-history.ts

@@ -204,8 +204,14 @@ export class DataSetHistory implements HistoryEntityInterface<DataSet> {
         ? 'enum'
         : DATABASE_TYPE == 'oracle'
           ? 'varchar2'
-          : 'smallint',
-    enum: HistoryActionType
+          : 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 : 10
   })
   public action!: HistoryActionType
 }

package/server/service/data-summary/data-summary-query.ts

@@ -154,7 +154,7 @@ export class DataSummaryQuery {
   async dataItems(@Root() dataSummary: DataSummary): Promise<DataItem[]> {
     const dataSet = dataSummary.dataSetId && (await getRepository(DataSet).findOneBy({ id: dataSummary.dataSetId }))
 
-    return dataSet?.dataItems || []
+    return dataSet?.dataItems.filter(item => item.active) || []
   }
 
   @FieldResolver(type => DataSet)

package/translations/en.json

@@ -70,6 +70,7 @@
   "field.report-view": "report view",
   "field.request-params": "request parameters",
   "field.requires-review": "requires review",
+  "field.resolver-role": "resolver role",
   "field.review-approval-line": "review approval line",
   "field.role": "role",
   "field.serial-no": "serial #",
@@ -82,6 +83,7 @@
   "field.supervisory-role": "supervisory role",
   "field.t-key": "translation key",
   "field.tag": "tag name",
+  "field.time-limit": "time limit",
   "field.time-period": "time period",
   "field.unit": "unit",
   "field.use-case": "use case",

package/translations/ja.json

@@ -41,6 +41,7 @@
   "field.entry-view": "入力用画面",
   "field.finalizing-function": "最終処理関数",
   "field.hidden": "隠し",
+  "field.hours-limit": "制限時間",
   "field.item": "項目",
   "field.key": "キ",
   "field.key-01": "キー1",
@@ -71,6 +72,7 @@
   "field.report-view": "レポート用画面",
   "field.request-params": "リクエスト パラメータ",
   "field.requires-review": "見直しが必要",
+  "field.resolver-role": "解決者役割",
   "field.review-approval-line": "決済ライン",
   "field.role": "ロール",
   "field.serial-no": "シリアル番号",

package/translations/ko.json

@@ -71,6 +71,7 @@
   "field.report-view": "리포트용 화면",
   "field.request-params": "요청 매개변수",
   "field.requires-review": "검토 요청",
+  "field.resolver-role": "해결자 역할",
   "field.review-approval-line": "결재라인",
   "field.role": "역할",
   "field.serial-no": "시리얼번호",
@@ -82,6 +83,7 @@
   "field.supervisory-role": "관리자 역할",
   "field.t-key": "번역 키",
   "field.tag": "태그이름",
+  "field.time-limit": "제한시간",
   "field.time-period": "시간단위",
   "field.unit": "단위",
   "field.use-case": "사용 사례",

package/translations/ms.json

@@ -71,6 +71,7 @@
   "field.report-view": "paparan laporan",
   "field.request-params": "parameter permintaan",
   "field.requires-review": "memerlukan semakan",
+  "field.resolver-role": "peranan penyelesai",
   "field.review-approval-line": "baris kelulusan",
   "field.role": "peranan",
   "field.serial-no": "no. siri",
@@ -82,6 +83,7 @@
   "field.supervisory-role": "peranan pengawasan",
   "field.t-key": "kunci terjemahan",
   "field.tag": "nama tag",
+  "field.time-limit": "had masa",
   "field.time-period": "tempoh masa",
   "field.unit": "unit",
   "field.use-case": "kes penggunaan",

package/translations/zh.json

@@ -71,6 +71,7 @@
   "field.report-view": "报告界面",
   "field.request-params": "请求参数",
   "field.requires-review": "需要审查",
+  "field.resolver-role": "解决者角色",
   "field.review-approval-line": "审批线",
   "field.role": "角色",
   "field.serial-no": "序列号",
@@ -82,6 +83,7 @@
   "field.supervisory-role": "监管角色",
   "field.t-key": "翻译键",
   "field.tag": "标签名",
+  "field.time-limit": "限制时间",
   "field.time-period": "时间单位",
   "field.unit": "单位",
   "field.use-case": "使用案例",