@things-factory/accounting 8.0.0-beta.9 → 8.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@things-factory/accounting",
-  "version": "8.0.0-beta.9",
+  "version": "8.0.0",
   "main": "dist-server/index.js",
   "browser": "dist-client/index.js",
   "things-factory": true,
@@ -28,11 +28,11 @@
   },
   "dependencies": {
     "@material/web": "^2.0.0",
-    "@operato/graphql": "^8.0.0-beta",
-    "@operato/shell": "^8.0.0-beta",
-    "@things-factory/auth-base": "^8.0.0-beta.9",
-    "@things-factory/shell": "^8.0.0-beta.9",
-    "@things-factory/worklist": "^8.0.0-beta.9"
+    "@operato/graphql": "^7.1.0",
+    "@operato/shell": "^7.1.0",
+    "@things-factory/auth-base": "^8.0.0",
+    "@things-factory/shell": "^8.0.0",
+    "@things-factory/worklist": "^8.0.0"
   },
-  "gitHead": "86b1dfa26292926a2d5447fdc23bfa5a9e983245"
+  "gitHead": "07ef27d272dd9a067a9648ac7013748510556a18"
 }

package/server/activities/activity-book.ts

@@ -0,0 +1,172 @@
+import {
+  Activity,
+  ActivityInstance,
+  ActivityInstanceStatus,
+  ActivityThread,
+  UpdateActivityInstanceStateAddendum
+} from '@things-factory/worklist'
+
+async function callback(
+  activityInstance: ActivityInstance,
+  addendum: UpdateActivityInstanceStateAddendum,
+  context: ResolverContext
+) {
+  const { domain, tx } = context.state
+  const { input, output, state } = activityInstance
+  const { causedBy } = addendum || {}
+
+  if (state == ActivityInstanceStatus.Ended) {
+    const activity = (await tx.getRepository(Activity).findOneBy({
+      domain: { id: domain.id },
+      name: 'Book'
+    })) as Activity
+
+    /* 
+      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.
+        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 that records income or expenses in the accounting system',
+  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'
+    }
+  ],
+  /* 
+    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,
+  /* (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',
+  /* (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: [
+    {
+      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,18 @@
+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 as any)
+})
+
+/* 
+Add the following line to server/index.ts so that activities can be registered when loading a module.
+--
+import './activities'
+*/

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

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

package/server/middlewares/index.ts

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

package/server/migrations/1725200507196-seed-fiscal-entities.ts

@@ -0,0 +1,106 @@
+import { MigrationInterface, QueryRunner } from 'typeorm'
+import { Domain, getRepository } from '@things-factory/shell'
+import { User } from '@things-factory/auth-base'
+import { FiscalYear } from '../service/fiscal-year/fiscal-year'
+import { FiscalQuarter } from '../service/fiscal-quarter/fiscal-quarter'
+import { FiscalMonth } from '../service/fiscal-month/fiscal-month'
+import { FiscalStatus } from '../service/common-type'
+
+export class SeedFiscalEntities1725200507196 implements MigrationInterface {
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    const domainRepository = getRepository(Domain)
+    const userRepository = getRepository(User)
+    const fiscalYearRepository = getRepository(FiscalYear)
+    const fiscalQuarterRepository = getRepository(FiscalQuarter)
+    const fiscalMonthRepository = getRepository(FiscalMonth)
+
+    const domain: Domain | null = await domainRepository.findOne({
+      where: { name: 'SYSTEM' }
+    })
+
+    if (!domain) {
+      throw new Error('SYSTEM domain not found')
+    }
+
+    const user = await userRepository.findOne({ where: { id: domain.owner } })
+
+    if (!user) {
+      throw new Error('Domain owner not found')
+    }
+
+    const currentYear = new Date().getFullYear()
+
+    try {
+      // Fiscal Year 생성
+      const fiscalYear = await fiscalYearRepository.save({
+        domain,
+        year: currentYear,
+        startDate: `${currentYear}-01-01`, // 문자열로 저장
+        endDate: `${currentYear}-12-31`, // 문자열로 저장
+        status: FiscalStatus.OPEN,
+        creator: user,
+        updater: user
+      })
+
+      // Fiscal Quarters 생성
+      for (let quarter = 1; quarter <= 4; quarter++) {
+        const startMonth = (quarter - 1) * 3 + 1
+        const endMonth = quarter * 3
+
+        const fiscalQuarter = await fiscalQuarterRepository.save({
+          domain,
+          year: currentYear,
+          quarter,
+          startDate: `${currentYear}-${String(startMonth).padStart(2, '0')}-01`, // 문자열로 저장
+          endDate: `${currentYear}-${String(endMonth).padStart(2, '0')}-31`, // 임시로 월의 마지막 날을 31일로 설정
+          status: FiscalStatus.OPEN,
+          creator: user,
+          updater: user
+        })
+
+        // Fiscal Months 생성
+        for (let month = startMonth; month <= endMonth; month++) {
+          const startDate = `${currentYear}-${String(month).padStart(2, '0')}-01`
+          const endDate = `${currentYear}-${String(month).padStart(2, '0')}-${new Date(currentYear, month, 0).getDate()}`
+
+          await fiscalMonthRepository.save({
+            domain,
+            year: currentYear,
+            quarter,
+            month,
+            startDate,
+            endDate,
+            status: FiscalStatus.OPEN,
+            creator: user,
+            updater: user
+          })
+        }
+      }
+    } catch (error) {
+      console.error('Failed to seed fiscal entities:', error)
+      throw error
+    }
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    const domainRepository = getRepository(Domain)
+    const fiscalYearRepository = getRepository(FiscalYear)
+    const fiscalQuarterRepository = getRepository(FiscalQuarter)
+    const fiscalMonthRepository = getRepository(FiscalMonth)
+
+    const domain: Domain | null = await domainRepository.findOne({
+      where: { name: 'SYSTEM' }
+    })
+
+    if (!domain) {
+      throw new Error('SYSTEM domain not found')
+    }
+
+    const currentYear = new Date().getFullYear()
+
+    // FiscalMonth, FiscalQuarter, FiscalYear 삭제
+    await fiscalMonthRepository.delete({ domain: { id: domain.id }, year: currentYear })
+    await fiscalQuarterRepository.delete({ domain: { id: domain.id }, year: currentYear })
+    await fiscalYearRepository.delete({ domain: { id: domain.id }, year: currentYear })
+  }
+}