@things-factory/integration-base 6.2.34 → 6.2.35

package/helps/integration/concept/scenario.ja.md

@@ -0,0 +1,4 @@
+# シナリオ（Scenario）
+
+- シナリオは、順番に実行される[タスク](./task.md)のシリーズです。
+- シナリオを構成する各段階のタスクをステップと呼びます。

package/helps/integration/concept/scenario.ko.md

@@ -0,0 +1,4 @@
+# scenario
+
+- 시나리오는 순차적으로 실행되는 [태스크](./task.md)의 시리즈이다.
+- 시나리오를 구성하는 각 단계의 태스크를 스텝이라고 한다.

package/helps/integration/concept/scenario.md

@@ -1,4 +1,4 @@
-# scenario
+# Scenario
 
-- 시나리오는 순차적으로 실행되는 [태스크](./task.md)의 시리즈이다.
-- 시나리오를 구성하는 각 단계의 태스크를 스텝이라고 한다.
+- A scenario is a series of [tasks](./task.md) that are executed sequentially.
+- The tasks constituting each step of the scenario are referred to as steps.

package/helps/integration/concept/scenario.ms.md

@@ -0,0 +1,4 @@
+# Senario (Scenario)
+
+- Senario adalah siri [tugas](./task.md) yang dilaksanakan secara berurutan.
+- Tugas yang membentuk setiap langkah senario disebut sebagai langkah.

package/helps/integration/concept/scenario.zh.md

@@ -0,0 +1,4 @@
+# 场景（Scenario）
+
+- 场景是按顺序执行的[任务](./task.md)系列。
+- 构成场景的每个阶段的任务称为步骤。

package/helps/integration/concept/state-register.ja.md

@@ -0,0 +1,8 @@
+# 状態登録簿（State-Register）
+
+- 状態登録簿は、ある状態を長期間維持するために定義する機能を意味します。
+- 各状態は独自の名前で識別できます。
+- 各状態は文字列、数字、またはオブジェクトなど、任意の形式の値を保持できます。
+- 各状態は TTL（Time To Live）によって、最後に設定された値の有効性を指定できます。（TTL が 0 より大きければ設定されたと判断します）
+  - もし、状態値が最後に設定された時刻が現在時刻に比べて TTL（秒）よりも前であれば、その値は無効になります。
+  - TTL が過ぎた状態値は null として表示されます。

package/helps/integration/concept/state-register.ko.md

@@ -0,0 +1,8 @@
+# 상태등록부 (state-register)
+
+- 상태등록부는 값을 일정기간 유지하고자하는 상태들을 정의하는 기능을 의미한다.
+- 각 상태는 고유한 이름으로 식별할 수 있다.
+- 각 상태는 문자열, 숫자 또는 오브젝트 등 어떤 형태의 값도 유지할 수 있다.
+- 각 상태는 TTL(Time To Live)에 의해서 마지막 설정된 값의 유효성을 지정할 수도 있다.(TTL이 0보다 크면 설정된 것으로 판단한다)
+  - 만약, 상태값이 마지막으로 설정된 시간이 현재 시간대비 TTL(초)보다 더 이전이라면 그 값은 유효하지 않게된다.
+  - TTL이 지난 상태값은 null로 조회된다

package/helps/integration/concept/state-register.md

@@ -0,0 +1,8 @@
+# State-Register
+
+- The state-register refers to a function that defines states that are intended to be maintained over a certain period.
+- Each state can be identified by a unique name.
+- Each state can maintain values in any form, such as strings, numbers, or objects.
+- Each state's validity of the last set value can be determined by TTL (Time To Live). (It is considered set if TTL is greater than 0)
+  - If the state value was set at a time earlier than the current time compared to TTL (seconds), then that value becomes invalid.
+  - State values past their TTL are queried as null.

package/helps/integration/concept/state-register.ms.md

