@things-factory/accounting 7.0.6 → 7.1.3

package/helps/accounting/fiscal-year.md

@@ -0,0 +1,160 @@
+# FiscalYear
+
+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/helps/accounting/payment.md

@@ -0,0 +1,160 @@
+# Payment
+
+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

@@ -1,6 +1,6 @@
 {
   "name": "@things-factory/accounting",
-  "version": "7.0.6",
+  "version": "7.1.3",
   "main": "dist-server/index.js",
   "browser": "dist-client/index.js",
   "things-factory": true,
@@ -24,14 +24,15 @@
     "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"
+    "migration:create": "node ../../node_modules/typeorm/cli.js migration:create ./server/migrations/migration"
   },
   "dependencies": {
-    "@operato/graphql": "^7.0.0",
-    "@operato/shell": "^7.0.0",
-    "@things-factory/auth-base": "^7.0.6",
-    "@things-factory/shell": "^7.0.6",
-    "@things-factory/worklist": "^7.0.6"
+    "@material/web": "^2.0.0",
+    "@operato/graphql": "^7.1.0",
+    "@operato/shell": "^7.1.0",
+    "@things-factory/auth-base": "^7.1.2",
+    "@things-factory/shell": "^7.1.2",
+    "@things-factory/worklist": "^7.1.3"
   },
-  "gitHead": "9fbd670e3b446fe51c264d7f43c61daf3b75d5cc"
+  "gitHead": "30dfd9772d9fb5472c3f11c625385385b2b08504"
 }

package/server/activities/activity-book.ts

@@ -22,27 +22,35 @@ async function callback(
     })) as Activity
 
     /* 
-      book 액티비티는 한명의 assignee(thread)만 수행하도록 한다. 따라서, output 중에서 샘플 한 개만을 data로 취한다.
-      만약, 여러 assignees(threads)가 수행하는 액티비티인 경우에는 output 전체를 data로 처리한다.
+      The Book activity is designed to be performed by a single assignee (thread).
+      Therefore, we take a sample from the output as data.
+      If it were an activity performed by multiple assignees (threads),
+      we would process the entire output as data.
     */
     const assignees = Object.keys(output)
     const data = assignees.length > 0 && output[assignees[0]]
 
     if (activity) {
       /* 
-        custom logic goes here.
-        주로, 
+        Custom logic goes here.
+        Typically, this would involve recording the accounting transaction
+        or updating related data in the accounting system.
+        For example, you might:
+        1. Save the transaction to the database
+        2. Update account balances
+        3. Generate necessary reports or notifications
        */
     } else {
       console.error('Book Activity not installed.')
     }
   } else if (state == ActivityInstanceStatus.Aborted) {
+    // Implement logic for handling aborted activities here
   }
 }
 
 export const ActivityBook = {
   name: 'Book',
-  description: 'An activity thate enter a incoming or expense in the ledger',
+  description: 'An activity that records income or expenses in the accounting system',
   release: '1.0.0',
   provider: 'hatiolab.com',
   category: 'accounting',
@@ -58,24 +66,28 @@ export const ActivityBook = {
     }
   ],
   /* 
-    startable 설정된 액티비티는 수동으로 업무를 시작하여, 할당할 수 있음을 의미한다.
-    issuer로 정의된 역할을 갖는 사용자가 시작할 수 있으며, issuer가 정의되지 않았다면 모든 사용자가 시작할 수 있다.
-    업무를 시작하는 과정에서 assignees와 approval-line은 액티비티의 설정을 디폴트로 하지만 수동으로 조정할 수 있다.
+    Setting an activity as startable means it can be manually initiated and assigned.
+    Users with the defined issuer role can start it, or all users if no issuer is defined.
+    The process of starting allows for manual adjustment of assignees and approval-line,
+    with activity settings as the default.
   */
   startable: true,
-  /* (미구현 속성) 
-    startingType 설정된 액티비티는 'issue' 또는 'post' 이 될 수 있다. 'post' 타입은 혼자서 start, assign, end 까지 한번에 다하는 특성을 갖는다. 이 액티비티를 수행하는 사용자는 draft(초안)과 post(완료)단계만 인식하게 된다.
-    이 경우의 모델은 모두 'in' 또는 'inout'의 속성을 갖는 것이 좋다. 'out' 속성의 데이타는 입력될 기회를 갖지 못한다.
-    이 경우의 assignees 설정은 의미가 없다.
-    이 경우에도 approval-line이 설정되어 있다면, 승인 프로세스에 의해서 처리된다.
-    'issue' 타입인 경우에는 모델의 'in' 또는 'inout' 속성을 채워서 assignee에게 할당하는 방식이므로 assignee가 설정되어야 한다.
+  /* (Unimplemented property) 
+    startingType can be set to 'issue' or 'post'. 'post' type allows for start, assign, and end
+    to be done at once by a single user. Users only see draft and post stages for this activity.
+    All model properties should be 'in' or 'inout' in this case, as 'out' properties won't have
+    a chance for input. Assignees settings are meaningless in this case.
+    If an approval-line is set, it will still be processed through the approval process.
+    For 'issue' type, 'in' or 'inout' properties of the model are filled and assigned to the assignee,
+    so an assignee must be set.
   */
   startingType: 'post',
