@things-factory/integration-base 6.2.24 → 6.2.27

package/helps/integration/connector/graphql-connector.md

@@ -0,0 +1,23 @@
+# graphql connector
+
+## Description
+
+A connector for connecting to a remote GraphQL server and performing queries or mutations. To connect to the GraphQL server on the internal server and perform queries or mutations, use the 'local-graphql-mutate' task and 'local-graphql-query' task without specifying a separate connector.
+
+## Setting
+
+### Endpoint
+
+Specify the GraphQL server endpoint.
+
+ex. *https://example.com/graphql*
+
+## Parameters
+
+### OAuth2 Client
+
+- Specify the client created in advance for application OAuth2 authentication.
+- Create a client for application OAuth2 authentication in the following menu of the Operato application.
+  ![oauth2-client-menu](./assets/../../../../assets/images/graphql-oauth2-menu.png 'oauth2-client-menu')
+- When you select this menu, you can create and manage OAuth2 clients as shown below, and the client created here can be selected as a parameter.
+  ![oauth2-client-screen](./assets/../../../../assets/images/graphql-oauth2-screen.png 'oauth2-client-screen')

package/helps/integration/connector/operato-connector.ja.md

@@ -0,0 +1,26 @@
+# Operatoコネクタ
+
+## 説明
+
+- 外部の他のOperatoアプリケーションのデータを取得するか、データを変更または生成するためのコネクタです。
+- GraphQLを基に動作し、queryまたはmutateタスクを実行できます。
+- Operatoアプリケーションにアクセスするには、該当サーバーの管理者に別途認証キーを要求して取得する必要があります。
+- Operatoアプリケーションにアクセスするには、実際に機能を実行しようとするドメインを指定する必要があります。
+
+## 設定
+
+### エンドポイント
+
+GraphQLサーバーエンドポイントを指定します。
+
+例: *https://abcd.hatioalb.com/graphql*
+
+## パラメータ
+
+### 認証キー
+
+- 対象サーバー管理者から要求して受け取った認証キーを入力します。
+
+### ドメイン
+
+- 対象サーバーで動作させたいドメインを指定する必要があります。

package/helps/integration/connector/operato-connector.kr.md

@@ -0,0 +1,28 @@
+# operato connector
+
+## Description
+
+- 외부의 다른 Operato 어플리케이션의 데이터를 획득하거나 혹은 데이터를 변경 혹은 생성하기 위한 커넥터입니다.
+- graphql을 기반으로 동작하며, query 혹은 mutate 태스크를 수행할 수 있습니다.
+- Operato 어플리케이션에 접근하기 위해서는 별도의 인증 키를 해당 서버의 관리자에게 요청해서 받아야 합니다.
+- Operato 어플리케이션에 접근하기 위해서는 실제로 기능을 수행하려고 하는 도메인을 지정해야 합니다.
+
+## Setting
+
+### 엔드포인트
+
+Graphql 서버 엔드포인트를 지정합니다.
+
+ex. *https://abcd.hatioalb.com/graphql*
+
+
+## Parameters
+
+### 인증 키
+
+- 대상 서버 관리자로부터 요청해서 받은 인증 키를 입력합니다.
+
+
+### 도메인
+
+- 대상 서버에서 동작하고자 하는 도메인을 지정해야 합니다.

package/helps/integration/connector/operato-connector.md

@@ -0,0 +1,26 @@
+# Operato Connector
+
+## Description
+
+- A connector for acquiring data from other external Operato applications or for changing or creating data.
+- Operates based on GraphQL and can perform query or mutate tasks.
+- To access the Operato application, a separate authentication key must be requested and obtained from the administrator of that server.
+- To access the Operato application, you need to specify the actual domain for the functionality you want to perform.
+
+## Setting
+
+### Endpoint
+
+Specify the GraphQL server endpoint.
+
+ex. *https://abcd.hatioalb.com/graphql*
+
+## Parameters
+
+### Authentication Key
+
+- Enter the authentication key received by requesting it from the target server administrator.
+
+### Domain
+
+- Specify the domain you want to operate on the target server.

