@things-factory/integration-base 6.2.86 → 6.2.88

package/server/engine/task/http-get.ts

@@ -5,8 +5,10 @@ import https from 'https'
 import { TaskRegistry } from '../task-registry'
 import { ConnectionManager } from '../connection-manager'
 import { substitute } from './utils/substitute'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
-async function HttpGet(step, { logger, data, domain, user, variables, lng }) {
+async function HttpGet(step: InputStep, { logger, data, domain, user, variables, lng }: Context) {
   var { connection: connectionName, params: stepOptions } = step
   var { headers: requestHeaders, searchParams = {}, path } = stepOptions || {}
   var connection = ConnectionManager.getConnectionInstanceByName(domain, connectionName)

package/server/engine/task/http-post.ts

@@ -5,8 +5,10 @@ import { access } from '@things-factory/utils'
 import { TaskRegistry } from '../task-registry'
 import { ConnectionManager } from '../connection-manager'
 import https from 'https'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
-async function HttpPost(step, { logger, data, domain, user, variables, lng }) {
+async function HttpPost(step: InputStep, { logger, data, domain, user, variables, lng }: Context) {
   var { connection: connectionName, params: stepOptions } = step
   var { headers: requestHeaders, contentType, path, accessor } = stepOptions || {}
 

package/server/engine/task/jsonata.ts

@@ -1,7 +1,10 @@
-import { TaskRegistry } from '../task-registry'
 import jsonata from 'jsonata'
 
-async function JSonata(step, context) {
+import { TaskRegistry } from '../task-registry'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
+
+async function JSonata(step: InputStep, context: Context) {
   var {
     params: { expression }
   } = step

package/server/engine/task/local-graphql-mutate.ts

@@ -6,8 +6,12 @@ import { getRepository } from '@things-factory/shell'
 import { access } from '@things-factory/utils'
 
 import { TaskRegistry } from '../task-registry'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
-async function LocalGraphqlMutate(step, context) {
+
+
+async function LocalGraphqlMutate(step: InputStep, context: Context) {
   var { params, updaterId } = step
   var { mutation, variables: variablesAccessorMap, headers } = params || {}
   var { logger, client, domain, user, data, variables, lng } = context

package/server/engine/task/local-graphql-query.ts

@@ -6,8 +6,10 @@ import { getRepository } from '@things-factory/shell'
 import { access } from '@things-factory/utils'
 
 import { TaskRegistry } from '../task-registry'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
-async function LocalGraphqlQuery(step, context) {
+async function LocalGraphqlQuery(step: InputStep, context: Context) {
   var { params, updaterId } = step
   var { query, variables: variablesAccessorMap, headers } = params || {}
   var { logger, client, domain, user, data, variables, lng } = context

package/server/engine/task/log.ts

@@ -1,8 +1,10 @@
 import { access, hasTemplateExpression } from '@things-factory/utils'
 import { VM } from 'vm2'
 import { TaskRegistry } from '../task-registry'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
-async function Log(step, { logger, data, variables, domain, user, lng }) {
+async function Log(step: InputStep, { logger, data, variables, domain, user, lng }: Context) {
   var {
     params: { message, accessor, level = 'info' }
   } = step

package/server/engine/task/mqtt-publish.ts

@@ -1,8 +1,10 @@
 import { access } from '@things-factory/utils'
 import { TaskRegistry } from '../task-registry'
 import { ConnectionManager } from '../connection-manager'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
-async function MqttPublish(step, { logger, data, domain }) {
+async function MqttPublish(step: InputStep, { logger, data, domain }: Context) {
   var {
     connection: connectionName,
     params: { topic, accessor }

package/server/engine/task/mqtt-subscribe.ts

@@ -3,6 +3,8 @@ import mqtt from 'async-mqtt'
 import { TaskRegistry } from '../task-registry'
 import { ConnectionManager } from '../connection-manager'
 import { sleep } from '@things-factory/utils'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
 function convertDataFormat(data, format) {
   if (format == 'json') {
@@ -12,7 +14,7 @@ function convertDataFormat(data, format) {
   }
 }
 
-async function MqttSubscribe(step, context) {
+async function MqttSubscribe(step: InputStep, context: Context) {
   const {
     connection: connectionName,
     params: { topic, dataFormat },

package/server/engine/task/oracle-procedure.ts

@@ -3,6 +3,8 @@ import { logger } from '@things-factory/env'
 import { access } from '@things-factory/utils'
 import { ConnectionManager } from '../connection-manager'
 import { TaskRegistry } from '../task-registry'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
 try {
   var oracledb = require('oracledb')
@@ -41,7 +43,7 @@ const DIR = {
   Out: oracledb?.BIND_OUT
 }
 
-async function OracleProcedure(step, context) {
+async function OracleProcedure(step: InputStep, context: Context) {
   var { domain, user, data, variables, lng } = context
   var { connection: connectionName, params } = step
 

package/server/engine/task/pick-pending-scenario.ts

@@ -4,10 +4,12 @@ import { sleep } from '@things-factory/utils'
 import { Scenario } from '../../service/scenario/scenario'
 import { ScenarioEngine } from '../scenario-engine'
 import { TaskRegistry } from '../task-registry'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
 const debug = require('debug')('things-factory:integration-base:pick-pending-scenario')
 
-async function PickPendingScenario(step, context) {
+async function PickPendingScenario(step: InputStep, context: Context) {
   var { logger, load, domain } = context
   var { params } = step
   var { tag = '', waitFor = -1 } = params || {}

package/server/engine/task/publish.ts

@@ -1,7 +1,9 @@
 import { access } from '@things-factory/utils'
 import { TaskRegistry } from '../task-registry'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
-async function Publish(step, { logger, publish, data }) {
+async function Publish(step: InputStep, { logger, publish, data }: Context) {
   var {
     params: { tag, accessor }
   } = step

package/server/engine/task/random.ts

@@ -1,6 +1,9 @@
 import { TaskRegistry } from '../task-registry'
 import Chance from 'chance'
 
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
+
 const formats = [
   'bool,character,floating,integer,letter,natural,string',
   'paragraph,sentence,syllable,word',
@@ -15,7 +18,7 @@ const formats = [
   .join(',')
   .split(',')
 
-async function Random(step, { logger, publish, data }) {
+async function Random(step: InputStep, { logger, publish, data }: Context) {
   var {
     params: { format = 'integer', count = 1 }
   } = step

package/server/engine/task/reset-pending-queue.ts

@@ -1,7 +1,9 @@
 import { TaskRegistry } from '../task-registry'
 import { ScenarioEngine } from '../scenario-engine'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
-async function ResetPendingScenario(step, { domain }) {
+async function ResetPendingScenario(step: InputStep, { domain }: Context) {
   const pendingQueue = ScenarioEngine.getPendingQueue(domain)
   pendingQueue.reset()
 

package/server/engine/task/script.ts

@@ -1,7 +1,10 @@
 import { TaskRegistry } from '../task-registry'
 import { NodeVM } from 'vm2'
 
-async function Script(step, context) {
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
+
+async function Script(step: InputStep, context: Context) {
   var {
     params: { script }
   } = step

package/server/engine/task/set-domain.ts

@@ -1,7 +1,10 @@
 import { TaskRegistry } from '../task-registry'
 import { Domain, getRepository } from '@things-factory/shell'
 
-async function SetDomain(step, context) {
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
+
+async function SetDomain(step: InputStep, context: Context) {
   var {
     params: { subdomain }
   } = step

package/server/engine/task/sleep.ts

@@ -1,7 +1,9 @@
 import { sleep } from '@things-factory/utils'
 import { TaskRegistry } from '../task-registry'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
-async function Sleep(step, { logger }) {
+async function Sleep(step: InputStep, { logger }: Context) {
   var {
     params: { duration }
   } = step

package/server/engine/task/socket-listener.ts

@@ -1,6 +1,8 @@
 import { sleep } from '@things-factory/utils'
 import { TaskRegistry } from '../task-registry'
 import { ConnectionManager } from '../connection-manager'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
 function convertDataFormat(data, format) {
   try {
@@ -16,7 +18,7 @@ function convertDataFormat(data, format) {
   return data
 }
 
-async function SocketListener(step, context) {
+async function SocketListener(step: InputStep, context: Context) {
   //get connection data
   const {
     connection: connectionName,

package/server/engine/task/state-read.ts

@@ -1,7 +1,9 @@
 import gql from 'graphql-tag'
 import { TaskRegistry } from '../task-registry'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
-async function StateRead(step, { logger, publish, data, domain, user, client }) {
+async function StateRead(step: InputStep, { logger, publish, data, domain, user, client }: Context) {
   var {
     params: { name }
   } = step

package/server/engine/task/state-write.ts

@@ -1,8 +1,10 @@
 import gql from 'graphql-tag'
 import { access } from '@things-factory/utils'
 import { TaskRegistry } from '../task-registry'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
-async function StateWrite(step, { logger, publish, data, domain, user, client }) {
+async function StateWrite(step: InputStep, { logger, publish, data, domain, user, client }: Context) {
   var {
     params: { name, accessor }
   } = step

package/server/engine/task/stop-scenario.ts

@@ -3,8 +3,10 @@ import { getRepository } from '@things-factory/shell'
 import { Scenario } from '../../service/scenario/scenario'
 import { ScenarioEngine } from '../../engine'
 import { TaskRegistry } from '../task-registry'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
-async function StopScenario(step, context) {
+async function StopScenario(step: InputStep, context: Context) {
   var { logger, domain } = context
   var {
     params: { scenario }

package/server/engine/task/sub-scenario.ts

@@ -3,8 +3,10 @@ import { access, deepClone } from '@things-factory/utils'
 
 import { Scenario } from '../../service/scenario/scenario'
 import { TaskRegistry } from '../task-registry'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
-async function SubScenario(step, context) {
+async function SubScenario(step: InputStep, context: Context) {
   var { logger, load, data } = context
   var {
     params: { scenario, variables }

package/server/engine/task/switch-goto.ts

@@ -2,7 +2,10 @@ import { access } from '@things-factory/utils'
 
 import { TaskRegistry } from '../task-registry'
 
-async function SwitchGoTo(step, { logger, data }) {
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
+
+async function SwitchGoTo(step: InputStep, { logger, data }: Context) {
   var {
     params: { accessor, cases }
   } = step

package/server/engine/task/switch-range-goto.ts

@@ -1,8 +1,10 @@
 import { access } from '@things-factory/utils'
 
 import { TaskRegistry } from '../task-registry'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
-async function SwitchRangeGoTo(step, { logger, data }) {
+async function SwitchRangeGoTo(step: InputStep, { logger, data }: Context) {
   var {
     params: { accessor, cases }
   } = step

package/server/engine/task/switch-range-scenario.ts

@@ -3,8 +3,10 @@ import { access, deepClone } from '@things-factory/utils'
 
 import { Scenario } from '../../service/scenario/scenario'
 import { TaskRegistry } from '../task-registry'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
-async function SwitchRangeScenario(step, context) {
+async function SwitchRangeScenario(step: InputStep, context: Context) {
   var { logger, data, load } = context
   var {
     params: { accessor, cases, variables }

package/server/engine/task/switch-range-set.ts

@@ -1,7 +1,9 @@
 import { access } from '@things-factory/utils'
 import { TaskRegistry } from '../task-registry'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
-async function SwitchRangeSet(step, { logger, data }) {
+async function SwitchRangeSet(step: InputStep, { logger, data }: Context) {
   var {
     params: { accessor, cases }
   } = step

package/server/engine/task/switch-scenario.ts

@@ -3,8 +3,10 @@ import { access, deepClone } from '@things-factory/utils'
 
 import { Scenario } from '../../service/scenario/scenario'
 import { TaskRegistry } from '../task-registry'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
-async function SwitchScenario(step, context) {
+async function SwitchScenario(step: InputStep, context: Context) {
   var { logger, data, load } = context
   var {
     params: { accessor, cases, variables }

package/server/engine/task/switch-set.ts

@@ -1,7 +1,9 @@
 import { access } from '@things-factory/utils'
 import { TaskRegistry } from '../task-registry'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
-async function SwitchSet(step, { logger, data }) {
+async function SwitchSet(step: InputStep, { logger, data }: Context) {
   var {
     params: { accessor, cases }
   } = step

package/server/engine/task/throw.ts

@@ -1,6 +1,8 @@
 import { TaskRegistry } from '../task-registry'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
-async function Throw(step, { logger }) {
+async function Throw(step: InputStep, { logger }: Context) {
   var {
     name,
     params: { message }

package/server/engine/task/variables.ts

@@ -1,6 +1,8 @@
 import { TaskRegistry } from '../task-registry'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
-async function Variables(step, { variables }) {
+async function Variables(step: InputStep, { variables }: Context) {
   return {
     data: variables instanceof Array ? [...variables] : typeof variables == 'object' ? { ...variables } : variables
   }

package/server/engine/types.ts

@@ -1,4 +1,6 @@
 import { Connection, PropertySpec, ScenarioInstanceStatus, Step } from '../service'
+import { Domain } from '@things-factory/shell'
+import { User } from '@things-factory/auth-base'
 
 export interface Connector {
   ready(connections: Connection[]): Promise<any>
@@ -11,23 +13,98 @@ export interface Connector {
 }
 
 export type Context = {
-  domain: Object
-  user: Object
+  /** 
+    * Represents the domain context.
+    */
+  domain: Domain
+
+  /** 
+    * User information.
+    */
+  user: User
+
+  /** 
+    * Language code, for example 'en', 'ko'.
+    */
   lng: string
+
+  /** 
+    * Flag to indicate if the IP is unsafe, can be undefined.
+    */
   unsafeIP: boolean | undefined
+
+  /** 
+    * List of prohibited privileges, can be undefined.
+    */
   prohibitedPrivileges: { category: string; privilege: string }[] | undefined
+
+  /** 
+    * Logger for logging purposes.
+    */
   logger: any
+
+  /** 
+    * Function to publish events or messages.
+    */
   publish: Function
+
+  /** 
+    * Function to load resources or data.
+    */
   load: Function
+
+  /** 
+    * Current status of the scenario instance.
+    */
   state: ScenarioInstanceStatus
-  data: Object
+
+  /** 
+    * General data storage object.
+    */
+  data: any
+
+  /** 
+    * Variables related to the context.
+    */
   variables: Object
-  client: Object /* graphql local client */
+
+  /** 
+    * Local GraphQL client object.
+    */
+  client: any /* graphql local client */
+
+  /** 
+    * Root object, can be used for various purposes.
+    */
   root: Object
+
+  /** 
+    * Array of function closures.
+    */
   closures: Function[]
+
+  /** 
+    * Function to check the state.
+    */
   checkState: Function
+
+  /**
+   * MQTT subscriber context object.
+   */
+  __mqtt_subscriber?: any
+
+  /**
+   * socket listener context object.
+   */
+  __socket_listener?: any
+
+  /**
+   * csv readline context object.
+   */
+  __csv_resources?: any
 }
 
+
 export type TaskHandler = (
   step: Step,
   context: Context

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

@@ -30,72 +30,126 @@ registerEnumType(ConnectionStatus, {
 @Index('ix_connection_0', (connection: Connection) => [connection.domain, connection.name], { unique: true })
 @ObjectType()
 export class Connection {
+  /** 
+   * Unique identifier for the connection, generated in UUID format.
+   */
   @PrimaryGeneratedColumn('uuid')
   @Field(type => ID)
   readonly id: string
 
+  /** 
+   * Many-to-One relationship with the Domain entity.
+   */
   @ManyToOne(type => Domain)
   @Field({ nullable: true })
   domain: Domain
 
+  /** 
+   * Stores the ID of the associated Domain.
+   */
   @RelationId((connection: Connection) => connection.domain)
   domainId: string
 
+  /** 
+   * The name of the connection.
+   */
   @Column()
   @Field()
   name: string
 
+  /** 
+   * Optional description for the connection.
+   */
   @Column({
     nullable: true
   })
   @Field({ nullable: true })
   description: string
 
+  /** 
+   * The type of the connection.
+   */
   @Column()
   @Field({ nullable: true })
   type: string
 
+  /** 
+   * The endpoint for the connection.
+   */
   @Column()
   @Field({ nullable: true })
   endpoint: string
 
+  /** 
+   * Indicates the active status of the connection.
+   */
   @Column({
     nullable: true
   })
   @Field({ nullable: true })
   active: boolean
 
+  /** 
+   * The status of the connection, using the ConnectionStatus type.
+   */
   @Field({ nullable: true })
   state: ConnectionStatus
 
+  /** 
+   * Additional parameters for the connection, stored as a JSON string.
+   */
   @Column({
     nullable: true
   })
   @Field({ nullable: true })
   params: string
 
+  /** 
+   * The date and time when the connection was created.
+   */
   @CreateDateColumn()
   @Field({ nullable: true })
   createdAt: Date
 
+  /** 
+   * The date and time when the connection was last updated.
+   */
   @UpdateDateColumn()
   @Field({ nullable: true })
   updatedAt: Date
 
+  /** 
+   * Many-to-One relationship with the User entity who created the connection. Optional field.
+   */
   @ManyToOne(type => User, { nullable: true })
   @Field({ nullable: true })
   creator: User
 
+  /** 
+   * Stores the ID of the User who created the connection.
+   */
   @RelationId((connection: Connection) => connection.creator)
   creatorId: string
 
+   /** 
+   * Many-to-One relationship with the User entity who last updated the connection.
+   * Optional field.
+   */
   @ManyToOne(type => User, { nullable: true })
   @Field({ nullable: true })
   updater: User
 
+  /**
+   * Stores the ID of the User who last updated the connection.
+   * 
+   */
   @RelationId((connection: Connection) => connection.updater)
   updaterId: string
 
+  /**
+   * Asynchronous method to establish the connection.
+   * 
+   */
   async connect() {
     var connector = ConnectionManager.getConnector(this.type)
     var params = {}
@@ -112,6 +166,10 @@ export class Connection {
     })
   }
 
+  /**
+   * @brief Asynchronous method to disconnect the connection.
+   * 
+   */
   async disconnect() {
     try {
       var connector = ConnectionManager.getConnector(this.type)
@@ -121,6 +179,15 @@ export class Connection {
   }
 }
 
+/**
+ * Connection의 params의 원 타입과 사용 시에 타입 불일치로 인해 임시적으로 생성한 타입으로
+ * 추후, 타입 일치를 통해서 제거할 예정임.
+ * 
+ */
+export interface InputConnection extends Connection {
+  params: any;
+}
+
 @ObjectType()
 export class ConnectionState {
   @Field({ nullable: true })