@robosystems/client 0.2.48 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (190) hide show
  1. package/extensions/InvestorClient.d.ts +91 -0
  2. package/extensions/InvestorClient.js +223 -0
  3. package/extensions/InvestorClient.ts +501 -0
  4. package/extensions/LedgerClient.d.ts +213 -165
  5. package/extensions/LedgerClient.js +315 -393
  6. package/extensions/LedgerClient.ts +887 -564
  7. package/extensions/ReportClient.d.ts +77 -115
  8. package/extensions/ReportClient.js +124 -211
  9. package/extensions/ReportClient.ts +298 -358
  10. package/extensions/config.js +1 -1
  11. package/extensions/config.ts +1 -1
  12. package/extensions/graphql/client.d.ts +46 -0
  13. package/extensions/graphql/client.js +75 -0
  14. package/extensions/graphql/client.ts +82 -0
  15. package/extensions/graphql/generated/graphql.d.ts +1786 -0
  16. package/extensions/graphql/generated/graphql.js +2671 -0
  17. package/extensions/graphql/generated/graphql.ts +4491 -0
  18. package/extensions/graphql/queries/investor/holdings.d.ts +8 -0
  19. package/extensions/graphql/queries/investor/holdings.js +36 -0
  20. package/extensions/graphql/queries/investor/holdings.ts +34 -0
  21. package/extensions/graphql/queries/investor/portfolio.d.ts +4 -0
  22. package/extensions/graphql/queries/investor/portfolio.js +21 -0
  23. package/extensions/graphql/queries/investor/portfolio.ts +19 -0
  24. package/extensions/graphql/queries/investor/portfolios.d.ts +4 -0
  25. package/extensions/graphql/queries/investor/portfolios.js +29 -0
  26. package/extensions/graphql/queries/investor/portfolios.ts +27 -0
  27. package/extensions/graphql/queries/investor/position.d.ts +4 -0
  28. package/extensions/graphql/queries/investor/position.js +33 -0
  29. package/extensions/graphql/queries/investor/position.ts +31 -0
  30. package/extensions/graphql/queries/investor/positions.d.ts +8 -0
  31. package/extensions/graphql/queries/investor/positions.js +57 -0
  32. package/extensions/graphql/queries/investor/positions.ts +55 -0
  33. package/extensions/graphql/queries/investor/securities.d.ts +8 -0
  34. package/extensions/graphql/queries/investor/securities.js +50 -0
  35. package/extensions/graphql/queries/investor/securities.ts +48 -0
  36. package/extensions/graphql/queries/investor/security.d.ts +4 -0
  37. package/extensions/graphql/queries/investor/security.js +26 -0
  38. package/extensions/graphql/queries/investor/security.ts +24 -0
  39. package/extensions/graphql/queries/ledger/accountRollups.d.ts +7 -0
  40. package/extensions/graphql/queries/ledger/accountRollups.js +36 -0
  41. package/extensions/graphql/queries/ledger/accountRollups.ts +34 -0
  42. package/extensions/graphql/queries/ledger/accountTree.d.ts +11 -0
  43. package/extensions/graphql/queries/ledger/accountTree.js +61 -0
  44. package/extensions/graphql/queries/ledger/accountTree.ts +59 -0
  45. package/extensions/graphql/queries/ledger/accounts.d.ts +8 -0
  46. package/extensions/graphql/queries/ledger/accounts.js +45 -0
  47. package/extensions/graphql/queries/ledger/accounts.ts +43 -0
  48. package/extensions/graphql/queries/ledger/closingBookStructures.d.ts +6 -0
  49. package/extensions/graphql/queries/ledger/closingBookStructures.js +27 -0
  50. package/extensions/graphql/queries/ledger/closingBookStructures.ts +25 -0
  51. package/extensions/graphql/queries/ledger/elements.d.ts +6 -0
  52. package/extensions/graphql/queries/ledger/elements.js +56 -0
  53. package/extensions/graphql/queries/ledger/elements.ts +54 -0
  54. package/extensions/graphql/queries/ledger/entities.d.ts +7 -0
  55. package/extensions/graphql/queries/ledger/entities.js +31 -0
  56. package/extensions/graphql/queries/ledger/entities.ts +29 -0
  57. package/extensions/graphql/queries/ledger/entity.d.ts +14 -0
  58. package/extensions/graphql/queries/ledger/entity.js +55 -0
  59. package/extensions/graphql/queries/ledger/entity.ts +54 -0
  60. package/extensions/graphql/queries/ledger/fiscalCalendar.d.ts +8 -0
  61. package/extensions/graphql/queries/ledger/fiscalCalendar.js +35 -0
  62. package/extensions/graphql/queries/ledger/fiscalCalendar.ts +33 -0
  63. package/extensions/graphql/queries/ledger/mappedTrialBalance.d.ts +9 -0
  64. package/extensions/graphql/queries/ledger/mappedTrialBalance.js +29 -0
  65. package/extensions/graphql/queries/ledger/mappedTrialBalance.ts +27 -0
  66. package/extensions/graphql/queries/ledger/mapping.d.ts +5 -0
  67. package/extensions/graphql/queries/ledger/mapping.js +35 -0
  68. package/extensions/graphql/queries/ledger/mapping.ts +33 -0
  69. package/extensions/graphql/queries/ledger/mappingCoverage.d.ts +5 -0
  70. package/extensions/graphql/queries/ledger/mappingCoverage.js +22 -0
  71. package/extensions/graphql/queries/ledger/mappingCoverage.ts +20 -0
  72. package/extensions/graphql/queries/ledger/mappings.d.ts +6 -0
  73. package/extensions/graphql/queries/ledger/mappings.js +23 -0
  74. package/extensions/graphql/queries/ledger/mappings.ts +21 -0
  75. package/extensions/graphql/queries/ledger/periodCloseStatus.d.ts +6 -0
  76. package/extensions/graphql/queries/ledger/periodCloseStatus.js +29 -0
  77. package/extensions/graphql/queries/ledger/periodCloseStatus.ts +27 -0
  78. package/extensions/graphql/queries/ledger/periodDrafts.d.ts +8 -0
  79. package/extensions/graphql/queries/ledger/periodDrafts.js +45 -0
  80. package/extensions/graphql/queries/ledger/periodDrafts.ts +43 -0
  81. package/extensions/graphql/queries/ledger/publishList.d.ts +5 -0
  82. package/extensions/graphql/queries/ledger/publishList.js +29 -0
  83. package/extensions/graphql/queries/ledger/publishList.ts +27 -0
  84. package/extensions/graphql/queries/ledger/publishLists.d.ts +5 -0
  85. package/extensions/graphql/queries/ledger/publishLists.js +29 -0
  86. package/extensions/graphql/queries/ledger/publishLists.ts +27 -0
  87. package/extensions/graphql/queries/ledger/report.d.ts +5 -0
  88. package/extensions/graphql/queries/ledger/report.js +40 -0
  89. package/extensions/graphql/queries/ledger/report.ts +38 -0
  90. package/extensions/graphql/queries/ledger/reportingTaxonomy.d.ts +6 -0
  91. package/extensions/graphql/queries/ledger/reportingTaxonomy.js +27 -0
  92. package/extensions/graphql/queries/ledger/reportingTaxonomy.ts +25 -0
  93. package/extensions/graphql/queries/ledger/reports.d.ts +8 -0
  94. package/extensions/graphql/queries/ledger/reports.js +45 -0
  95. package/extensions/graphql/queries/ledger/reports.ts +43 -0
  96. package/extensions/graphql/queries/ledger/scheduleFacts.d.ts +7 -0
  97. package/extensions/graphql/queries/ledger/scheduleFacts.js +24 -0
  98. package/extensions/graphql/queries/ledger/scheduleFacts.ts +22 -0
  99. package/extensions/graphql/queries/ledger/schedules.d.ts +6 -0
  100. package/extensions/graphql/queries/ledger/schedules.js +24 -0
  101. package/extensions/graphql/queries/ledger/schedules.ts +22 -0
  102. package/extensions/graphql/queries/ledger/statement.d.ts +9 -0
  103. package/extensions/graphql/queries/ledger/statement.js +43 -0
  104. package/extensions/graphql/queries/ledger/statement.ts +41 -0
  105. package/extensions/graphql/queries/ledger/structures.d.ts +5 -0
  106. package/extensions/graphql/queries/ledger/structures.js +22 -0
  107. package/extensions/graphql/queries/ledger/structures.ts +20 -0
  108. package/extensions/graphql/queries/ledger/summary.d.ts +7 -0
  109. package/extensions/graphql/queries/ledger/summary.js +25 -0
  110. package/extensions/graphql/queries/ledger/summary.ts +23 -0
  111. package/extensions/graphql/queries/ledger/taxonomies.d.ts +5 -0
  112. package/extensions/graphql/queries/ledger/taxonomies.js +28 -0
  113. package/extensions/graphql/queries/ledger/taxonomies.ts +26 -0
  114. package/extensions/graphql/queries/ledger/transaction.d.ts +6 -0
  115. package/extensions/graphql/queries/ledger/transaction.js +49 -0
  116. package/extensions/graphql/queries/ledger/transaction.ts +47 -0
  117. package/extensions/graphql/queries/ledger/transactions.d.ts +7 -0
  118. package/extensions/graphql/queries/ledger/transactions.js +49 -0
  119. package/extensions/graphql/queries/ledger/transactions.ts +47 -0
  120. package/extensions/graphql/queries/ledger/trialBalance.d.ts +7 -0
  121. package/extensions/graphql/queries/ledger/trialBalance.js +28 -0
  122. package/extensions/graphql/queries/ledger/trialBalance.ts +26 -0
  123. package/extensions/graphql/queries/ledger/unmappedElements.d.ts +8 -0
  124. package/extensions/graphql/queries/ledger/unmappedElements.js +29 -0
  125. package/extensions/graphql/queries/ledger/unmappedElements.ts +27 -0
  126. package/extensions/hooks.d.ts +1 -1
  127. package/extensions/index.d.ts +5 -1
  128. package/extensions/index.js +13 -1
  129. package/extensions/index.ts +14 -0
  130. package/index.ts +2 -2
  131. package/package.json +14 -5
  132. package/sdk/index.d.ts +2 -2
  133. package/sdk/index.js +38 -65
  134. package/sdk/index.ts +2 -2
  135. package/sdk/sdk.gen.d.ts +101 -220
  136. package/sdk/sdk.gen.js +251 -445
  137. package/sdk/sdk.gen.ts +216 -409
  138. package/sdk/types.gen.d.ts +4586 -7045
  139. package/sdk/types.gen.ts +4702 -7334
  140. package/sdk.gen.d.ts +101 -220
  141. package/sdk.gen.js +251 -445
  142. package/sdk.gen.ts +216 -409
  143. package/types.gen.d.ts +4586 -7045
  144. package/types.gen.ts +4702 -7334
  145. package/extensions/AgentClient.test.ts +0 -403
  146. package/extensions/LedgerClient.test.ts +0 -1138
  147. package/extensions/OperationClient.test.ts +0 -365
  148. package/extensions/QueryClient.test.ts +0 -432
  149. package/extensions/ReportClient.test.ts +0 -828
  150. package/extensions/SSEClient.test.ts +0 -375
  151. package/extensions/config.test.ts +0 -199
  152. package/extensions/hooks.test.ts +0 -373
  153. package/extensions/index.test.ts +0 -420
  154. package/sdk-extensions/AgentClient.d.ts +0 -82
  155. package/sdk-extensions/AgentClient.js +0 -218
  156. package/sdk-extensions/AgentClient.test.ts +0 -403
  157. package/sdk-extensions/AgentClient.ts +0 -321
  158. package/sdk-extensions/LedgerClient.d.ts +0 -242
  159. package/sdk-extensions/LedgerClient.js +0 -496
  160. package/sdk-extensions/LedgerClient.test.ts +0 -1138
  161. package/sdk-extensions/LedgerClient.ts +0 -800
  162. package/sdk-extensions/OperationClient.d.ts +0 -65
  163. package/sdk-extensions/OperationClient.js +0 -251
  164. package/sdk-extensions/OperationClient.test.ts +0 -365
  165. package/sdk-extensions/OperationClient.ts +0 -324
  166. package/sdk-extensions/QueryClient.d.ts +0 -52
  167. package/sdk-extensions/QueryClient.js +0 -313
  168. package/sdk-extensions/QueryClient.test.ts +0 -432
  169. package/sdk-extensions/QueryClient.ts +0 -420
  170. package/sdk-extensions/README.md +0 -901
  171. package/sdk-extensions/ReportClient.d.ts +0 -151
  172. package/sdk-extensions/ReportClient.js +0 -278
  173. package/sdk-extensions/ReportClient.test.ts +0 -828
  174. package/sdk-extensions/ReportClient.ts +0 -486
  175. package/sdk-extensions/SSEClient.d.ts +0 -62
  176. package/sdk-extensions/SSEClient.js +0 -154
  177. package/sdk-extensions/SSEClient.test.ts +0 -375
  178. package/sdk-extensions/SSEClient.ts +0 -210
  179. package/sdk-extensions/config.d.ts +0 -57
  180. package/sdk-extensions/config.js +0 -152
  181. package/sdk-extensions/config.test.ts +0 -199
  182. package/sdk-extensions/config.ts +0 -175
  183. package/sdk-extensions/hooks.d.ts +0 -110
  184. package/sdk-extensions/hooks.js +0 -384
  185. package/sdk-extensions/hooks.test.ts +0 -373
  186. package/sdk-extensions/hooks.ts +0 -459
  187. package/sdk-extensions/index.d.ts +0 -63
  188. package/sdk-extensions/index.js +0 -164
  189. package/sdk-extensions/index.test.ts +0 -420
  190. package/sdk-extensions/index.ts +0 -203
