@things-factory/worklist-client 6.0.24

package/helps/worklist-webhook/work-center.md

@@ -0,0 +1,160 @@
+# WorkCenter
+
+Paragraphs are separated by a blank line.
+
+2nd paragraph. _Italic_, **bold**, and `monospace`. Itemized lists
+look like:
+
+- this one
+- that one
+- the other one
+
+Note that --- not considering the asterisk --- the actual text
+content starts at 4-columns in.
+
+> Block quotes are
+> written like so.
+>
+> They can span multiple paragraphs,
+> if you like.
+
+Use 3 dashes for an em-dash. Use 2 dashes for ranges (ex., "it's all
+in chapters 12--14"). Three dots ... will be converted to an ellipsis.
+Unicode is supported. ☺
+
+## An h2 header
+
+Here's a numbered list:
+
+1. first item
+2. second item
+3. third item
+
+Note again how the actual text starts at 4 columns in (4 characters
+from the left side). Here's a code sample:
+
+# Let me re-iterate ...
+
+for i in 1 .. 10 { do-something(i) }
+
+As you probably guessed, indented 4 spaces. By the way, instead of
+indenting the block, you can use delimited blocks, if you like:
+
+```
+define foobar() {
+print "Welcome to flavor country!";
+}
+```
+
+(which makes copying & pasting easier). You can optionally mark the
+delimited block for Pandoc to syntax highlight it:
+
+```python
+import time
+# Quick, count to ten!
+for i in range(10):
+# (but not *too* quick)
+time.sleep(0.5)
+print(i)
+```
+
+### An h3 header
+
+Now a nested list:
+
+1. First, get these ingredients:
+
+- carrots
+- celery
+- lentils
+
+2. Boil some water.
+
+3. Dump everything in the pot and follow
+   this algorithm:
+
+find wooden spoon
+uncover pot
+stir
+cover pot
+balance wooden spoon precariously on pot handle
+wait 10 minutes
+goto first step (or shut off burner when done)
+
+Do not bump wooden spoon or it will fall.
+
+Notice again how text always lines up on 4-space indents (including
+that last line which continues item 3 above).
+
+Here's a link to [a website](http://foo.bar), to a [local
+doc](local-doc.html), and to a [section heading in the current
+doc](#an-h2-header). Here's a footnote [^1].
+
+[^1]: Some footnote text.
+
+Tables can look like this:
+
+Name Size Material Color
+
+---
+
+All Business 9 leather brown
+Roundabout 10 hemp canvas natural
+Cinderella 11 glass transparent
+
+Table: Shoes sizes, materials, and colors.
+
+(The above is the caption for the table.) Pandoc also supports
+multi-line tables:
+
+---
+
+Keyword Text
+
+---
+
+red Sunsets, apples, and
+other red or reddish
+things.
+
+green Leaves, grass, frogs
+and other things it's
+not easy being.
+
+---
+
+A horizontal rule follows.
+
+---
+
+Here's a definition list:
+
+apples
+: Good for making applesauce.
+
+oranges
+: Citrus!
+
+tomatoes
+: There's no "e" in tomatoe.
+
+Again, text is indented 4 spaces. (Put a blank line between each
+term and its definition to spread things out more.)
+
+Here's a "line block" (note how whitespace is honored):
+
+| Line one
+| Line too
+| Line tree
+
+and images can be specified like so:
+
+![example image](example-image.jpg 'An exemplary image')
+
+Inline math equation: $\omega = d\phi / dt$. Display
+math should get its own line like so:
+
+$$I = \int \rho R^{2} dV$$
+
+And note that you can backslash-escape any punctuation characters
+which you wish to be displayed literally, ex.: \`foo\`, \*bar\*, etc.

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@things-factory/worklist-client",
+  "version": "6.0.24",
+  "main": "dist-server/index.js",
+  "browser": "dist-client/index.js",
+  "things-factory": true,
+  "license": "MIT",
+  "author": "heartyoh <heartyoh@hatiolab.com>",
+  "description": "webhook endpoint for worklist service",
+  "publishConfig": {
+    "access": "public",
+    "@things-factory:registry": "https://registry.npmjs.org"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hatiolab/things-factory.git",
+    "directory": "packages/worklist-client"
+  },
+  "scripts": {
+    "build": "npm run build:server && npm run build:client",
+    "build:client": "npx tsc --p ./client/tsconfig.json",
+    "build:server": "npx tsc --p ./server/tsconfig.json",
+    "clean:client": "npx rimraf dist-client",
+    "clean:server": "npx rimraf dist-server",
+    "clean": "npm run clean:server && npm run clean:client",
+    "migration:create": "node ../../node_modules/typeorm/cli.js migration:create -d ./server/migrations"
+  },
+  "dependencies": {
+    "@operato/graphql": "^1.0.0",
+    "@operato/shell": "^1.0.0",
+    "@things-factory/auth-base": "^6.0.24",
+    "@things-factory/oauth2-client": "^6.0.24",
+    "@things-factory/shell": "^6.0.24"
+  },
+  "gitHead": "27c1a4c3bcf4f293e7e676caa1f2daa3bb6ded11"
+}

package/server/controllers/activity-registry.ts

@@ -0,0 +1,17 @@
+import { Activity } from '../service/activity/activity'
+
+export class ActivityRegistry {
+  static registry = new Map<string, Activity>()
+
+  static set(id: string, activity: Activity) {
+    ActivityRegistry.registry.set(id, activity)
+  }
+
+  static get(id: string) {
+    return ActivityRegistry.get(id)
+  }
+
+  static list(): Activity[] {
+    return ActivityRegistry.list()
+  }
+}

package/server/controllers/graphql-client.ts

@@ -0,0 +1,68 @@
+import 'cross-fetch/polyfill'
+
+import { ApolloClient, ApolloLink, from, HttpLink, InMemoryCache } from '@apollo/client/core'
+import { onError } from '@apollo/client/link/error'
+import { Oauth2Client } from '@things-factory/oauth2-client'
+import { getRepository } from '@things-factory/shell'
+import { logger } from '@things-factory/utils'
+import { config } from '@things-factory/env'
+
+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
+})
+
+const uri = config.get('worklist/service/uri', 'https://gangsters.hatiolab.com')
+
+export async function connect() {
+  var ERROR_HANDLER: any = ({ graphQLErrors, networkError }) => {
+    if (graphQLErrors)
+      graphQLErrors.map(({ message, locations, path }) => {
+        logger.error(`[GraphQL error] Message: ${message}, Location: ${locations}, Path: ${path}`)
+      })
+
+    if (networkError) {
+      logger.error(`[Network error - ${networkError.statusCode}] ${networkError}`)
+    }
+  }
+
+  const oauth2Client: Oauth2Client = await getRepository(Oauth2Client).findOneBy({ name: 'WORKLIST' })
+
+  const authMiddleware = new ApolloLink((operation, forward) => {
+    // add the authorization to the headers
+    operation.setContext(({ headers = {} }) => ({
+      headers: {
+        ...headers,
+        ...oauth2Client.getAuthHeaders()
+      }
+    }))
+
+    return forward(operation)
+  })
+
+  return new ApolloClient({
+    defaultOptions,
+    cache,
+    link: from([
+      authMiddleware,
+      onError(ERROR_HANDLER),
+      new HttpLink({
+        uri,
+        credentials: 'include'
+      })
+    ])
+  })
+}

package/server/controllers/index.ts

@@ -0,0 +1,4 @@
+export * from './work-center'
+export * from './worklist-api'
+export * from './webhooks'
+export * from './activity-registry'

package/server/controllers/webhooks/decorators.ts

@@ -0,0 +1,18 @@
+import { WorkCenter } from '../../service/work-center/work-center'
+
+export const webhook = (target: Object, property: string, descriptor: TypedPropertyDescriptor<any>): any => {
+  const method = descriptor.value
+
+  descriptor.value = async function (request) {
+    const WorklistWebhook = this
+
+    var m = WorklistWebhook.handlers[method.name]
+    if (!m) {
+      throw Error(`Worklist Webhook doesn't have the handler ${method.name}`)
+    }
+
+    return await m.apply(this, [request])
+  }
+
+  return descriptor
+}