@@ -0,0 +1,8 @@
+# Daftar Status (State-Register)
+
+- Daftar Status adalah fungsi yang bermaksud untuk menentukan status yang ingin dikekalkan dalam tempoh tertentu.
+- Setiap status boleh dikenalpasti melalui nama uniknya.
+- Setiap status boleh mengekalkan nilai dalam bentuk apa pun, seperti string, nombor, atau objek.
+- Setiap status boleh menetapkan keabsahan nilai terakhir yang ditetapkan melalui TTL (Time To Live). (Jika TTL lebih besar daripada 0, maka dianggap telah ditetapkan)
+  - Jika nilai status yang ditetapkan terakhir kali lebih awal daripada masa sekarang berbanding dengan TTL (saat), maka nilai tersebut menjadi tidak sah.
+  - Nilai status yang telah melebihi TTL akan ditunjukkan sebagai null.

package/helps/integration/concept/state-register.zh.md

@@ -0,0 +1,8 @@
+# 状态注册簿（State-Register）
+
+- 状态注册簿是指定义要长期保持某些状态的功能。
+- 每个状态都可以通过唯一的名称来识别。
+- 每个状态可以保持任何形式的值，如字符串、数字或对象等。
+- 每个状态可以通过 TTL（Time To Live）来指定最后设置值的有效性。（如果 TTL 大于 0，则认为已设置）
+  - 如果状态值最后设置的时间比当前时间早于 TTL（秒），那么该值将变得无效。
+  - 过期的状态值将被视为 null。

package/helps/integration/concept/task.ja.md

@@ -0,0 +1,25 @@
+# タスク（Task）
+
+- タスクは、[シナリオエンジン](./scenario-engine.md)によって実行される最小単位の作業です。
+- タスクは、[シナリオ](./scenario.md)の各ステップを定義するために実装されたプログラムです。
+- タスクは、複雑な機能の組み合わせを避け、単純で明確な機能で実装することが望ましいです。
+- タスク実装に必要な様々な情報と機能をサポートするために、シナリオでは[シナリオコンテキスト](./scenario-context.md)を提供しています。
+- タスクの種類は以下のように区分されます。
+
+## 分類
+
+- 独立タスク
+  - Sleep, Log,
+  - publish - タグ付きデータを購読者に通知
+- フロー制御タスク
+  - Goto Step：Map, Range, ..
+  - サブシナリオ：Map, Range, ..
+  - Throw
+  - End
+- [コネクション](./connection.md) ベースのタスク
+  - database-query
+  - graphql-query, mutator
+  - mqtt：subscribe/publish
+  - indydcp：Indy7 ロボット制御
+  - modbus：読み書き..
+  - ロボティクス関連：カメラ、マーカー等

package/helps/integration/concept/task.ko.md

@@ -0,0 +1,25 @@
+# task
+
+- 태스크는 [시나리오 엔진](./scenario-engine.md)에 의해서 실행되는 최소 단위의 작업이다.
+- 태스크는 [시나리오](./scenario.md)의 각 스텝을 정의하기 위해 구현된 프로그램이다.
+- 태스크는 여러가지 기능을 복합적으로 가지지 않도록 단순하고 명료한 기능으로 구현하는 것이 좋다.
+- 태스크 구현에 필요한 여러가지 정보와 기능을 지원하기 위해서 시나리오에서는 [Scenario Context](./scenario-context.md)를 제공한다.
+- 태스크 종류는 다음과 같이 구분될 수 있다.
+
+## 구분
+
+- 독립 태스크
+  - Sleep, Log,
+  - publish - notify data with tag to subscribers
+- 플로우 컨트롤 태스크
+  - Goto Step : Map, Range, ..
+  - Sub Scenario : Map, Range, ..
+  - Throw
+  - End
+- [커넥션](./connection.md) 기반 태스크
+  - database-query
+  - graphql-query, mutator
+  - mqtt : subscribe/publish
+  - indydcp : Indy7 robot control
+  - modbus : read/writes..
+  - robotics related : camera, markers, ..

package/helps/integration/concept/task.md