package/helps/integration/connector/operato-connector.ms.md

@@ -0,0 +1,26 @@
+# penyambung Operato
+
+## Penerangan
+
+- Sambung untuk mendapatkan data aplikasi Operato luaran atau mengubah atau membuat data.
+- Berasaskan GraphQL dan boleh menjalankan tugasan kueri atau mutasi.
+- Untuk mengakses aplikasi Operato, anda perlu meminta kunci pengesahan tambahan dari pentadbir server tersebut.
+- Untuk mengakses aplikasi Operato, anda perlu menentukan domain yang sebenarnya untuk menjalankan fungsi.
+
+## Tetapan
+
+### Titik Akhir
+
+Nyatakan titik akhir server GraphQL.
+
+contoh: *https://abcd.hatioalb.com/graphql*
+
+## Parameter
+
+### Kunci Pengesahan
+
+- Masukkan kunci pengesahan yang diterima daripada pentadbir server sasaran.
+
+### Domain
+
+- Anda perlu menentukan domain yang ingin beroperasi dari server sasaran.

package/helps/integration/connector/operato-connector.zh.md

@@ -0,0 +1,26 @@
+# Operato连接器
+
+## 描述
+
+- 连接器用于获取外部Operato应用程序的数据或更改或生成数据。
+- 基于GraphQL工作，可以执行查询或变更任务。
+- 要访问Operato应用程序，您需要向该服务器的管理员请求并获取单独的身份验证密钥。
+- 要访问Operato应用程序，您实际上需要指定要执行功能的域。
+
+## 设置
+
+### 终点
+
+指定GraphQL服务器终点。
+
+例如：*https://abcd.hatioalb.com/graphql*
+
+## 参数
+
+### 认证密钥
+
+- 输入从目标服务器管理员那里请求并获得的认证密钥。
+
+### 领域
+
+- 您需要指定要在目标服务器上运行的实际域。

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@things-factory/integration-base",
-  "version": "6.2.24",
+  "version": "6.2.27",
   "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.24",
-    "@things-factory/auth-base": "^6.2.24",
-    "@things-factory/env": "^6.2.0",
-    "@things-factory/oauth2-client": "^6.2.24",
-    "@things-factory/scheduler-client": "^6.2.24",
-    "@things-factory/shell": "^6.2.24",
+    "@things-factory/api": "^6.2.27",
+    "@things-factory/auth-base": "^6.2.27",
+    "@things-factory/env": "^6.2.27",
+    "@things-factory/oauth2-client": "^6.2.27",
+    "@things-factory/scheduler-client": "^6.2.27",
+    "@things-factory/shell": "^6.2.27",
     "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": "f407983563cca529ba87ea8febb5be751ad3229e"
+  "gitHead": "6d414311ca45c329e93606fe46edd7ea53c819c5"
 }

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

@@ -113,6 +113,10 @@ export class GraphqlConnector implements Connector {
   get description() {
     return 'Graphql Http Connector'
   }
+
+  get help() {
+    return 'integration/connector/graphql-connector'
+  }
 }
 
 ConnectionManager.registerConnector('graphql-connector', new GraphqlConnector())

package/server/engine/connector/index.ts

@@ -9,3 +9,4 @@ import './mssql-connector'
 import './oracle-connector'
 import './mysql-connector'
 import './socket-server'
+import './operato-connector'

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

