@things-factory/integration-base 6.2.44 → 6.2.49

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

@@ -0,0 +1,8 @@
+# sleep
+
+'sleep' 파라미터로 지정된 지속 시간만큼 대기하고, 지정된 시간이 만료되면 다음 태스크로 이동한다.
+
+## parameters
+
+- 지속 시간
+  - 대기해야 하는 시간을 설정한다. 단위는 밀리세컨드(ms)이다.

package/helps/integration/task/sleep.md

@@ -1,8 +1,8 @@
-# sleep Task
+# sleep
 
-'sleep' 파라미터로 지정된 지속 시간만큼 대기하고, 지정된 시간이 만료되면 다음 태스크로 이동한다.
+Waits for the specified duration as given by the 'sleep' parameter and moves on to the next task when the specified time elapses.
 
-## parameters
+## Parameters
 
-- 지속 시간
-  - 대기해야 하는 시간을 설정한다. 단위는 밀리세컨드(ms)이다.
+- Duration
+  - Sets the time to wait. The unit is milliseconds (ms).

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

@@ -0,0 +1,8 @@
+# sleep
+
+Menunggu selama durasi yang ditentukan oleh parameter 'tidur' dan melanjutkan ke tugas berikutnya ketika waktu yang ditentukan berlalu.
+
+## Parameter
+
+- Durasi
+  - Menetapkan waktu untuk menunggu. Satuannya adalah milidetik (ms).

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

@@ -0,0 +1,8 @@
+# sleep
+
+等待由'sleep'参数指定的持续时间，当指定的时间过去后，将移至下一个任务。
+
+## 参数
+
+- 持续时间
+  - 设置等待的时间。单位为毫秒（ms）。

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

@@ -1,4 +1,4 @@
-# 状態読み取り
+# state-read
 
 [状態登録簿(state-register)](../concept/state-register.md)で定義されている状態の値を読み取るタスクです。
 

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

@@ -1,4 +1,4 @@
-# bacaan keadaan
+# state-read
 
 [Daftar keadaan(state-register)](../concept/state-register.md) mendefinisikan tugas untuk membaca nilai suatu keadaan.
 

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

@@ -1,4 +1,4 @@
-# 读取状态
+# state-read
 
 [状态登记册(state-register)](../concept/state-register.md)中定义了一个状态值的读取任务。
 

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

@@ -1,4 +1,4 @@
-# 状態書き込み
+# state-write
 
 [状態登録簿(state-register)](../concept/state-register.md)に定義された一つの状態に値を書き込むタスクです。
 

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

@@ -1,4 +1,4 @@
-# tulis-keadaan
+# state-write
 
 [Daftar keadaan(state-register)](../concept/state-register.md) mendefinisikan tugas untuk menulis nilai ke dalam satu keadaan.
 

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

@@ -1,4 +1,4 @@
-# 写入状态
+# state-write
 
 [状态登记册(state-register)](../concept/state-register.md)中定义了将值写入一个状态的任务。
 

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

@@ -0,0 +1,12 @@
+# throw
+
+シナリオの実行中に故意に異常な例外をスローするためのタスクです。
+（正常な終了を示す 'end' タスクと区別する必要があります。）
+Throwがシナリオの実行中に実行されると、シナリオの 'preventErrorPropagation' 属性に応じて、例外が親シナリオに伝播されるか、シナリオ内で捕捉され、親シナリオのタスクが通常通り進行することができます。
+
+- preventErrorPropagation が true の場合
+  - 親シナリオが存在する場合：シナリオを開始した親 'scenario' タスクにも例外が渡されます。結果として、親シナリオも異常な例外が発生します。
+  - 親シナリオが存在しない場合：シナリオはシナリオエンジンによって異常終了と見なされます。
+- preventErrorPropagation が false の場合
+  - 親シナリオが存在する場合：例外はシナリオを開始した親 'scenario' タスクに渡されないため、結果として親シナリオは通常の進行を続けます。
+  - 親シナリオが存在しない場合：シナリオはシナリオエンジンによって正常終了と見なされます。

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