@@ -1,25 +1,25 @@
-# task
+# Task
 
-- 태스크는 [시나리오 엔진](./scenario-engine.md)에 의해서 실행되는 최소 단위의 작업이다.
-- 태스크는 [시나리오](./scenario.md)의 각 스텝을 정의하기 위해 구현된 프로그램이다.
-- 태스크는 여러가지 기능을 복합적으로 가지지 않도록 단순하고 명료한 기능으로 구현하는 것이 좋다.
-- 태스크 구현에 필요한 여러가지 정보와 기능을 지원하기 위해서 시나리오에서는 [Scenario Context](./scenario-context.md)를 제공한다.
-- 태스크 종류는 다음과 같이 구분될 수 있다.
+- A task is the smallest unit of work executed by the [Scenario Engine](./scenario-engine.md).
+- A task is a program implemented to define each step of a [Scenario](./scenario.md).
+- It is advisable to implement tasks with simple and clear functions, avoiding complex combinations of features.
+- To support various information and functionalities needed for task implementation, the scenario provides a [Scenario Context](./scenario-context.md).
+- Types of tasks can be distinguished as follows:
 
-## 구분
+## Categories
 
-- 독립 태스크
+- Independent Tasks
   - Sleep, Log,
-  - publish - notify data with tag to subscribers
-- 플로우 컨트롤 태스크
-  - Goto Step : Map, Range, ..
-  - Sub Scenario : Map, Range, ..
+  - Publish - notify data with tag to subscribers
+- Flow Control Tasks
+  - Goto Step: Map, Range, ..
+  - Sub Scenario: Map, Range, ..
   - Throw
   - End
-- [커넥션](./connection.md) 기반 태스크
+- [Connection](./connection.md) Based Tasks
   - database-query
   - graphql-query, mutator
-  - mqtt : subscribe/publish
-  - indydcp : Indy7 robot control
-  - modbus : read/writes..
-  - robotics related : camera, markers, ..
+  - mqtt: subscribe/publish
+  - indydcp: Indy7 robot control
+  - modbus: read/writes..
+  - robotics related: camera, markers, ..

package/helps/integration/concept/task.ms.md

@@ -0,0 +1,28 @@
+# Tugas (Task)
+
+- Tugas adalah unit kerja terkecil yang dilaksanakan oleh [Enjin Senario](./scenario-engine.md).
+- Tugas adalah program yang dilaksanakan untuk mendefinisikan
+
+setiap langkah dalam [Senario](./scenario.md).
+
+- Adalah disarankan untuk melaksanakan tugas dengan fungsi yang mudah dan jelas, mengelakkan gabungan ciri-ciri yang kompleks.
+- Untuk menyokong pelbagai maklumat dan fungsi yang diperlukan untuk pelaksanaan tugas, senario menyediakan [Konteks Senario](./scenario-context.md).
+- Jenis tugas boleh dibezakan seperti berikut:
+
+## Pengelasan
+
+- Tugas Bebas
+  - Sleep, Log,
+  - Terbitkan - maklumkan data dengan tag kepada pelanggan
+- Tugas Kawalan Aliran
+  - Pergi ke Langkah: Map, Range, ..
+  - Sub Senario: Map, Range, ..
+  - Lempar
+  - Akhir
+- Tugas Berasaskan [Sambungan](./connection.md)
+  - pertanyaan-pangkalan data
+  - pertanyaan-graphql, mutator
+  - mqtt: langgan/terbitkan
+  - indydcp: kawalan robot Indy7
+  - modbus: baca/tulis..
+  - berkaitan robotik: kamera, penanda, ..

package/helps/integration/concept/task.zh.md

