@things-factory/accounting 6.0.46

package/helps/accounting/transaction.md

@@ -0,0 +1,160 @@
+# Transaction
+
+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/accounting",
+  "version": "6.0.46",
+  "main": "dist-server/index.js",
+  "browser": "dist-client/index.js",
+  "things-factory": true,
+  "license": "MIT",
+  "author": "heartyoh <heartyoh@hatiolab.com>",
+  "description": "A module that manages a company's cash flow balance, including income, expenses, and backlog",
+  "publishConfig": {
+    "access": "public",
+    "@things-factory:registry": "https://registry.npmjs.org"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hatiolab/things-factory.git",
+    "directory": "packages/accounting"
+  },
+  "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.43",
+    "@things-factory/shell": "^6.0.43",
+    "@things-factory/worklist": "^6.0.46"
+  },
+  "gitHead": "0fc79b215a4dabc07d2a73432e09f57252d55d83"
+}

package/server/activities/activity-book.ts

@@ -0,0 +1,149 @@
+import { Activity, ActivityInstance, ActivityInstanceStatus } from '@things-factory/worklist'
+
+async function callback(activityInstance: ActivityInstance, context: ResolverContext) {
+  const { domain, tx } = context.state
+  const { input, output, state } = activityInstance
+
+  if (state == ActivityInstanceStatus.Ended) {
+    const activity = (await tx.getRepository(Activity).findOneBy({
+      domain: { id: domain.id },
+      name: 'Book'
+    })) as Activity
+
+    /* 
+      book 액티비티는 한명의 assignee(thread)만 수행하도록 한다. 따라서, output 중에서 샘플 한 개만을 data로 취한다.
+      만약, 여러 assignees(threads)가 수행하는 액티비티인 경우에는 output 전체를 data로 처리한다.
+    */
+    const assignees = Object.keys(output)
+    const data = assignees.length > 0 && output[assignees[0]]
+
+    if (activity) {
+      /* 
+        custom logic goes here.
+        주로, 
+       */
+    } else {
+      console.error('Book Activity not installed.')
+    }
+  } else if (state == ActivityInstanceStatus.Aborted) {
+  }
+}
+
+export const ActivityBook = {
+  name: 'Book',
+  description: 'An activity thate enter a incoming or expense in the ledger',
+  release: '1.0.0',
+  provider: 'hatiolab.com',
+  category: 'accounting',
+  activityType: 'user',
+  priority: 1,
+  searchKeys: [
+    // sample search keys
+    {
+      name: 'category',
+      description: 'expense category',
+      inputKey: 'category',
+      tKey: 'category'
+    }
+  ],
+  /* 
+    startable 설정된 액티비티는 수동으로 업무를 시작하여, 할당할 수 있음을 의미한다.
+    issuer로 정의된 역할을 갖는 사용자가 시작할 수 있으며, issuer가 정의되지 않았다면 모든 사용자가 시작할 수 있다.
+    업무를 시작하는 과정에서 assignees와 approval-line은 액티비티의 설정을 디폴트로 하지만 수동으로 조정할 수 있다.
+  */
+  startable: true,
+  /* (미구현 속성) 
+    startingType 설정된 액티비티는 'issue' 또는 'post' 이 될 수 있다. 'post' 타입은 혼자서 start, assign, end 까지 한번에 다하는 특성을 갖는다. 이 액티비티를 수행하는 사용자는 draft(초안)과 post(완료)단계만 인식하게 된다.
+    이 경우의 모델은 모두 'in' 또는 'inout'의 속성을 갖는 것이 좋다. 'out' 속성의 데이타는 입력될 기회를 갖지 못한다.
+    이 경우의 assignees 설정은 의미가 없다.
+    이 경우에도 approval-line이 설정되어 있다면, 승인 프로세스에 의해서 처리된다.
+    'issue' 타입인 경우에는 모델의 'in' 또는 'inout' 속성을 채워서 assignee에게 할당하는 방식이므로 assignee가 설정되어야 한다.
+  */
+  startingType: 'post',
+  /* (미구현 속성)
+    multiple 속성은 'parallel', 'sequential' 값을 설정할 수 있다. parallel로 설정하면, 다중 인스턴스(여기서는 다중 쓰레드)로 처리하되 병렬처리되며,
+    sequential로 설정하면 순차적으로 다중 인스턴스가 수행된다.
+    설정하지 않으면, single 인스턴스로 수행된다는 의미이며, 이 경우 assignees가 여럿이 설정되어있어도 1명에게만 할당되게 된다.
+    이 경우에는 액티비티 인스턴스의 결과 데이타(output)도 단일 쓰레드의 output이 그대로 적용된다.
+  */
+  multiple: null,
+  model: [
+    {
+      name: 'name',
+      description: 'name',
+      tag: 'name',
+      hidden: false,
+      mandatory: true,
+      inout: 'in',
+      type: 'select',
+      options: {
+        options: ['KRW', 'USD', 'CNY']
+      },
+      unit: null,
+      quantifier: [1],
+      spec: {}
+    },
+    {
+      name: 'currency',
+      description: 'currency',
+      tag: 'currency',
+      hidden: false,
+      mandatory: true,
+      inout: 'in',
+      type: 'select',
+      options: {
+        options: ['KRW', 'USD', 'CNY']
+      },
+      unit: null,
+      quantifier: [1],
+      spec: {}
+    },
+    {
+      name: 'amount',
+      description: 'amount',
+      tag: 'amount',
+      hidden: false,
+      mandatory: true,
+      inout: 'in',
+      type: 'number',
+      options: {},
+      unit: null,
+      quantifier: [1],
+      spec: {}
+    },
+    {
+      name: 'category',
+      description: 'accounting category',
+      tag: 'category',
+      hidden: true,
+      mandatory: true,
+      inout: 'in',
+      type: 'string',
+      options: {},
+      unit: null,
+      quantifier: [1],
+      spec: {}
+    },
+    {
+      name: 'date',
+      description: 'issuance date',
+      tag: 'date',
+      hidden: true,
+      mandatory: true,
+      inout: 'in',
+      type: 'string',
+      options: {},
+      unit: null,
+      quantifier: [1],
+      spec: {}
+    }
+  ],
+  uiType: 'generated',
+  uiSource: '',
+  viewType: 'generated',
+  viewSource: '',
+  reportType: 'custom-element',
+  reportSource: 'activity-book-report',
+  thumbnail: '/assets/images/book-activity.jpg',
+  callback /* Called when there is a change in the lifecycle of a task (activity-instance). */
+}