@@ -0,0 +1,12 @@
+# throw
+
+Scenario 진행 중에 강제로 비정상 예외를 던지기 위한 태스크이다.
+(정상종료를 의미하는 'end' 태스크와 구분할 필요가 있다.)
+Scenario 진행 중에 Throw를 하게 되면, 해당 시나리오의 'preventErrorPropagation' 속성에 따라서, 부모 시나리오에 예외가 전파되거나 해당 시나리오에서 캐치되어 정상적으로 상위 시나리오의 태스크가 진행될 수도 있다.
+
+- preventErrorPropagation 이 true 인 경우
+  - 부모 시나리오가 있는 경우 : 해당 시나리오를 시작한 부모 'scenario' 태스크에도 예외가 전달된다. 결과적으로 부모 시나리오도 비정상 예외가 발생하게 된다.
+  - 부모 시나리오가 없는 경우 : 해당 시나리오는 시나리오 엔진에 의해 비정상 종료로 처리된다.
+- preventErrorPropagation 이 false 인 경우
+  - 부모 시나리오가 있는 경우 : 해당 시나리오를 시작한 부모 'scenario' 태스크에 예외가 전달되지 않으므로, 결과적으로 부모 시나리오도 정상적인 진행이 계속된다.
+  - 부모 시나리오가 없는 경우 : 해당 시나리오는 시나리오 엔진에 의해 정상 종료로 처리된다.

package/helps/integration/task/throw.md

@@ -1,12 +1,12 @@
-# Throw
+# throw
 
-Scenario 진행 중에 강제로 비정상 예외를 던지기 위한 태스크이다.
-(정상종료를 의미하는 'end' 태스크와 구분할 필요가 있다.)
-Scenario 진행 중에 Throw를 하게 되면, 해당 시나리오의 'preventErrorPropagation' 속성에 따라서, 부모 시나리오에 예외가 전파되거나 해당 시나리오에서 캐치되어 정상적으로 상위 시나리오의 태스크가 진행될 수도 있다.
+A task for intentionally throwing an abnormal exception during the scenario execution.
+(It needs to be distinguished from the 'end' task, which signifies normal termination.)
+When Throw is executed during the scenario, depending on the 'preventErrorPropagation' attribute of the scenario, the exception may be propagated to the parent scenario or caught within the scenario, allowing the parent scenario's tasks to proceed normally.
 
-- preventErrorPropagation 이 true 인 경우
-  - 부모 시나리오가 있는 경우 : 해당 시나리오를 시작한 부모 'scenario' 태스크에도 예외가 전달된다. 결과적으로 부모 시나리오도 비정상 예외가 발생하게 된다.
-  - 부모 시나리오가 없는 경우 : 해당 시나리오는 시나리오 엔진에 의해 비정상 종료로 처리된다.
-- preventErrorPropagation 이 false 인 경우
-  - 부모 시나리오가 있는 경우 : 해당 시나리오를 시작한 부모 'scenario' 태스크에 예외가 전달되지 않으므로, 결과적으로 부모 시나리오도 정상적인 진행이 계속된다.
-  - 부모 시나리오가 없는 경우 : 해당 시나리오는 시나리오 엔진에 의해 정상 종료로 처리된다.
+- When preventErrorPropagation is true
+  - If there is a parent scenario: The exception is also passed to the parent 'scenario' task that started the scenario. As a result, the parent scenario also experiences an abnormal exception.
+  - If there is no parent scenario: The scenario is treated as an abnormal termination by the scenario engine.
+- When preventErrorPropagation is false
+  - If there is a parent scenario: The exception is not passed to the parent 'scenario' task that started the scenario. As a result, the parent scenario continues its normal progress.
+  - If there is no parent scenario: The scenario is treated as a normal termination by the scenario engine.

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