@@ -0,0 +1,25 @@
+# 任务（Task）
+
+- 任务是由[场景引擎](./scenario-engine.md)执行的最小工作单位。
+- 任务是为了定义[场景](./scenario.md)的每个步骤而实现的程序。
+- 建议将任务实现为简单明了的功能，避免复杂的功能组合。
+- 为了支持任务实现所需的各种信息和功能，场景提供了[场景上下文](./scenario-context.md)。
+- 任务类型可以如下分类：
+
+## 分类
+
+- 独立任务
+  - Sleep, Log,
+  - Publish - 用标签通知数据给订阅者
+- 流程控制任务
+  - Goto Step：Map, Range, ..
+  - 子场景：Map, Range, ..
+  - Throw
+  - End
+- [连接](./connection.md) 基础任务
+  - database-query
+  - graphql-query, mutator
+  - mqtt：subscribe/publish
+  - indydcp：Indy7 机器人控制
+  - modbus：读/写..
+  - 与机器人相关：相机、标记点等

package/helps/integration/task/state-read.ja.md

@@ -0,0 +1,8 @@
+# 状態読み取り
+
+[状態登録簿(state-register)](../concept/state-register.md)で定義されている状態の値を読み取るタスクです。
+
+## パラメーター
+
+- 名前
+  - 取得する状態の「名前」を指定します

package/helps/integration/task/state-read.ko.md

@@ -0,0 +1,8 @@
+# state-read
+
+[상태등록부(state-register)](../concept/state-register.md)에 정의된 하나의 상태의 값을 읽어오는 태스크이다.
+
+## parameters
+
+- name
+  - 가져올 상태 "이름"을 지정한다

package/helps/integration/task/state-read.md

@@ -0,0 +1,8 @@
+# state-read
+
+[State Register](../concept/state-register.md) defines a task to read the value of a state.
+
+## parameters
+
+- name
+  - Specifies the "name" of the state to be retrieved

package/helps/integration/task/state-read.ms.md

@@ -0,0 +1,8 @@
+# bacaan keadaan
+
+[Daftar keadaan(state-register)](../concept/state-register.md) mendefinisikan tugas untuk membaca nilai suatu keadaan.
+
+## parameter
+
+- nama
+  - Menentukan "nama" keadaan yang hendak diambil

package/helps/integration/task/state-read.zh.md

@@ -0,0 +1,8 @@
+# 读取状态
+
+[状态登记册(state-register)](../concept/state-register.md)中定义了一个状态值的读取任务。
+
+## 参数
+
+- 名称
+  - 指定要获取的状态的“名称”

package/helps/integration/task/state-write.ja.md

@@ -0,0 +1,10 @@
+# 状態書き込み
+
+[状態登録簿(state-register)](../concept/state-register.md)に定義された一つの状態に値を書き込むタスクです。
+
+## パラメーター
+
+- 名前
+  - 書き込みたい対象状態の「名前」を指定します
+- [アクセサ](../concept/data-accessor.md)
+  - シナリオ内のステップ名で、書き込みたいデータを指定します。

package/helps/integration/task/state-write.ko.md

@@ -0,0 +1,10 @@
+# state-write
+
+[상태등록부(state-register)](../concept/state-register.md)에 정의된 하나의 상태에 값을 쓰는 태스크이다.
+
+## parameters
+
+- name
+  - 쓰고자 하는 대상 상태 "이름"을 지정한다
+- [accessor](../concept/data-accessor.md)
+  - 시나리오 내의 하나의 스텝이름으로, 쓰고자 하는 데이타를 지정한다.

package/helps/integration/task/state-write.md

@@ -0,0 +1,10 @@
+# state-write
+
+[State Register](../concept/state-register.md) defines a task for writing a value to a state.
+
+## parameters
+
+- name
+  - Specifies the "name" of the target state to be written
+- [accessor](../concept/data-accessor.md)
+  - A step name within the scenario, specifying the data to be written.

package/helps/integration/task/state-write.ms.md

@@ -0,0 +1,10 @@
+# tulis-keadaan
+
+[Daftar keadaan(state-register)](../concept/state-register.md) mendefinisikan tugas untuk menulis nilai ke dalam satu keadaan.
+
+## parameter
+
+- nama
+  - Menentukan "nama" keadaan sasaran yang ingin ditulis
+- [aksesor](../concept/data-accessor.md)
+  - Sebuah nama langkah dalam skenario, yang menentukan data yang ingin ditulis.