package/server/activities/activity-expense.ts

@@ -0,0 +1,149 @@
+import { Activity, ActivityInstance, ActivityInstanceStatus } from '@things-factory/worklist'
+
+async function callback(activityInstance: ActivityInstance, context: ResolverContext) {
+  const { domain, tx } = context.state
+  const { input, output, state } = activityInstance
+
+  if (state == ActivityInstanceStatus.Ended) {
+    const activity = (await tx.getRepository(Activity).findOneBy({
+      domain: { id: domain.id },
+      name: 'Expense'
+    })) as Activity
+
+    /* 
+      expense 액티비티는 한명의 assignee(thread)만 수행하도록 한다. 따라서, output 중에서 샘플 한 개만을 data로 취한다.
+      만약, 여러 assignees(threads)가 수행하는 액티비티인 경우에는 output 전체를 data로 처리한다.
+    */
+    const assignees = Object.keys(output)
+    const data = assignees.length > 0 && output[assignees[0]]
+
+    if (activity) {
+      /* 
+        custom logic goes here.
+        주로, 
+       */
+    } else {
+      console.error('Expense Activity not installed.')
+    }
+  } else if (state == ActivityInstanceStatus.Aborted) {
+  }
+}
+
+export const ActivityExpense = {
+  name: 'Expense',
+  description: 'An activity for reporting and approving expense spending',
+  release: '1.0.0',
+  provider: 'hatiolab.com',
+  category: 'accounting',
+  activityType: 'user',
+  priority: 1,
+  searchKeys: [
+    // sample search keys
+    {
+      name: 'category',
+      description: 'expense category',
+      inputKey: 'category',
+      tKey: 'category'
+    }
+  ],
+  /* 
+    startable 설정된 액티비티는 수동으로 업무를 시작하여, 할당할 수 있음을 의미한다.
+    issuer로 정의된 역할을 갖는 사용자가 시작할 수 있으며, issuer가 정의되지 않았다면 모든 사용자가 시작할 수 있다.
+    업무를 시작하는 과정에서 assignees와 approval-line은 액티비티의 설정을 디폴트로 하지만 수동으로 조정할 수 있다.
+  */
+  startable: true,
+  /* (미구현 속성) 
+    startingType 설정된 액티비티는 'issue' 또는 'post' 이 될 수 있다. 'post' 타입은 혼자서 start, assign, end 까지 한번에 다하는 특성을 갖는다. 이 액티비티를 수행하는 사용자는 draft(초안)과 post(완료)단계만 인식하게 된다.
+    이 경우의 모델은 모두 'in' 또는 'inout'의 속성을 갖는 것이 좋다. 'out' 속성의 데이타는 입력될 기회를 갖지 못한다.
+    이 경우의 assignees 설정은 의미가 없다.
+    이 경우에도 approval-line이 설정되어 있다면, 승인 프로세스에 의해서 처리된다.
+    'issue' 타입인 경우에는 모델의 'in' 또는 'inout' 속성을 채워서 assignee에게 할당하는 방식이므로 assignee가 설정되어야 한다.
+  */
+  startingType: 'post',
+  /* (미구현 속성)
+    multiple 속성은 'parallel', 'sequential' 값을 설정할 수 있다. parallel로 설정하면, 다중 인스턴스(여기서는 다중 쓰레드)로 처리하되 병렬처리되며,
+    sequential로 설정하면 순차적으로 다중 인스턴스가 수행된다.
+    설정하지 않으면, single 인스턴스로 수행된다는 의미이며, 이 경우 assignees가 여럿이 설정되어있어도 1명에게만 할당되게 된다.
+    이 경우에는 액티비티 인스턴스의 결과 데이타(output)도 단일 쓰레드의 output이 그대로 적용된다.
+  */
+  multiple: null,
+  model: [
+    {
+      name: 'name',
+      description: 'name',
+      tag: 'name',
+      hidden: false,
+      mandatory: true,
+      inout: 'in',
+      type: 'select',
+      options: {
+        options: ['KRW', 'USD', 'CNY']
+      },
+      unit: null,
+      quantifier: [1],
+      spec: {}
+    },
+    {
+      name: 'currency',
+      description: 'currency',
+      tag: 'currency',
+      hidden: false,
+      mandatory: true,
+      inout: 'in',
+      type: 'select',
+      options: {
+        options: ['KRW', 'USD', 'CNY']
+      },
+      unit: null,
+      quantifier: [1],
+      spec: {}
+    },
+    {
+      name: 'amount',
+      description: 'amount',
+      tag: 'amount',
+      hidden: false,
+      mandatory: true,
+      inout: 'in',
+      type: 'number',
+      options: {},
+      unit: null,
+      quantifier: [1],
+      spec: {}
+    },
+    {
+      name: 'category',
+      description: 'expense category',
+      tag: 'category',
+      hidden: true,
+      mandatory: true,
+      inout: 'in',
+      type: 'string',
+      options: {},
+      unit: null,
+      quantifier: [1],
+      spec: {}
+    },
+    {
+      name: 'date',
+      description: 'expense spent date',
+      tag: 'date',
+      hidden: true,
+      mandatory: true,
+      inout: 'in',
+      type: 'string',
+      options: {},
+      unit: null,
+      quantifier: [1],
+      spec: {}
+    }
+  ],
+  uiType: 'generated',
+  uiSource: '',
+  viewType: 'generated',
+  viewSource: '',
+  reportType: 'custom-element',
+  reportSource: 'activity-expense-report',
+  thumbnail: '/assets/images/expense-activity.jpg',
+  callback /* Called when there is a change in the lifecycle of a task (activity-instance). */
+}