@@ -0,0 +1,113 @@
+import 'cross-fetch/polyfill'
+
+import { ApolloClient, InMemoryCache, createHttpLink } from '@apollo/client/core'
+import { setContext } from '@apollo/client/link/context'
+
+import { ConnectionManager } from '../connection-manager'
+import { Connector } from '../types'
+
+const defaultOptions: any = {
+  watchQuery: {
+    fetchPolicy: 'no-cache',
+    errorPolicy: 'ignore'
+  },
+  query: {
+    fetchPolicy: 'no-cache', //'network-only'
+    errorPolicy: 'all'
+  },
+  mutate: {
+    errorPolicy: 'all'
+  }
+}
+
+const cache = new InMemoryCache({
+  addTypename: false
+})
+
+export class OperatoConnector implements Connector {
+  async ready(connectionConfigs) {
+    await Promise.all(connectionConfigs.map(this.connect.bind(this)))
+
+    ConnectionManager.logger.info('graphql-connector connections are ready')
+  }
+
+  async connect(connection) {
+    var {
+      endpoint: uri,
+      params: { authKey, domain }
+    } = connection
+
+    var ERROR_HANDLER: any = ({ graphQLErrors, networkError }) => {
+      if (graphQLErrors)
+        graphQLErrors.map(({ message, locations, path }) => {
+          ConnectionManager.logger.error(`[GraphQL error] Message: ${message}, Location: ${locations}, Path: ${path}`)
+        })
+
+      if (networkError) {
+        ConnectionManager.logger.error(`[Network error - ${networkError.statusCode}] ${networkError}`)
+      }
+    }
+
+    const httpLink = createHttpLink({
+      uri: uri
+    })
+
+    ConnectionManager.addConnectionInstance(
+      connection,
+      new ApolloClient({
+        defaultOptions,
+        cache,
+        link: setContext((_, { headers }) => {
+          return {
+            headers: {
+              ...headers,
+              'x-things-factory-domain': domain,
+              authorization: authKey ? `Bearer ${authKey}` : ''
+            }
+          }
+        }).concat(httpLink)
+      })
+    )
+
+    ConnectionManager.logger.info(
+      `graphql-connector connection(${connection.name}:${connection.endpoint}) is connected`
+    )
+  }
+
+  async disconnect(connection) {
+    var client = ConnectionManager.getConnectionInstance(connection)
+    client.stop()
+    ConnectionManager.removeConnectionInstance(connection)
+
+    ConnectionManager.logger.info(`graphql-connector connection(${connection.name}) is disconnected`)
+  }
+
+  get parameterSpec() {
+    return [
+      {
+        type: 'string',
+        name: 'authKey',
+        label: 'auth-key'
+      },
+      {
+        type: 'string',
+        name: 'domain',
+        label: 'domain'
+      }
+    ]
+  }
+
+  get taskPrefixes() {
+    return ['graphql']
+  }
+
+  get help() {
+    return 'integration/connector/operato-connector'
+  }
+
+  get description() {
+    return 'Operato Grpahql Connector'
+  }
+}
+
+ConnectionManager.registerConnector('operato-connector', new OperatoConnector())

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

@@ -11,27 +11,12 @@ import {
   UpdateDateColumn
 } from 'typeorm'
 
-import { Privilege, User } from '@things-factory/auth-base'
+import { PrivilegeObject, PrivilegeInput, User } from '@things-factory/auth-base'
 import { Domain } from '@things-factory/shell'
 
 import { ScenarioEngine } from '../../engine'
 import { Step, StepPatch } from '../step/step-type'
 
-@ObjectType()
-export class PrivilegeObject {
-  @Field({ nullable: true })
-  privilege?: string
-
-  @Field({ nullable: true })
-  category?: string
-
-  @Field({ nullable: true })
-  owner?: boolean
-
-  @Field({ nullable: true })
-  super?: boolean
-}
-
 @Entity()
 @Index('ix_scenario_0', (scenario: Scenario) => [scenario.domain, scenario.name], { unique: true })
 @ObjectType()
@@ -123,21 +108,6 @@ export class Scenario {
   }
 }
 