package/helps/integration/task/state-write.zh.md

@@ -0,0 +1,10 @@
+# 写入状态
+
+[状态登记册(state-register)](../concept/state-register.md)中定义了将值写入一个状态的任务。
+
+## 参数
+
+- 名称
+  - 指定要写入的目标状态的“名称”
+- [访问器](../concept/data-accessor.md)
+  - 在场景中的一个步骤名称，用于指定要写入的数据。

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@things-factory/integration-base",
-  "version": "6.2.34",
+  "version": "6.2.35",
   "main": "dist-server/index.js",
   "browser": "client/index.js",
   "things-factory": true,
@@ -46,5 +46,5 @@
   "devDependencies": {
     "@types/cron": "^2.0.1"
   },
-  "gitHead": "c1bf972f4b3b088638923bbf62badb572e1e6401"
+  "gitHead": "7f44fa314cdfcb84faf99e3db9d188efb53c2423"
 }

package/server/engine/task/index.ts

@@ -39,3 +39,5 @@ import './headless-scrap'
 import './set-domain'
 import './oracle-procedure'
 import './jsonata'
+import './state-read'
+import './state-write'

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

@@ -10,7 +10,7 @@ import { TaskRegistry } from '../task-registry'
 async function LocalGraphqlMutate(step, context) {
   var { params, updaterId } = step
   var { mutation, variables: variablesAccessorMap, headers } = params || {}
-  var { client, domain, user, data, variables, lng } = context
+  var { logger, client, domain, user, data, variables, lng } = context
 
   user =
     user ||
@@ -37,7 +37,7 @@ async function LocalGraphqlMutate(step, context) {
     return variables
   }, {})
 