-  /* (미구현 속성)
-    multiple 속성은 'parallel', 'sequential' 값을 설정할 수 있다. parallel로 설정하면, 다중 인스턴스(여기서는 다중 쓰레드)로 처리하되 병렬처리되며,
-    sequential로 설정하면 순차적으로 다중 인스턴스가 수행된다.
-    설정하지 않으면, single 인스턴스로 수행된다는 의미이며, 이 경우 assignees가 여럿이 설정되어있어도 1명에게만 할당되게 된다.
-    이 경우에는 액티비티 인스턴스의 결과 데이타(output)도 단일 쓰레드의 output이 그대로 적용된다.
+  /* (Unimplemented property)
+    The multiple property can be set to 'parallel' or 'sequential'. 'parallel' processes multiple
+    instances (threads) in parallel, while 'sequential' processes them in sequence.
+    If not set, it implies single instance execution, where only one assignee is allocated even if
+    multiple are set. In this case, the activity instance's result data (output) is directly applied
+    from the single thread's output.
   */
   multiple: null,
   model: [

package/server/controllers/index.ts

@@ -0,0 +1 @@
+export * from './summary-statements'

package/server/controllers/summary-statements.ts

@@ -0,0 +1,166 @@
+import { getRepository } from '@things-factory/shell'
+
+import { FinancialStatement } from '../service/financial-statement/financial-statement'
+import { IncomeStatement } from '../service/income-statement/income-statement'
+import { Transaction, TransactionType } from '../service/transaction/transaction'
+import { Payment, PaymentDirection } from '../service/payment/payment'
+
+export async function calculateMonthlyStatements(year: number, month: number): Promise<void> {
+  const transactionRepository = getRepository(Transaction)
+  const paymentRepository = getRepository(Payment)
+  const financialStatementRepository = getRepository(FinancialStatement)
+  const incomeStatementRepository = getRepository(IncomeStatement)
+
+  // 재무제표 계산
+  const financialResult = await transactionRepository
+    .createQueryBuilder('transaction')
+    .leftJoinAndSelect('transaction.payments', 'payment')
+    .select([
+      'SUM(CASE WHEN transaction.type = :asset THEN payment.amount ELSE 0 END) AS asset',
+      'SUM(CASE WHEN transaction.type = :liability THEN payment.amount ELSE 0 END) AS liability',
+      'SUM(CASE WHEN transaction.type = :equity THEN payment.amount ELSE 0 END) AS equity'
+    ])
+    .where('transaction.year = :year', { year })
+    .andWhere('transaction.month = :month', { month })
+    .andWhere('payment.direction = :incoming', { incoming: PaymentDirection.Incoming })
+    .setParameters({
+      asset: TransactionType.Asset,
+      liability: TransactionType.Liability,
+      equity: TransactionType.Equity
+    })
+    .getRawOne()
+
+  const financialStatement = new FinancialStatement()
+  financialStatement.year = year
+  financialStatement.month = month
+  financialStatement.asset = financialResult.asset || 0
+  financialStatement.liability = financialResult.liability || 0
+  financialStatement.equity = financialResult.equity || 0
+
+  await financialStatementRepository.save(financialStatement)
+
+  // 손익계산서 계산
+  const incomeResult = await transactionRepository
+    .createQueryBuilder('transaction')
+    .leftJoinAndSelect('transaction.payments', 'payment')
+    .select([
+      'SUM(CASE WHEN transaction.type = :income THEN payment.amount ELSE 0 END) AS revenue',
+      'SUM(CASE WHEN transaction.type = :expense THEN payment.amount ELSE 0 END) AS expense'
+    ])
+    .where('transaction.year = :year', { year })
+    .andWhere('transaction.month = :month', { month })
+    .andWhere('payment.direction = :incoming', { incoming: PaymentDirection.Incoming })
+    .setParameters({
+      income: TransactionType.SalesIncome,
+      expense: TransactionType.PurchaseExpense
+    })
+    .getRawOne()
+
+  const incomeStatement = new IncomeStatement()
+  incomeStatement.year = year
+  incomeStatement.month = month
+  incomeStatement.revenue = incomeResult.revenue || 0
+  incomeStatement.expense = incomeResult.expense || 0
+  incomeStatement.netIncome = (incomeResult.revenue || 0) - (incomeResult.expense || 0)
+
+  await incomeStatementRepository.save(incomeStatement)
+}
+
+export async function calculateQuarterlyStatements(year: number, quarter: number): Promise<void> {
+  const financialStatementRepository = getRepository(FinancialStatement)
+  const incomeStatementRepository = getRepository(IncomeStatement)
+
+  const months = getMonthsInQuarter(quarter)
+
+  // 재무제표 분기 합계 계산
+  const financialResult = await financialStatementRepository
+    .createQueryBuilder('financialStatement')
+    .select([
+      'SUM(financialStatement.asset) AS asset',
+      'SUM(financialStatement.liability) AS liability',
+      'SUM(financialStatement.equity) AS equity'
+    ])
+    .where('financialStatement.year = :year', { year })
+    .andWhere('financialStatement.month IN (:...months)', { months })
+    .getRawOne()
+
+  const financialStatement = new FinancialStatement()
+  financialStatement.year = year
+  financialStatement.quarter = quarter
+  financialStatement.asset = financialResult.asset || 0
+  financialStatement.liability = financialResult.liability || 0
+  financialStatement.equity = financialResult.equity || 0
+
+  await financialStatementRepository.save(financialStatement)
+
+  // 손익계산서 분기 합계 계산
+  const incomeResult = await incomeStatementRepository
+    .createQueryBuilder('incomeStatement')
+    .select(['SUM(incomeStatement.revenue) AS revenue', 'SUM(incomeStatement.expense) AS expense'])
+    .where('incomeStatement.year = :year', { year })
+    .andWhere('incomeStatement.month IN (:...months)', { months })
+    .getRawOne()
+
+  const incomeStatement = new IncomeStatement()
+  incomeStatement.year = year
+  incomeStatement.quarter = quarter
+  incomeStatement.revenue = incomeResult.revenue || 0
+  incomeStatement.expense = incomeResult.expense || 0
+  incomeStatement.netIncome = (incomeResult.revenue || 0) - (incomeResult.expense || 0)
+
+  await incomeStatementRepository.save(incomeStatement)
+}
+
+export async function calculateYearlyStatements(year: number): Promise<void> {
+  const financialStatementRepository = getRepository(FinancialStatement)
+  const incomeStatementRepository = getRepository(IncomeStatement)
+
+  // 재무제표 연간 합계 계산
+  const financialResult = await financialStatementRepository
+    .createQueryBuilder('financialStatement')
+    .select([
+      'SUM(financialStatement.asset) AS asset',
+      'SUM(financialStatement.liability) AS liability',
+      'SUM(financialStatement.equity) AS equity'
+    ])
+    .where('financialStatement.year = :year', { year })
+    .getRawOne()
+
+  const financialStatement = new FinancialStatement()
+  financialStatement.year = year
+  financialStatement.asset = financialResult.asset || 0
+  financialStatement.liability = financialResult.liability || 0
+  financialStatement.equity = financialResult.equity || 0
+
+  await financialStatementRepository.save(financialStatement)
+
+  // 손익계산서 연간 합계 계산
+  const incomeResult = await incomeStatementRepository
+    .createQueryBuilder('incomeStatement')
+    .select(['SUM(incomeStatement.revenue) AS revenue', 'SUM(incomeStatement.expense) AS expense'])
+    .where('incomeStatement.year = :year', { year })
+    .getRawOne()
+
+  const incomeStatement = new IncomeStatement()
+  incomeStatement.year = year
+  incomeStatement.revenue = incomeResult.revenue || 0
+  incomeStatement.expense = incomeResult.expense || 0
+  incomeStatement.netIncome = (incomeResult.revenue || 0) - (incomeResult.expense || 0)
+
+  await incomeStatementRepository.save(incomeStatement)
+}
+
+export function getMonthsInQuarter(quarter: number): number[] {
+  switch (quarter) {
+    case 1:
+      return [1, 2, 3]
+    case 2:
+      return [4, 5, 6]
+    case 3:
+      return [7, 8, 9]
+    case 4:
+      return [10, 11, 12]
+    default:
+      throw new Error('Invalid quarter number')
+  }
+}

package/server/index.ts

@@ -1,4 +1,6 @@
+export * from './controllers'
 export * from './migrations'
 export * from './middlewares'
+export * from './service'
 
 import './routes'