-@InputType()
-export class PrivilegeInput {
-  @Field({ nullable: true })
-  privilege?: string
-
-  @Field({ nullable: true })
-  category?: string
-
-  @Field({ nullable: true })
-  owner?: boolean
-
-  @Field({ nullable: true })
-  super?: boolean
-}
-
 @InputType()
 export class NewScenario {
   @Field()

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

@@ -3,9 +3,9 @@ import { Arg, Ctx, Mutation, Resolver } from 'type-graphql'
 import { getRepository, Domain, GraphqlLocalClient, ScalarObject } from '@things-factory/shell'
 
 import { ScenarioEngine } from '../../engine'
-import { PrivilegeObject, Scenario } from '../scenario/scenario-type'
+import { Scenario } from '../scenario/scenario-type'
 import { ScenarioInstance } from './scenario-instance-type'
-import { User } from '@things-factory/auth-base'
+import { PrivilegeObject, User } from '@things-factory/auth-base'
 import { Step } from '../step/step-type'
 
 const debug = require('debug')('things-factory:integration-base:scenario-instance-mutation')

package/translations/en.json

@@ -2,5 +2,6 @@
   "error.scenario not found": "scenario '{scenario}' not found.",
   "error.schedule is not set": "schedule should be set for the scenario '{scenario}' in order to register as a schedule",
   "error.timezone is not set": "timezone should be set for the scenario '{scenario}' in order to register as a schedule",
-  "error.scenario instance not found": "scenario instance '{instance}' not found."
+  "error.scenario instance not found": "scenario instance '{instance}' not found.",
+  "label.auth-key": "authentication key"
 }

package/translations/ja.json

@@ -2,5 +2,6 @@
   "error.scenario not found": "シナリオ'{scenario}'が見つかりません.",
   "error.schedule is not set": "スケジュールとして登録するためにはシナリオ'{scenario}'にスケジュール情報が設定される必要があります.",
   "error.timezone is not set": "スケジュールとして登録するためにはシナリオ'{scenario}'にタイム ゾーン情報が設定される必要があります.",
-  "error.scenario instance not found": "シナリオ インスタンス'{instance}'が見つかりません. 既に終了している可能性があります."
+  "error.scenario instance not found": "シナリオ インスタンス'{instance}'が見つかりません. 既に終了している可能性があります.",
+  "label.auth-key": "認証キー"
 }

package/translations/ko.json

@@ -2,5 +2,6 @@
   "error.scenario not found": "시나리오 '{scenario}'를 찾을 수 없습니다.",
   "error.schedule is not set": "스케쥴로 등록하기 위해서는 시나리오 '{scenario}'에 스케쥴 정보가 설정되어야 합니다.",
   "error.timezone is not set": "스케쥴로 등록하기 위해서는 시나리오 '{scenario}'에 타임존 정보가 설정되어야 합니다.",
-  "error.scenario instance not found": "시나리오 인스턴스 '{instance}'를 찾을 수 없습니다. 이미 종료되었을 수 있습니다."
+  "error.scenario instance not found": "시나리오 인스턴스 '{instance}'를 찾을 수 없습니다. 이미 종료되었을 수 있습니다.",
+  "label.auth-key": "인증 키"
 }

package/translations/ms.json

@@ -2,5 +2,6 @@
   "error.scenario not found": "Tidak dapat mencari senario '{scenario}'.",
   "error.schedule is not set": "Untuk mendaftarkan sebagai jadual, maklumat jadual mesti diset dalam senario '{scenario}'.",
   "error.timezone is not set": "Untuk mendaftarkan sebagai jadual, maklumat zon masa mesti diset dalam senario '{scenario}'.",
-  "error.scenario instance not found": "Tidak dapat mencari instans senario '{instance}'. Mungkin telah berakhir."
+  "error.scenario instance not found": "Tidak dapat mencari instans senario '{instance}'. Mungkin telah berakhir.",
+  "label.auth-key": "Kunci pengesahan"
 }

package/translations/zh.json

@@ -2,5 +2,6 @@
   "error.scenario not found": "无法找到场景 '{scenario}'。",
   "error.schedule is not set": "要注册为计划，场景 '{scenario}' 需要设置计划信息。",
   "error.timezone is not set": "要注册为计划，场景 '{scenario}' 需要设置时区信息。",
-  "error.scenario instance not found": "无法找到场景实例 '{instance}'。它可能已经结束。"
+  "error.scenario instance not found": "无法找到场景实例 '{instance}'。它可能已经结束。",
+  "label.auth-key": "认证密钥"
 }