-  var { data: mutateResult } = await client.mutate({
+  var { data: mutateResult, errors } = await client.mutate({
     mutation: gql`
       ${mutation}
     `,
@@ -51,6 +51,12 @@ async function LocalGraphqlMutate(step, context) {
     }
   })
 
+  if (errors) {
+    errors.forEach(error => {
+      logger.error('GraphQL Error: %s', error)
+    })
+  }
+
   return {
     data: mutateResult
   }

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

@@ -10,7 +10,7 @@ import { TaskRegistry } from '../task-registry'
 async function LocalGraphqlQuery(step, context) {
   var { params, updaterId } = step
   var { query, variables: variablesAccessorMap, headers } = params || {}
-  var { client, domain, user, data, variables, lng } = context
+  var { logger, client, domain, user, data, variables, lng } = context
 
   user =
     user ||
@@ -37,7 +37,7 @@ async function LocalGraphqlQuery(step, context) {
     return variables
   }, {})
 
-  var { data: queryResult } = await client.query({
+  var { data: queryResult, errors } = await client.query({
     query: gql`
       ${query}
     `,
@@ -51,6 +51,12 @@ async function LocalGraphqlQuery(step, context) {
     }
   })
 
+  if (errors) {
+    errors.forEach(error => {
+      logger.error('GraphQL Error: %s', error)
+    })
+  }
+
   return {
     data: queryResult
   }

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

@@ -0,0 +1,54 @@
+import gql from 'graphql-tag'
+import { TaskRegistry } from '../task-registry'
+
+async function StateRead(step, { logger, publish, data, domain, user, client }) {
+  var {
+    params: { name }
+  } = step
+
+  if (!name) {
+    throw Error(`name should be defined: name - '${name}'`)
+  }
+
+  var { data: queryResult, errors } = await client.query({
+    query: gql`
+      query ($name: String!) {
+        stateRegisterByName(state: $state, name: $name) {
+          state
+        }
+      }
+    `,
+    variables: {
+      name
+    },
+    context: {
+      state: {
+        domain,
+        user
+      }
+    }
+  })
+
+  if (errors) {
+    errors.forEach(error => {
+      logger.error('GraphQL Error: %s', error)
+    })
+  }
+
+  return {
+    data: queryResult?.stateRegisterByName?.state
+  }
+}
+
+StateRead.parameterSpec = [
+  {
+    type: 'string',
+    name: 'name',
+    label: 'name'
+  }
+]
+
+StateRead.connectorFree = true
+StateRead.help = 'integration/task/state-read'
+
+TaskRegistry.registerTaskHandler('state-read', StateRead)

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

@@ -0,0 +1,63 @@
+import gql from 'graphql-tag'
+import { access } from '@things-factory/utils'
+import { TaskRegistry } from '../task-registry'
+
+async function StateWrite(step, { logger, publish, data, domain, user, client }) {
+  var {
+    params: { name, accessor }
+  } = step
+
+  if (!name || !accessor) {
+    throw Error(`name and accessor should be defined: name - '${name}', accessor - '${accessor}'`)
+  }
+
+  var state = access(accessor, data)
+
+  var { data: mutateResult, errors } = await client.mutate({
+    mutation: gql`
+      mutation ($state: Object!, $name: String!) {
+        updateStateRegisterByName(state: $state, name: $name) {
+          state
+        }
+      }
+    `,
+    variables: {
+      name,
+      state
+    },
+    context: {
+      state: {
+        domain,
+        user
+      }
+    }
+  })
+
+  if (errors) {
+    errors.forEach(error => {
+      logger.error('GraphQL Error: %s', error)
+    })
+  }
+
+  return {
+    data: mutateResult?.updateStateRegisterByName?.state
+  }
+}
+
+StateWrite.parameterSpec = [
+  {
+    type: 'string',
+    name: 'name',
+    label: 'name'
+  },
+  {
+    type: 'scenario-step-input',
+    name: 'accessor',
+    label: 'accessor'
+  }
+]
+
+StateWrite.connectorFree = true
+StateWrite.help = 'integration/task/state-write'
+
+TaskRegistry.registerTaskHandler('state-write', StateWrite)

package/server/service/index.ts

@@ -6,6 +6,7 @@ import { entities as ScenarioQueueEntities, resolvers as ScenarioQueueResolvers
 import { entities as StepEntities, resolvers as StepResolvers } from './step'
 import { entities as TaskTypeEntities, resolvers as TaskTypeResolvers } from './task-type'
 import { entities as PayloadLogEntities, resolvers as PayloadLogResolvers } from './payload-log'
+import { entities as StateRegisterEntities, resolvers as StateRegisterResolvers } from './state-register'
 import { resolvers as IntegrationAnalysisQuery } from './analysis'
 
 export * from './property-spec'
@@ -18,6 +19,7 @@ export * from './scenario-queue/scenario-queue-type'
 export * from './step/step-type'
 export * from './scenario-flow/scenario-flow'
 export * from './payload-log/payload-log'
+export * from './state-register/state-register'
 
 export const entities = [
   ...TaskTypeEntities,
@@ -27,7 +29,8 @@ export const entities = [
   ...ScenarioInstanceEntities,
   ...ScenarioQueueEntities,
   ...StepEntities,
-  ...PayloadLogEntities
+  ...PayloadLogEntities,
+  ...StateRegisterEntities
 ]
 
 export const schema = {
@@ -40,7 +43,8 @@ export const schema = {
     ...ScenarioQueueResolvers,
     ...StepResolvers,
     ...PayloadLogResolvers,
-    ...IntegrationAnalysisQuery
+    ...IntegrationAnalysisQuery,
+    ...StateRegisterResolvers
   ]
 }
 

package/server/service/state-register/index.ts

@@ -0,0 +1,7 @@
+import { StateRegister } from './state-register'
+import { StateRegisterQuery } from './state-register-query'
+import { StateRegisterMutation } from './state-register-mutation'
+
+export const entities = [StateRegister]
+export const resolvers = [StateRegisterQuery, StateRegisterMutation]
+export const subscribers = []