package/server/controllers/webhooks/index.ts

@@ -0,0 +1,30 @@
+import { getRepository } from '@things-factory/shell'
+
+import { WorkCenter } from '../../service/work-center/work-center'
+import { webhook } from './decorators'
+
+export class WorklistWebhook {
+  static handlers = {}
+
+  static registerHandlers(handlers) {
+    WorklistWebhook.handlers = handlers
+  }
+
+  static async getWorkCenter(id: string) {
+    return await getRepository(WorkCenter).findOne({
+      where: { workCenterId: id }
+    })
+  }
+
+  @webhook
+  static echo(center, req): any {}
+
+  @webhook
+  static onActivityApprovalUpdated(center, req): any {}
+
+  @webhook
+  static onActivityThreadUpdated(center, req): any {}
+
+  @webhook
+  static onActivityInstanceUpdated(center, req): any {}
+}

package/server/controllers/work-center/connect-work-center.ts

@@ -0,0 +1,15 @@
+import { Domain, getRepository } from '@things-factory/shell'
+import { Oauth2Client } from '@things-factory/oauth2-client'
+
+export async function connectWorkCenter(domain: Domain) {
+  const client = await getRepository(Oauth2Client).findOneBy({
+    domain: { id: domain.id },
+    authUrl: 'https://gangsters.hatiolab.com/oauth/authorize'
+  })
+
+  if (client) {
+    return client
+  }
+
+  // TODO else..
+}