@@ -1,321 +0,0 @@
1
- 'use client'
2
-
3
- /**
4
- * Enhanced Agent Client with SSE support
5
- * Provides intelligent agent execution with automatic strategy selection
6
- */
7
-
8
- import { autoSelectAgent, executeSpecificAgent } from '../sdk/sdk.gen'
9
- import type { AutoSelectAgentData, ExecuteSpecificAgentData } from '../sdk/types.gen'
10
- import { EventType, SSEClient } from './SSEClient'
11
-
12
- export interface AgentQueryRequest {
13
- message: string
14
- history?: Array<{ role: string; content: string }>
15
- context?: Record<string, any>
16
- mode?: 'quick' | 'standard' | 'extended' | 'streaming'
17
- enableRag?: boolean
18
- forceExtendedAnalysis?: boolean
19
- }
20
-
21
- export interface AgentOptions {
22
- mode?: 'auto' | 'sync' | 'async'
23
- maxWait?: number
24
- onProgress?: (message: string, percentage?: number) => void
25
- }
26
-
27
- export interface AgentResult {
28
- content: string
29
- agent_used: string
30
- mode_used: 'quick' | 'standard' | 'extended' | 'streaming'
31
- metadata?: Record<string, any>
32
- tokens_used?: {
33
- prompt_tokens: number
34
- completion_tokens: number
35
- total_tokens: number
36
- }
37
- confidence_score?: number
38
- execution_time?: number
39
- timestamp?: string
40
- }
41
-
42
- export interface QueuedAgentResponse {
43
- status: 'queued'
44
- operation_id: string
45
- message: string
46
- sse_endpoint?: string
47
- }
48
-
49
- export class AgentClient {
50
- private sseClient?: SSEClient
51
- private config: {
52
- baseUrl: string
53
- credentials?: 'include' | 'same-origin' | 'omit'
54
- headers?: Record<string, string>
55
- token?: string
56
- }
57
-
58
- constructor(config: {
59
- baseUrl: string
60
- credentials?: 'include' | 'same-origin' | 'omit'
61
- headers?: Record<string, string>
62
- token?: string
63
- }) {
64
- this.config = config
65
- }
66
-
67
- /**
68
- * Execute agent query with automatic agent selection
69
- */
70
- async executeQuery(
71
- graphId: string,
72
- request: AgentQueryRequest,
73
- options: AgentOptions = {}
74
- ): Promise<AgentResult> {
75
- const data: AutoSelectAgentData = {
76
- url: '/v1/graphs/{graph_id}/agent' as const,
77
- path: { graph_id: graphId },
78
- body: {
79
- message: request.message,
80
- history: request.history,
81
- context: request.context,
82
- mode: request.mode,
83
- enable_rag: request.enableRag,
84
- force_extended_analysis: request.forceExtendedAnalysis,
85
- },
86
- }
87
-
88
- const response = await autoSelectAgent(data)
89
- const responseData = response.data as any
90
-
91
- // Check if this is an immediate response (sync execution)
92
- if (responseData?.content !== undefined && responseData?.agent_used) {
93
- return {
94
- content: responseData.content,
95
- agent_used: responseData.agent_used,
96
- mode_used: responseData.mode_used,
97
- metadata: responseData.metadata,
98
- tokens_used: responseData.tokens_used,
99
- confidence_score: responseData.confidence_score,
100
- execution_time: responseData.execution_time,
101
- timestamp: new Date().toISOString(),
102
- }
103
- }
104
-
105
- // Check if this is a queued response (async background task execution)
106
- if (responseData?.operation_id) {
107
- const queuedResponse = responseData as QueuedAgentResponse
108
-
109
- // If user doesn't want to wait, throw with queue info
110
- if (options.maxWait === 0) {
111
- throw new QueuedAgentError(queuedResponse)
112
- }
113
-
114
- // Use SSE to monitor the operation
115
- return this.waitForAgentCompletion(queuedResponse.operation_id, options)
116
- }
117
-
118
- // Unexpected response format
119
- throw new Error('Unexpected response format from agent endpoint')
120
- }
121
-
122
- /**
123
- * Execute specific agent type
124
- */
125
- async executeAgent(
126
- graphId: string,
127
- agentType: string,
128
- request: AgentQueryRequest,
129
- options: AgentOptions = {}
130
- ): Promise<AgentResult> {
131
- const data: ExecuteSpecificAgentData = {
132
- url: '/v1/graphs/{graph_id}/agent/{agent_type}' as const,
133
- path: { graph_id: graphId, agent_type: agentType },
134
- body: {
135
- message: request.message,
136
- history: request.history,
137
- context: request.context,
138
- mode: request.mode,
139
- enable_rag: request.enableRag,
140
- force_extended_analysis: request.forceExtendedAnalysis,
141
- },
142
- }
143
-
144
- const response = await executeSpecificAgent(data)
145
- const responseData = response.data as any
146
-
147
- // Check if this is an immediate response (sync execution)
148
- if (responseData?.content !== undefined && responseData?.agent_used) {
149
- return {
150
- content: responseData.content,
151
- agent_used: responseData.agent_used,
152
- mode_used: responseData.mode_used,
153
- metadata: responseData.metadata,
154
- tokens_used: responseData.tokens_used,
155
- confidence_score: responseData.confidence_score,
156
- execution_time: responseData.execution_time,
157
- timestamp: new Date().toISOString(),
158
- }
159
- }
160
-
161
- // Check if this is a queued response (async background task execution)
162
- if (responseData?.operation_id) {
163
- const queuedResponse = responseData as QueuedAgentResponse
164
-
165
- // If user doesn't want to wait, throw with queue info
166
- if (options.maxWait === 0) {
167
- throw new QueuedAgentError(queuedResponse)
168
- }
169
-
170
- // Use SSE to monitor the operation
171
- return this.waitForAgentCompletion(queuedResponse.operation_id, options)
172
- }
173
-
174
- // Unexpected response format
175
- throw new Error('Unexpected response format from agent endpoint')
176
- }
177
-
178
- private async waitForAgentCompletion(
179
- operationId: string,
180
- options: AgentOptions
181
- ): Promise<AgentResult> {
182
- return new Promise((resolve, reject) => {
183
- const sseClient = new SSEClient(this.config)
184
-
185
- sseClient
186
- .connect(operationId)
187
- .then(() => {
188
- let result: AgentResult | null = null
189
-
190
- // Listen for progress events
191
- sseClient.on(EventType.OPERATION_PROGRESS, (data) => {
192
- options.onProgress?.(data.message, data.progress_percentage)
193
- })
194
-
195
- // Listen for agent-specific events
196
- sseClient.on('agent_started' as EventType, (data) => {
197
- options.onProgress?.(`Agent ${data.agent_type} started`, 0)
198
- })
199
-
200
- sseClient.on('agent_initialized' as EventType, (data) => {
201
- options.onProgress?.(`${data.agent_name} initialized`, 10)
202
- })
203
-
204
- sseClient.on('progress' as EventType, (data) => {
205
- options.onProgress?.(data.message, data.percentage)
206
- })
207
-
208
- sseClient.on('agent_completed' as EventType, (data) => {
209
- result = {
210
- content: data.content,
211
- agent_used: data.agent_used,
212
- mode_used: data.mode_used,
213
- metadata: data.metadata,
214
- tokens_used: data.tokens_used,
215
- confidence_score: data.confidence_score,
216
- execution_time: data.execution_time,
217
- timestamp: data.timestamp || new Date().toISOString(),
218
- }
219
- sseClient.close()
220
- resolve(result)
221
- })
222
-
223
- // Fallback to generic completion event
224
- sseClient.on(EventType.OPERATION_COMPLETED, (data) => {
225
- if (!result) {
226
- const agentResult = data.result || data
227
- result = {
228
- content: agentResult.content || '',
229
- agent_used: agentResult.agent_used || 'unknown',
230
- mode_used: agentResult.mode_used || 'standard',
231
- metadata: agentResult.metadata,
232
- tokens_used: agentResult.tokens_used,
233
- confidence_score: agentResult.confidence_score,
234
- execution_time: agentResult.execution_time,
235
- timestamp: agentResult.timestamp || new Date().toISOString(),
236
- }
237
- sseClient.close()
238
- resolve(result)
239
- }
240
- })
241
-
242
- sseClient.on(EventType.OPERATION_ERROR, (error) => {
243
- sseClient.close()
244
- reject(new Error(error.message || error.error))
245
- })
246
-
247
- sseClient.on(EventType.OPERATION_CANCELLED, () => {
248
- sseClient.close()
249
- reject(new Error('Agent execution cancelled'))
250
- })
251
-
252
- // Handle generic error event
253
- sseClient.on('error' as EventType, (error) => {
254
- sseClient.close()
255
- reject(new Error(error.error || error.message || 'Agent execution failed'))
256
- })
257
- })
258
- .catch(reject)
259
- })
260
- }
261
-
262
- /**
263
- * Convenience method for simple agent queries with auto-selection
264
- */
265
- async query(
266
- graphId: string,
267
- message: string,
268
- context?: Record<string, any>
269
- ): Promise<AgentResult> {
270
- return this.executeQuery(graphId, { message, context }, { mode: 'auto' })
271
- }
272
-
273
- /**
274
- * Execute financial agent for financial analysis
275
- */
276
- async analyzeFinancials(
277
- graphId: string,
278
- message: string,
279
- options: AgentOptions = {}
280
- ): Promise<AgentResult> {
281
- return this.executeAgent(graphId, 'financial', { message }, options)
282
- }
283
-
284
- /**
285
- * Execute research agent for deep research
286
- */
287
- async research(
288
- graphId: string,
289
- message: string,
290
- options: AgentOptions = {}
291
- ): Promise<AgentResult> {
292
- return this.executeAgent(graphId, 'research', { message }, options)
293
- }
294
-
295
- /**
296
- * Execute RAG agent for fast retrieval
297
- */
298
- async rag(graphId: string, message: string, options: AgentOptions = {}): Promise<AgentResult> {
299
- return this.executeAgent(graphId, 'rag', { message }, options)
300
- }
301
-
302
- /**
303
- * Cancel any active SSE connections
304
- */
305
- close(): void {
306
- if (this.sseClient) {
307
- this.sseClient.close()
308
- this.sseClient = undefined
309
- }
310
- }
311
- }
312
-
313
- /**
314
- * Error thrown when agent execution is queued and maxWait is 0
315
- */
316
- export class QueuedAgentError extends Error {
317
- constructor(public queueInfo: QueuedAgentResponse) {
318
- super('Agent execution was queued')
319
- this.name = 'QueuedAgentError'
320
- }
321
- }
@@ -1,242 +0,0 @@
1
- import type { AccountListResponse, AccountRollupsResponse, AccountTreeResponse, ClosingBookStructuresResponse, LedgerSummaryResponse, LedgerTransactionDetailResponse, LedgerTransactionListResponse, MappingDetailResponse, TrialBalanceResponse } from '../sdk/types.gen';
2
- export interface LedgerEntity {
3
- id: string;
4
- name: string;
5
- legalName: string | null;
6
- entityType: string | null;
7
- industry: string | null;
8
- status: string | null;
9
- }
10
- export interface MappingInfo {
11
- id: string;
12
- name: string;
13
- description: string | null;
14
- structureType: string;
15
- taxonomyId: string;
16
- isActive: boolean;
17
- }
18
- export interface MappingCoverage {
19
- totalCoaElements: number;
20
- mappedCount: number;
21
- unmappedCount: number;
22
- coveragePercent: number;
23
- highConfidence: number;
24
- mediumConfidence: number;
25
- lowConfidence: number;
26
- }
27
- export interface Structure {
28
- id: string;
29
- name: string;
30
- structureType: string;
31
- }
32
- export interface Schedule {
33
- structureId: string;
34
- name: string;
35
- taxonomyName: string;
36
- entryTemplate: Record<string, unknown> | null;
37
- scheduleMetadata: Record<string, unknown> | null;
38
- totalPeriods: number;
39
- periodsWithEntries: number;
40
- }
41
- export interface ScheduleCreated {
42
- structureId: string;
43
- name: string;
44
- taxonomyId: string;
45
- totalPeriods: number;
46
- totalFacts: number;
47
- }
48
- export interface ScheduleFact {
49
- elementId: string;
50
- elementName: string;
51
- value: number;
52
- periodStart: string;
53
- periodEnd: string;
54
- }
55
- export interface PeriodCloseItem {
56
- structureId: string;
57
- structureName: string;
58
- amount: number;
59
- status: string;
60
- entryId: string | null;
61
- }
62
- export interface PeriodCloseStatus {
63
- fiscalPeriodStart: string;
64
- fiscalPeriodEnd: string;
65
- periodStatus: string;
66
- schedules: PeriodCloseItem[];
67
- totalDraft: number;
68
- totalPosted: number;
69
- }
70
- export interface ClosingEntry {
71
- entryId: string;
72
- status: string;
73
- postingDate: string;
74
- memo: string;
75
- debitElementId: string;
76
- creditElementId: string;
77
- amount: number;
78
- }
79
- export interface CreateScheduleOptions {
80
- name: string;
81
- elementIds: string[];
82
- periodStart: string;
83
- periodEnd: string;
84
- monthlyAmount: number;
85
- entryTemplate: {
86
- debitElementId: string;
87
- creditElementId: string;
88
- entryType?: string;
89
- memoTemplate?: string;
90
- };
91
- taxonomyId?: string;
92
- scheduleMetadata?: {
93
- method?: string;
94
- originalAmount?: number;
95
- residualValue?: number;
96
- usefulLifeMonths?: number;
97
- assetElementId?: string;
98
- };
99
- }
100
- export declare class LedgerClient {
101
- private config;
102
- constructor(config: {
103
- baseUrl: string;
104
- credentials?: 'include' | 'same-origin' | 'omit';
105
- headers?: Record<string, string>;
106
- token?: string;
107
- });
108
- /**
109
- * Get the entity (company/organization) for this graph.
110
- */
111
- getEntity(graphId: string): Promise<LedgerEntity | null>;
112
- /**
113
- * List accounts (flat).
114
- */
115
- listAccounts(graphId: string): Promise<AccountListResponse>;
116
- /**
117
- * Get the account tree (hierarchical).
118
- */
119
- getAccountTree(graphId: string): Promise<AccountTreeResponse>;
120
- /**
121
- * List transactions with optional date filters.
122
- */
123
- listTransactions(graphId: string, options?: {
124
- startDate?: string;
125
- endDate?: string;
126
- limit?: number;
127
- offset?: number;
128
- }): Promise<LedgerTransactionListResponse>;
129
- /**
130
- * Get transaction detail with entries and line items.
131
- */
132
- getTransaction(graphId: string, transactionId: string): Promise<LedgerTransactionDetailResponse>;
133
- /**
134
- * Get trial balance (CoA-level debits/credits).
135
- */
136
- getTrialBalance(graphId: string, options?: {
137
- startDate?: string;
138
- endDate?: string;
139
- }): Promise<TrialBalanceResponse>;
140
- /**
141
- * Get mapped trial balance (CoA rolled up to GAAP concepts).
142
- */
143
- getMappedTrialBalance(graphId: string, options?: {
144
- mappingId?: string;
145
- startDate?: string;
146
- endDate?: string;
147
- }): Promise<unknown>;
148
- /**
149
- * Get ledger summary (account count, transaction count, date range).
150
- */
151
- getSummary(graphId: string): Promise<LedgerSummaryResponse>;
152
- /**
153
- * Get the reporting taxonomy (US GAAP seed).
154
- */
155
- getReportingTaxonomy(graphId: string): Promise<unknown>;
156
- /**
157
- * List reporting structures (IS, BS, CF) for a taxonomy.
158
- */
159
- listStructures(graphId: string, taxonomyId?: string): Promise<Structure[]>;
160
- /**
161
- * List elements (CoA accounts, GAAP concepts, etc.).
162
- */
163
- listElements(graphId: string, options?: {
164
- taxonomyId?: string;
165
- source?: string;
166
- classification?: string;
167
- isAbstract?: boolean;
168
- limit?: number;
169
- offset?: number;
170
- }): Promise<unknown>;
171
- /**
172
- * Create a new CoA→GAAP mapping structure.
173
- * Returns the created mapping info.
174
- */
175
- createMappingStructure(graphId: string, options?: {
176
- name?: string;
177
- description?: string;
178
- taxonomyId?: string;
179
- }): Promise<MappingInfo>;
180
- /**
181
- * List available CoA→GAAP mapping structures.
182
- */
183
- listMappings(graphId: string): Promise<MappingInfo[]>;
184
- /**
185
- * Get mapping detail — all associations with element names.
186
- */
187
- getMappingDetail(graphId: string, mappingId: string): Promise<MappingDetailResponse>;
188
- /**
189
- * Get mapping coverage — how many CoA elements are mapped.
190
- */
191
- getMappingCoverage(graphId: string, mappingId: string): Promise<MappingCoverage>;
192
- /**
193
- * Create a manual mapping association (CoA element → GAAP element).
194
- */
195
- createMapping(graphId: string, mappingId: string, fromElementId: string, toElementId: string, confidence?: number): Promise<void>;
196
- /**
197
- * Delete a mapping association.
198
- */
199
- deleteMapping(graphId: string, mappingId: string, associationId: string): Promise<void>;
200
- /**
201
- * Trigger AI auto-mapping (MappingAgent).
202
- * Returns immediately — the agent runs in the background.
203
- */
204
- autoMap(graphId: string, mappingId: string): Promise<{
205
- operationId?: string;
206
- }>;
207
- /**
208
- * Create a schedule with pre-generated monthly facts.
209
- */
210
- createSchedule(graphId: string, options: CreateScheduleOptions): Promise<ScheduleCreated>;
211
- /**
212
- * List all schedules for a graph.
213
- */
214
- listSchedules(graphId: string): Promise<Schedule[]>;
215
- /**
216
- * Get facts for a schedule, optionally filtered by period.
217
- */
218
- getScheduleFacts(graphId: string, structureId: string, periodStart?: string, periodEnd?: string): Promise<ScheduleFact[]>;
219
- /**
220
- * Get close status for all schedules in a fiscal period.
221
- */
222
- getPeriodCloseStatus(graphId: string, periodStart: string, periodEnd: string): Promise<PeriodCloseStatus>;
223
- /**
224
- * Create a draft closing entry from a schedule's facts for a period.
225
- */
226
- createClosingEntry(graphId: string, structureId: string, postingDate: string, periodStart: string, periodEnd: string, memo?: string): Promise<ClosingEntry>;
227
- /**
228
- * Get all closing book structure categories for the sidebar.
229
- * Returns statements, account rollups, schedules, trial balance,
230
- * and period close grouped into categories.
231
- */
232
- getClosingBookStructures(graphId: string): Promise<ClosingBookStructuresResponse>;
233
- /**
234
- * Get account rollups — CoA accounts grouped by reporting element with balances.
235
- * Shows how company-specific accounts roll up to standardized reporting lines.
236
- */
237
- getAccountRollups(graphId: string, options?: {
238
- mappingId?: string;
239
- startDate?: string;
240
- endDate?: string;
241
- }): Promise<AccountRollupsResponse>;
242
- }