@@ -0,0 +1,12 @@
+# throw
+
+Tugas untuk sengaja melemparkan pengecualian yang tidak normal selama eksekusi skenario.
+(Harus dibedakan dari tugas 'end', yang menandakan terminasi normal.)
+Ketika Throw dieksekusi selama skenario, tergantung pada atribut 'preventErrorPropagation' dari skenario, pengecualian dapat dipropagasi ke skenario induk atau ditangkap dalam skenario tersebut, memungkinkan tugas skenario induk untuk melanjutkan dengan normal.
+
+- Ketika preventErrorPropagation bernilai true
+  - Jika ada skenario induk: Pengecualian juga diteruskan ke tugas 'scenario' induk yang memulai skenario. Sebagai hasilnya, skenario induk juga mengalami pengecualian yang tidak normal.
+  - Jika tidak ada skenario induk: Skenario dianggap sebagai terminasi yang tidak normal oleh mesin skenario.
+- Ketika preventErrorPropagation bernilai false
+  - Jika ada skenario induk: Pengecualian tidak diteruskan ke tugas 'scenario' induk yang memulai skenario. Sebagai hasilnya, skenario induk melanjutkan kemajuan normalnya.
+  - Jika tidak ada skenario induk: Skenario dianggap sebagai terminasi normal oleh mesin skenario.

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

@@ -0,0 +1,12 @@
+# throw
+
+用于在场景执行期间故意引发异常的任务。
+（需要与表示正常终止的 'end' 任务区分开来。）
+当在场景执行期间执行Throw时，取决于场景的 'preventErrorPropagation' 属性，异常可能会传播到父场景，或者在场景内捕获，从而允许父场景的任务正常进行。
+
+- 当 preventErrorPropagation 为 true 时
+  - 如果有父场景：异常也会传递到启动场景的父 'scenario' 任务。结果，父场景也会经历异常。
+  - 如果没有父场景：场景被场景引擎视为异常终止。
+- 当 preventErrorPropagation 为 false 时
+  - 如果有父场景：异常不会传递到启动场景的父 'scenario' 任务。结果，父场景将继续正常进展。
+  - 如果没有父场景：场景被场景引擎视为正常终止。

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

@@ -0,0 +1,37 @@
+# variables
+
+これは[シナリオコンテキスト](../concept/scenario-context.md)のデータにシナリオの入力変数を追加するタスクです。
+Variables Taskはその後のステップのタスクでシナリオ入力変数を使用できるように、シナリオが開始されたときに受け取った入力変数をそのまま返すタスクです。
+
+例えば、
+
+- シナリオの入力変数の値
+
+```
+{
+  inputA: "ABC",
+  inputB: "DEF"
+}
+```
+
+そして、
+
+- Variables Taskの名前が "VARIABLES" の場合、
+- Variables Taskが完了した後、Scenario Contextのデータには次のような値が追加されます。
+
+```
+# scenario.context.data
+{
+  ...,
+  VARIALBES: {
+    inputA: "ABC",
+    inputB: "DEF"
+  },
+  ...
+}
+
+```
+
+## パラメータ
+
+このタスクには特定の属性が定義されていません。

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

@@ -0,0 +1,37 @@
+# variables
+
+Scenario의 입력변수를 [Scenario Context](../concept/scenario-context.md) Data에 추가하는 태스크이다.
+Variables Task는 이후 Step의 Task에서 Scenario Input 변수를 사용할 수 있도록, Scenario 시작 시에 받은 Input 변수들을 그대로 리턴하는 태스크이다.
+
+예를 들어,
+
+- Scenario Input 변수값
+
+```
+{
+  inputA: "ABC",
+  inputB: "DEF"
+}
+```
+
+이고,
+
+- Variables Task의 이름이 "VARIABLES" 인 경우,
+- Variables Task가 완료된 후에 Scenario Context의 Data에는 다음과 같은 값이 추가되게 된다.
+
+```
+# scenario.context.data
+{
+  ...,
+  VARIALBES: {
+    inputA: "ABC",
+    inputB: "DEF"
+  },
+  ...
+}
+
+```
+
+## parameters
+
+이 Task에는 별도 속성이 정의되지 않는다.