package/server/controllers/work-center/get-work-center.ts

@@ -0,0 +1,9 @@
+import { Domain, getRepository } from '@things-factory/shell'
+import { Oauth2Client } from '@things-factory/oauth2-client'
+
+export async function getWorkCenter(domain: Domain): Promise<Oauth2Client> {
+  return await getRepository(Oauth2Client).findOneBy({
+    domain: { id: domain.id },
+    authUrl: 'https://gangsters.hatiolab.com/oauth/authorize'
+  })
+}

package/server/controllers/work-center/index.ts

@@ -0,0 +1,2 @@
+export * from './connect-work-center'
+export * from './get-work-center'

package/server/controllers/worklist-api/assign-activity-thread.ts

@@ -0,0 +1,3 @@
+import { WorkCenter } from 'service'
+
+export async function assignActivityThread(center: WorkCenter, activityThread: any) {}

package/server/controllers/worklist-api/draft-activity-instance.ts

@@ -0,0 +1,3 @@
+import { WorkCenter } from 'service'
+
+export async function draftActivityInstance(center: WorkCenter, activityInstance: any) {}

package/server/controllers/worklist-api/get-activity-list.ts

@@ -0,0 +1,3 @@
+import { WorkCenter } from 'service'
+
+export async function getActivityList(center: WorkCenter) {}

package/server/controllers/worklist-api/get-activity.ts

@@ -0,0 +1,3 @@
+import { WorkCenter } from 'service'
+
+export async function getActivity(center: WorkCenter, options: any) {}

package/server/controllers/worklist-api/get-todo-list.ts

@@ -0,0 +1,4 @@
+import { User } from '@things-factory/auth-base'
+import { WorkCenter } from 'service'
+
+export async function getToDoList(center: WorkCenter, user: User) {}

package/server/controllers/worklist-api/index.ts

@@ -0,0 +1,7 @@
+export * from './assign-activity-thread'
+export * from './draft-activity-instance'
+export * from './get-activity-list'
+export * from './get-todo-list'
+export * from './register-activity'
+export * from './unregister-activity'
+export * from './update-activity'

package/server/controllers/worklist-api/register-activity.ts

@@ -0,0 +1,3 @@
+import { WorkCenter } from 'service'
+
+export async function registerActivity(center: WorkCenter, activity: any) {}

package/server/controllers/worklist-api/unregister-activity.ts

@@ -0,0 +1,3 @@
+import { WorkCenter } from 'service'
+
+export async function unregisterActivity(center: WorkCenter, activity: any) {}

package/server/controllers/worklist-api/update-activity.ts

@@ -0,0 +1,3 @@
+import { WorkCenter } from 'service'
+
+export async function updateActivity(center: WorkCenter, activity: any) {}

