142 lines
3.6 KiB
Plaintext
142 lines
3.6 KiB
Plaintext
--!strict
|
|
-- DrCr: Web-based double-entry bookkeeping framework
|
|
-- Copyright (C) 2022-2025 Lee Yingtong Li (RunasSudo)
|
|
--
|
|
-- This program is free software: you can redistribute it and/or modify
|
|
-- it under the terms of the GNU Affero General Public License as published by
|
|
-- the Free Software Foundation, either version 3 of the License, or
|
|
-- (at your option) any later version.
|
|
--
|
|
-- This program is distributed in the hope that it will be useful,
|
|
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
-- GNU Affero General Public License for more details.
|
|
--
|
|
-- You should have received a copy of the GNU Affero General Public License
|
|
-- along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
------------------------
|
|
-- Plugin specific types
|
|
|
|
-- Represents a libdrcr plugin specification and implementation
|
|
export type Plugin = {
|
|
name: string,
|
|
reporting_steps: {ReportingStep},
|
|
}
|
|
|
|
-- Specifies a ReportingStep provided by the plugin
|
|
export type ReportingStep = {
|
|
name: string,
|
|
product_kinds: {ReportingProductKind},
|
|
|
|
requires: (
|
|
ReportingStepArgs,
|
|
ReportingContext
|
|
) -> {ReportingProductId},
|
|
|
|
after_init_graph: (
|
|
ReportingStepArgs,
|
|
{ReportingStepId}, -- steps
|
|
(ReportingStepId, ReportingProductId) -> (), -- add_dependency
|
|
ReportingContext
|
|
) -> (),
|
|
|
|
execute: (
|
|
ReportingStepArgs,
|
|
ReportingContext,
|
|
(ReportingProductId) -> ReportingProduct -- get_product
|
|
) -> {[ReportingProductId]: ReportingProduct},
|
|
}
|
|
|
|
-------------------------
|
|
-- libdrcr internal types
|
|
|
|
export type ReportingContext = {
|
|
sofy_date: string,
|
|
eofy_date: string,
|
|
reporting_commodity: string,
|
|
}
|
|
|
|
-- Accounting types
|
|
|
|
export type Transaction = {
|
|
id: number | nil,
|
|
dt: string,
|
|
description: string,
|
|
postings: {Posting},
|
|
}
|
|
|
|
export type Posting = {
|
|
id: number | nil,
|
|
transaction_id: number | nil,
|
|
description: number | nil,
|
|
account: string,
|
|
quantity: number,
|
|
commodity: string,
|
|
quantity_ascost: number | nil,
|
|
}
|
|
|
|
-- Reporting products
|
|
|
|
export type ReportingProduct = {
|
|
BalancesAt: BalancesAt?,
|
|
BalancesBetween: BalancesBetween?,
|
|
DynamicReport: DynamicReport?,
|
|
Transactions: Transactions?,
|
|
}
|
|
|
|
export type BalancesAt = any
|
|
export type BalancesBetween = any
|
|
export type DynamicReport = any
|
|
export type Transactions = { transactions: {Transaction} }
|
|
|
|
export type ReportingProductId = {
|
|
name: string,
|
|
kind: ReportingProductKind,
|
|
args: ReportingStepArgs,
|
|
}
|
|
|
|
export type ReportingProductKind = 'BalancesAt' | 'BalancesBetween' | 'DynamicReport' | 'Transactions'
|
|
|
|
-- Reporting steps
|
|
|
|
export type ReportingStepId = {
|
|
name: string,
|
|
product_kinds: {ReportingProductKind},
|
|
args: ReportingStepArgs,
|
|
}
|
|
|
|
-- Reporting step args
|
|
|
|
export type ReportingStepArgs = 'VoidArgs' | { DateArgs: DateArgs } | { DateStartDateEndArgs: DateStartDateEndArgs } | { MultipleDateArgs: MultipleDateArgs } | { MultipleDateStartDateEndArgs: MultipleDateStartDateEndArgs }
|
|
|
|
export type DateArgs = { date: string }
|
|
export type DateStartDateEndArgs = { date_start: string, date_end: string }
|
|
export type MultipleDateArgs = { dates: {DateArgs} }
|
|
export type MultipleDateStartDateEndArgs = { dates: {DateStartDateEndArgs} }
|
|
|
|
-----------------
|
|
-- Module exports
|
|
|
|
local libdrcr = {}
|
|
|
|
function libdrcr.repr(value: any): string
|
|
local result = ''
|
|
if type(value) == 'table' then
|
|
result = result .. '{'
|
|
for k, v in pairs(value) do
|
|
result = result .. k .. ' = ' .. libdrcr.repr(v) .. ', '
|
|
end
|
|
result = result .. '}'
|
|
elseif type(value) == 'string' then
|
|
result = result .. "'" .. value .. "'"
|
|
elseif type(value) == 'number' then
|
|
result = result .. value
|
|
else
|
|
result = result .. '??'
|
|
end
|
|
return result
|
|
end
|
|
|
|
return libdrcr
|