package/helps/integration/task/variables.md

@@ -1,11 +1,11 @@
-# Variables
+# variables
 
-Scenario의 입력변수를 [Scenario Context](../concept/scenario-context.md) Data에 추가하는 태스크이다.
-Variables Task는 이후 Step의 Task에서 Scenario Input 변수를 사용할 수 있도록, Scenario 시작 시에 받은 Input 변수들을 그대로 리턴하는 태스크이다.
+This is a task that adds Scenario input variables to the [Scenario Context](../concept/scenario-context.md) Data.
+The Variables Task returns the input variables received at the start of the Scenario as they are, allowing Scenario Input variables to be used in subsequent Step tasks.
 
-예를 들어,
+For example,
 
-- Scenario Input 변수값
+- Scenario Input variable values
 
 ```
 {
@@ -14,16 +14,16 @@ Variables Task는 이후 Step의 Task에서 Scenario Input 변수를 사용할
 }
 ```
 
-이고,
+And,
 
-- Variables Task의 이름이 "VARIABLES" 인 경우,
-- Variables Task가 완료된 후에 Scenario Context의 Data에는 다음과 같은 값이 추가되게 된다.
+- If the name of the Variables Task is "VARIABLES",
+- After the Variables Task is completed, the following values will be added to the Scenario Context's Data:
 
 ```
 # scenario.context.data
 {
   ...,
-  VARIALBES: {
+  VARIABLES: {
     inputA: "ABC",
     inputB: "DEF"
   },
@@ -32,6 +32,6 @@ Variables Task는 이후 Step의 Task에서 Scenario Input 변수를 사용할
 
 ```
 
-## parameters
+## Parameters
 
-이 Task에는 별도 속성이 정의되지 않는다.
+This task does not have specific attributes defined.

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

@@ -0,0 +1,37 @@
+# variables
+
+Ini adalah tugas yang menambah pembolehubah input Skenario ke Data [Konteks Skenario](../concept/scenario-context.md).
+Tugas Pembolehubah mengembalikan pembolehubah input yang diterima pada permulaan Skenario sebagaimana adanya, membolehkan pembolehubah input Skenario digunakan dalam tugas Langkah berikutnya.
+
+Sebagai contoh,
+
+- Nilai pembolehubah input Skenario
+
+```
+{
+  inputA: "ABC",
+  inputB: "DEF"
+}
+```
+
+Dan,
+
+- Jika nama Tugas Pembolehubah adalah "VARIABLES",
+- Setelah Tugas Pembolehubah selesai, nilai berikut akan ditambahkan ke Data Konteks Skenario:
+
+```
+# scenario.context.data
+{
+  ...,
+  VARIABLES: {
+    inputA: "ABC",
+    inputB: "DEF"
+  },
+  ...
+}
+
+```
+
+## Parameter
+
+Tugas ini tidak mempunyai atribut khusus yang ditentukan.

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

@@ -0,0 +1,37 @@
+# variables
+
+这是一个将场景输入变量添加到[场景上下文](../concept/scenario-context.md)数据中的任务。
+Variables Task将在场景开始时接收到的输入变量原样返回，从而允许在后续步骤任务中使用场景输入变量。
+
+例如，
+
+- 场景输入变量值
+
+```
+{
+  inputA: "ABC",
+  inputB: "DEF"
+}
+```
+
+而且，
+
+- 如果Variables Task的名称为 "VARIABLES"，
+- Variables Task完成后，将以下值添加到场景上下文的数据中：
+
+```
+# scenario.context.data
+{
+  ...,
+  VARIABLES: {
+    inputA: "ABC",
+    inputB: "DEF"
+  },
+  ...
+}
+
+```
+
+## 参数
+
+此任务没有特定定义的属性。

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@things-factory/integration-base",
-  "version": "6.2.44",
+  "version": "6.2.49",
   "main": "dist-server/index.js",
   "browser": "client/index.js",
   "things-factory": true,