package/server/activities/index.ts

@@ -0,0 +1,19 @@
+import { ActivityInstallations } from '@things-factory/worklist'
+
+/* IMPORT ACTIVITY TEMPLATES */
+import { ActivityExpense } from './activity-expense'
+import { ActivityBook } from './activity-book'
+
+;[
+/* ACTIVITY TEMPLATES */
+	  ActivityExpense,
+	  ActivityBook,
+].forEach(template => {
+  ActivityInstallations.installActivityTemplate(template)
+})
+
+/* 
+Add the following line to server/index.ts so that activities can be registered when loading a module.
+--
+import './activities'
+*/

package/server/index.ts

@@ -0,0 +1,4 @@
+export * from './migrations'
+export * from './middlewares'
+
+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,28 @@
+const debug = require('debug')('things-factory:accounting:routes')
+
+process.on('bootstrap-module-global-public-route' as any, (app, globalPublicRouter) => {
+  /*
+   * can add global public routes to application (auth not required, tenancy not required)
+   *
+   * ex) routes.get('/path', async(context, next) => {})
+   * ex) routes.post('/path', async(context, next) => {})
+   */
+})
+
+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/account/account-history.ts

@@ -0,0 +1,103 @@
+import { Field, ID, ObjectType } from 'type-graphql'
+import { Column, Entity, Index, ManyToOne, PrimaryGeneratedColumn, RelationId } from 'typeorm'
+
+import {
+  HistoryActionColumn,
+  HistoryActionType,
+  HistoryEntityInterface,
+  HistoryOriginalIdColumn
+} from '@operato/typeorm-history'
+import { Role, User } from '@things-factory/auth-base'
+import { config } from '@things-factory/env'
+import { Domain } from '@things-factory/shell'
+
+import { Account } from './account'
+
+const ORMCONFIG = config.get('ormconfig', {})
+const DATABASE_TYPE = ORMCONFIG.type
+
+@Entity()
+@Index(
+  'ix_account_history_0',
+  (accountHistory: AccountHistory) => [accountHistory.originalId, accountHistory.version],
+  { unique: true }
+)
+@Index(
+  'ix_account_history_1',
+  (accountHistory: AccountHistory) => [accountHistory.domain, accountHistory.originalId, accountHistory.version],
+  { unique: true }
+)
+@ObjectType({ description: 'History Entity of Account' })
+export class AccountHistory implements HistoryEntityInterface<Account> {
+  @PrimaryGeneratedColumn('uuid')
+  @Field(type => ID)
+  readonly id: string
+
+  @Column({ nullable: true, default: 1 })
+  @Field({ nullable: true })
+  version?: number = 1
+
+  @ManyToOne(type => Domain)
+  @Field({ nullable: true })
+  domain?: Domain
+
+  @RelationId((account: Account) => account.domain)
+  domainId?: string
+
+  @Column({ nullable: true })
+  @Field({ nullable: true })
+  controlNumber?: string
+
+  @Column({ nullable: true })
+  @Field({ nullable: true })
+  name?: string
+
+  @Column({ nullable: true })
+  @Field({ nullable: true })
+  description?: string
+
+  @Column({ nullable: true })
+  @Field({ nullable: true })
+  active?: boolean
+
+  @Column({ nullable: true })
+  @Field({ nullable: true })
+  createdAt?: Date
+
+  @Column({ nullable: true })
+  @Field({ nullable: true })
+  updatedAt?: Date
+
+  @Column({ nullable: true })
+  @Field({ nullable: true })
+  deletedAt?: Date
+
+  @ManyToOne(type => User, { nullable: true })
+  @Field({ nullable: true })
+  creator?: User
+
+  @RelationId((account: Account) => account.creator)
+  creatorId?: string
+
+  @ManyToOne(type => User, { nullable: true })
+  @Field({ nullable: true })
+  updater?: User
+
+  @RelationId((account: Account) => account.updater)
+  updaterId?: string
+
+  @HistoryOriginalIdColumn()
+  public originalId!: string
+
+  @HistoryActionColumn({
+    nullable: false,
+    type:
+      DATABASE_TYPE == 'postgres' || DATABASE_TYPE == 'mysql' || DATABASE_TYPE == 'mariadb'
+        ? 'enum'
+        : DATABASE_TYPE == 'oracle'
+        ? 'varchar2'
+        : 'smallint',
+    enum: HistoryActionType
+  })
+  public action!: HistoryActionType
+}