package/server/index.ts

@@ -0,0 +1,5 @@
+export * from './migrations'
+export * from './middlewares'
+export * from './controllers'
+
+import './routes'

package/server/middlewares/index.ts

@@ -0,0 +1,3 @@
+export function initMiddlewares(app) {
+  /* can add middlewares into app */
+}

package/server/migrations/index.ts

@@ -0,0 +1,9 @@
+const glob = require('glob')
+const path = require('path')
+
+export var migrations = []
+
+glob.sync(path.resolve(__dirname, '.', '**', '*.js')).forEach(function(file) {
+  if (file.indexOf('index.js') !== -1) return
+  migrations = migrations.concat(Object.values(require(path.resolve(file))) || [])
+})

package/server/routes.ts

@@ -0,0 +1,46 @@
+import { WorklistWebhook } from './controllers/webhooks'
+
+process.on('bootstrap-module-global-public-route' as any, (app, globalPublicRouter) => {
+  globalPublicRouter.post('/worklist-client', async (context, next) => {
+    var { req } = context
+    var { tag, domain, data } = req
+
+    const center = WorklistWebhook.getWorkCenter(domain.id)
+
+    switch (tag) {
+      case 'activity-approval':
+        WorklistWebhook.onActivityApprovalUpdated(center, data)
+        break
+      case 'activity-thread':
+        WorklistWebhook.onActivityThreadUpdated(center, data)
+        break
+      case 'activity-instance':
+        WorklistWebhook.onActivityInstanceUpdated(center, data)
+        break
+      default:
+        WorklistWebhook.echo(center, data)
+    }
+
+    context.type = 'text/plain'
+    context.status = 200
+    context.body = 'OK'
+  })
+})
+
+process.on('bootstrap-module-global-private-route' as any, (app, globalPrivateRouter) => {
+  /*
+   * can add global private routes to application (auth required, tenancy not required)
+   */
+})
+
+process.on('bootstrap-module-domain-public-route' as any, (app, domainPublicRouter) => {
+  /*
+   * can add domain public routes to application (auth not required, tenancy required)
+   */
+})
+
+process.on('bootstrap-module-domain-private-route' as any, (app, domainPrivateRouter) => {
+  /*
+   * can add domain private routes to application (auth required, tenancy required)
+   */
+})

package/server/service/activity/activity-model-type.ts

@@ -0,0 +1,106 @@
+import { Field, InputType, Int, ObjectType, registerEnumType } from 'type-graphql'
+
+import { ScalarObject } from '@things-factory/shell'
+
+export enum ActivityModelItemInoutType {
+  in = 'in',
+  out = 'out',
+  inout = 'inout'
+}
+
+registerEnumType(ActivityModelItemInoutType, {
+  name: 'ActivityModelItemInoutType',
+  description: 'inout enumeration of a activity-model-item'
+})
+
+export enum ActivityModelItemType {
+  number = 'number',
+  text = 'text',
+  textarea = 'textarea',
+  boolean = 'boolean',
+  select = 'select',
+  file = 'file'
+}
+
+registerEnumType(ActivityModelItemType, {
+  name: 'ActivityModelItemType',
+  description: 'data type enumeration of a activity-model-item'
+})
+
+@ObjectType({ description: 'Entity for ActivityModelItem' })
+export class ActivityModelItem {
+  @Field()
+  name: string
+
+  @Field({ nullable: true })
+  description?: string
+
+  @Field({ nullable: true })
+  tag?: string
+
+  @Field({ nullable: true })
+  active?: boolean
+
+  @Field({ nullable: true })
+  hidden?: boolean
+
+  @Field({ nullable: true })
+  mandatory?: boolean
+
+  @Field(type => ActivityModelItemInoutType, { nullable: true })
+  inout?: ActivityModelItemInoutType
+
+  @Field({ nullable: true })
+  type?: ActivityModelItemType
+
+  @Field(type => ScalarObject, { nullable: true })
+  options?: { [option: string]: any }
+
+  @Field({ nullable: true })
+  unit?: string
+
+  @Field(type => [Int], { nullable: true })
+  quantifier: number[]
+
+  @Field(type => ScalarObject, { nullable: true })
+  spec?: { [key: string]: any }
+}
+
+@InputType()
+export class ActivityModelItemPatch {
+  @Field({ nullable: true })
+  name?: string
+
+  @Field({ nullable: true })
+  description?: string
+
+  @Field({ nullable: true })
+  tag?: string
+
+  @Field(type => ActivityModelItemInoutType, { nullable: true })
+  inout?: ActivityModelItemInoutType
+
+  @Field(type => ActivityModelItemType, { nullable: true })
+  type?: ActivityModelItemType
+
+  @Field(type => ScalarObject, { nullable: true })
+  options?: { [option: string]: any }
+
+  @Field({ nullable: true })
+  unit?: string
+
+  @Field(type => [Int], { nullable: true })
+  quantifier: number[]
+
+  @Field({ nullable: true })
+  active?: boolean
+
+  @Field({ nullable: true })
+  mandatory?: boolean
+
+  @Field({ nullable: true })
+  hidden?: boolean
+
+  @Field(type => ScalarObject, { nullable: true })
+  spec?: { [key: string]: any }
+}

