@things-factory/integration-base 7.0.0-alpha.0 → 7.0.0-alpha.18

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

@@ -15,98 +15,145 @@ import { Domain } from '@things-factory/shell'
 
 import { Scenario } from '../scenario/scenario'
 
+
 @Entity()
 @Index('ix_step_0', (step: Step) => [step.scenario, step.sequence], { unique: true })
 @ObjectType()
 export class Step {
+  /** 
+    * The unique identifier for each step.
+    */
   @PrimaryGeneratedColumn('uuid')
   @Field(type => ID)
   readonly id: string
 
+  /** 
+    * The domain to which this step belongs.
+    */
   @ManyToOne(type => Domain)
   @Field({ nullable: true })
   domain: Domain
 
+  /** 
+    * The ID of the domain associated with this step.
+    */
   @RelationId((step: Step) => step.domain)
   domainId: string
 
-  @Column({
-    nullable: true
-  })
+  /** 
+    * The name of the step.
+    */
+  @Column({ nullable: true })
   @Field()
   name: string
 
-  @Column({
-    nullable: true
-  })
+  /** 
+    * A description of what the step involves.
+    */
+  @Column({ nullable: true })
   @Field({ nullable: true })
   description: string
 
+  /** 
+    * The scenario that includes this step.
+    */
   @ManyToOne(type => Scenario, scenario => scenario.steps, { onDelete: 'CASCADE' })
   @Field(type => Scenario, { nullable: true })
   scenario: Scenario
 
+  /** 
+    * The ID of the scenario associated with this step.
+    */
   @RelationId((step: Step) => step.scenario)
   scenarioId: string
 
+  /** 
+    * The sequence number of the step within its scenario.
+    */
   @Column()
   @Field({ nullable: true })
   sequence: number
 
+  /** 
+    * The specific task associated with this step.
+    */
   @Column()
   @Field({ nullable: true })
   task: string
 
-  @Column({
-    nullable: true
-  })
+  /** 
+    * Boolean value to indicate if the step should be skipped.
+    */
+  @Column({ nullable: true })
   @Field({ nullable: true })
   skip: boolean
 
-  @Column({
-    nullable: true
-  })
+  /** 
+    * Boolean value to indicate if the step should be logged.
+    */
+  @Column({ nullable: true })
   @Field({ nullable: true })
   log: boolean
 
-  @Column({
-    nullable: true
-  })
+  /** 
+    * The connection details associated with this step.
+    */
+  @Column({ nullable: true })
   @Field({ nullable: true })
   connection: string
 
-  @Column({
-    nullable: true
-  })
+  /** 
+    * The parameters for the step.
+    */
+  @Column({ nullable: true })
   @Field({ nullable: true })
   params: string
 
+  /** 
+    * A boolean attribute indicating the inclusion status of an element in the result.
+    */
   @Column({ nullable: true, default: true })
-  @Field({
-    nullable: true,
-    description: 'a boolean attribute indicating the inclusion status of an element in the result'
-  })
+  @Field({ nullable: true, description: 'A boolean attribute indicating the inclusion status of an element in the result' })
   result: boolean = true
 
+  /** 
+    * The timestamp when the step was created.
+    */
   @CreateDateColumn()
   @Field({ nullable: true })
   createdAt: Date
 
+  /** 
+    * The timestamp when
+  the step was last updated.
+  */
   @UpdateDateColumn()
   @Field({ nullable: true })
   updatedAt: Date
 
+  /**
+  * The user who created this step.
+  */
   @ManyToOne(type => User, { nullable: true })
   @Field({ nullable: true })
   creator: User
 
+  /**
+  * The ID of the user who created this step.
+  */
   @RelationId((step: Step) => step.creator)
   creatorId: string
 
+  /**
+  * The user who last updated this step.
+  */
   @ManyToOne(type => User, { nullable: true })
   @Field({ nullable: true })
   updater: User
 
+  /**
+  * The ID of the user who last updated this step.
+  */
   @RelationId((step: Step) => step.updater)
   updaterId: string
 }
@@ -147,6 +194,15 @@ export class StepPatch {
   cuFlag?: string
 }
 
+/**
+ * Step의 params의 원 타입과 사용 시에 타입 불일치로 인해 임시적으로 생성한 타입으로
+ * 추후, 타입 일치를 통해서 제거할 예정임.
+ * 
+ */
+export interface InputStep extends Step {
+  params: any
+}
+
 @ObjectType()
 export class StepList {
   @Field(type => [Step])