@@ -26,12 +26,12 @@
   },
   "dependencies": {
     "@apollo/client": "^3.6.9",
-    "@things-factory/api": "^6.2.44",
-    "@things-factory/auth-base": "^6.2.44",
+    "@things-factory/api": "^6.2.49",
+    "@things-factory/auth-base": "^6.2.49",
     "@things-factory/env": "^6.2.33",
-    "@things-factory/oauth2-client": "^6.2.44",
-    "@things-factory/scheduler-client": "^6.2.44",
-    "@things-factory/shell": "^6.2.44",
+    "@things-factory/oauth2-client": "^6.2.49",
+    "@things-factory/scheduler-client": "^6.2.49",
+    "@things-factory/shell": "^6.2.48",
     "async-mqtt": "^2.5.0",
     "chance": "^1.1.11",
     "cross-fetch": "^3.0.4",
@@ -46,5 +46,5 @@
   "devDependencies": {
     "@types/cron": "^2.0.1"
   },
-  "gitHead": "a2a1ebf823f6b1315e751b12a01372e9a867d7af"
+  "gitHead": "57266c96220301729f9c5cd633af1a4e2a651096"
 }

package/server/engine/connector/operato-connector.ts

@@ -40,12 +40,31 @@ const cache = new InMemoryCache({
 export const GRAPHQL_URI = '/graphql'
 export const SUBSCRIPTION_URI = GRAPHQL_URI
 
-async function checkPermission(privilegeObject: PrivilegeObject, user: User, domain: Domain): Promise<boolean> {
-  if (!privilegeObject || !privilegeObject.privilege || !privilegeObject.category) {
+async function checkPermission(
+  privilegeObject: PrivilegeObject,
+  user: User,
+  domain: Domain,
+  protectedIP: boolean
+): Promise<boolean> {
+  if (!privilegeObject) {
     return true
   }
 
-  const { owner: domainOwnerGranted, super: superUserGranted, category, privilege } = privilegeObject
+  const {
+    owner: domainOwnerGranted,
+    super: superUserGranted,
+    category,
+    privilege,
+    protected: protectedIPOnly
+  } = privilegeObject
+
+  if (protectedIPOnly && !protectedIP) {
+    return false
+  }
+
+  if (!privilege || !category) {
+    return true
+  }
 
   return (
     (domainOwnerGranted && (await process.domainOwnerGranted(domain, user))) ||
@@ -62,7 +81,6 @@ interface SubscriberData {
 ;``
 
 export class OperatoConnector implements Connector {
-  private subscriptions: SubscriberData[] = []
   private context: any
 
   async ready(connectionConfigs) {
@@ -224,7 +242,7 @@ export class OperatoConnector implements Connector {
       throw new Error(`scenario is not found - ${tag}`)
     }
 
-    if (!(await checkPermission(scenario.privilege, user, domain))) {
+    if (!(await checkPermission(scenario.privilege, user, domain, false))) {
       const { category, privilege } = scenario.privilege || {}
       throw new Error(`Unauthorized! ${category}-${privilege} privilege required`)
     }

package/server/engine/types.ts

@@ -14,6 +14,7 @@ export type Context = {
   domain: Object
   user: Object
   lng: string
+  protected: boolean | undefined
   logger: any
   publish: Function
   load: Function

package/server/service/scenario-instance/scenario-instance-mutation.ts

@@ -31,12 +31,31 @@ async function findScenario(
   return scenario as any
 }
 
-async function checkPermission(privilegeObject: PrivilegeObject, user: User, domain: Domain): Promise<boolean> {
-  if (!privilegeObject || !privilegeObject.privilege || !privilegeObject.category) {
+async function checkPermission(
+  privilegeObject: PrivilegeObject,
+  user: User,
+  domain: Domain,
+  protectedIP?: boolean
+): Promise<boolean> {
+  if (!privilegeObject) {
     return true
   }
 
-  const { owner: domainOwnerGranted, super: superUserGranted, category, privilege } = privilegeObject
+  const {
+    owner: domainOwnerGranted,
+    super: superUserGranted,
+    category,
+    privilege,
+    protected: protectedIPOnly
+  } = privilegeObject || {}
+
+  if (protectedIPOnly && !protectedIP) {
+    return false
+  }
+
+  if (!privilege || !category) {
+    return true
+  }
 
   return (
     (domainOwnerGranted && (await process.domainOwnerGranted(domain, user))) ||
@@ -56,7 +75,7 @@ export class ScenarioInstanceMutation {
     @Arg('variables', type => ScalarObject, { nullable: true }) variables: any,
     @Ctx() context: ResolverContext
   ): Promise<ScenarioInstance> {
-    const { domain, user, lng } = context.state
+    const { domain, user, lng, protected: protectedIP } = context.state
 
     debug('runScenario', scenarioName, instanceName, variables)
 
@@ -70,7 +89,7 @@ export class ScenarioInstanceMutation {
       )
     }
 
-    if (!(await checkPermission(scenario.privilege, user, domain))) {
+    if (!(await checkPermission(scenario.privilege, user, domain, protectedIP))) {
       throw new Error(`Unauthorized!`)
     }
 
@@ -96,7 +115,7 @@ export class ScenarioInstanceMutation {
     @Arg('variables', type => ScalarObject, { nullable: true }) variables: any,
     @Ctx() context: ResolverContext
   ): Promise<ScenarioInstance> {
-    const { domain, user, lng } = context.state
+    const { domain, user, lng, protected: protectedIP } = context.state
 
     debug('startScenario', instanceName, scenarioName, variables)
 
@@ -110,7 +129,7 @@ export class ScenarioInstanceMutation {
       )
     }
 
-    if (!(await checkPermission(scenario.privilege, user, domain))) {
+    if (!(await checkPermission(scenario.privilege, user, domain, protectedIP))) {
       throw new Error(`Unauthorized!`)
     }
 
@@ -123,7 +142,7 @@ export class ScenarioInstanceMutation {
     @Arg('instanceName', { nullable: true }) instanceName: string,
     @Ctx() context: ResolverContext
   ): Promise<ScenarioInstance | undefined> {
-    const { domain, user } = context.state
+    const { domain, user, protected: protectedIP } = context.state
 
     debug('stopScenario', instanceName)
 
@@ -140,7 +159,7 @@ export class ScenarioInstanceMutation {
 
     var scenario = await findScenario(scenarioInstance.scenarioName, domain)
 
-    if (!(await checkPermission(scenario.privilege, user, domain))) {
+    if (!(await checkPermission(scenario.privilege, user, domain, protectedIP))) {
       throw new Error(`Unauthorized!`)
     }
 

package/server/service/scenario-instance/scenario-instance-type.ts

@@ -153,7 +153,7 @@ export class ScenarioInstance {
   }
 
   constructor(instanceName, { name: scenarioName, steps, domain: scenarioDomain }, context?) {
-    var { domain, user, lng } = context || {}
+    var { domain, user, lng, protected: protectedIP } = context || {}
     domain ||= scenarioDomain
 
     this.instanceName = instanceName
@@ -167,6 +167,7 @@ export class ScenarioInstance {
       domain,
       user,
       lng,
+      protected: protectedIP,
       logger:
         context?.logger ||
         createLogger({