package/server/service/activity/activity-mutation.ts

@@ -0,0 +1,85 @@
+import { Arg, Ctx, Directive, Mutation, Resolver } from 'type-graphql'
+
+import { Activity } from './activity'
+import { ActivityPatch, NewActivity } from './activity-type'
+
+@Resolver(Activity)
+export class ActivityMutation {
+  @Directive('@transaction')
+  @Mutation(returns => Activity, { description: 'To create new Activity' })
+  async createActivity(@Arg('activity') activity: NewActivity, @Ctx() context: ResolverContext): Promise<Activity> {
+    const { domain, user, tx } = context.state
+
+    // WorkCenter를 찾는다.
+    // WorkCenter에 graphql createActivity를 호출한다.
+    return
+  }
+
+  @Directive('@transaction')
+  @Mutation(returns => Activity, { description: 'To modify Activity information' })
+  async updateActivity(
+    @Arg('id') id: string,
+    @Arg('patch') patch: ActivityPatch,
+    @Ctx() context: ResolverContext
+  ): Promise<Activity> {
+    const { domain, user, tx } = context.state
+
+    // workcenter의 토큰을 가져온다.
+    // remote graphql의 activity query를 호출한다.
+
+    return
+  }
+
+  @Directive('@transaction')
+  @Mutation(returns => [Activity], { description: "To modify multiple Activities' information" })
+  async updateMultipleActivity(
+    @Arg('patches', type => [ActivityPatch]) patches: ActivityPatch[],
+    @Ctx() context: ResolverContext
+  ): Promise<Activity[]> {
+    const { domain, user, tx } = context.state
+
+    // workcenter의 토큰을 가져온다.
+    // remote graphql의 activity query를 호출한다.
+
+    return
+  }
+
+  @Directive('@transaction')
+  @Mutation(returns => Boolean, { description: 'To delete Activity' })
+  async deleteActivity(@Arg('id') id: string, @Ctx() context: ResolverContext): Promise<boolean> {
+    const { domain, tx } = context.state
+
+    // workcenter의 토큰을 가져온다.
+    // remote graphql의 activity query를 호출한다.
+
+    return
+  }
+
+  @Directive('@transaction')
+  @Mutation(returns => Boolean, { description: 'To delete multiple Activities' })
+  async deleteActivities(
+    @Arg('ids', type => [String]) ids: string[],
+    @Ctx() context: ResolverContext
+  ): Promise<boolean> {
+    const { domain, tx } = context.state
+
+    // workcenter의 토큰을 가져온다.
+    // remote graphql의 activity query를 호출한다.
+
+    return
+  }
+
+  @Directive('@transaction')
+  @Mutation(returns => Boolean, { description: 'To import multiple Activities' })
+  async importActivities(
+    @Arg('activities', type => [ActivityPatch]) activities: ActivityPatch[],
+    @Ctx() context: ResolverContext
+  ): Promise<boolean> {
+    const { domain, tx } = context.state
+
+    // workcenter의 토큰을 가져온다.
+    // remote graphql의 activity query를 호출한다.
+
+    return
+  }
+}