@robosystems/client 2.38.0 → 2.39.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 (60) hide show
  1. package/README.md +1 -1
  2. package/artifacts/InvestorClient.d.ts +4 -2
  3. package/artifacts/InvestorClient.js +4 -2
  4. package/artifacts/InvestorClient.ts +4 -2
  5. package/artifacts/LedgerClient.d.ts +31 -23
  6. package/artifacts/LedgerClient.js +27 -19
  7. package/artifacts/LedgerClient.ts +34 -26
  8. package/artifacts/LibraryClient.d.ts +4 -4
  9. package/artifacts/LibraryClient.js +4 -4
  10. package/artifacts/LibraryClient.ts +5 -5
  11. package/artifacts/OperatorClient.d.ts +2 -2
  12. package/artifacts/OperatorClient.js +2 -2
  13. package/artifacts/OperatorClient.ts +2 -2
  14. package/artifacts/graphql/queries/ledger/flowCandidates.d.ts +1 -1
  15. package/artifacts/graphql/queries/ledger/flowCandidates.js +1 -1
  16. package/artifacts/graphql/queries/ledger/flowCandidates.ts +1 -1
  17. package/artifacts/graphql/queries/ledger/informationBlock.d.ts +3 -5
  18. package/artifacts/graphql/queries/ledger/informationBlock.js +3 -5
  19. package/artifacts/graphql/queries/ledger/informationBlock.ts +3 -5
  20. package/artifacts/graphql/queries/ledger/mappedTrialBalance.d.ts +1 -1
  21. package/artifacts/graphql/queries/ledger/mappedTrialBalance.js +1 -1
  22. package/artifacts/graphql/queries/ledger/mappedTrialBalance.ts +1 -1
  23. package/artifacts/graphql/queries/ledger/mappingCoverage.d.ts +1 -1
  24. package/artifacts/graphql/queries/ledger/mappingCoverage.js +1 -1
  25. package/artifacts/graphql/queries/ledger/mappingCoverage.ts +1 -1
  26. package/artifacts/graphql/queries/ledger/reportDownloadUrl.d.ts +3 -2
  27. package/artifacts/graphql/queries/ledger/reportDownloadUrl.js +3 -2
  28. package/artifacts/graphql/queries/ledger/reportDownloadUrl.ts +3 -2
  29. package/artifacts/graphql/queries/ledger/reportingTaxonomy.d.ts +3 -3
  30. package/artifacts/graphql/queries/ledger/reportingTaxonomy.js +3 -3
  31. package/artifacts/graphql/queries/ledger/reportingTaxonomy.ts +3 -3
  32. package/artifacts/graphql/queries/ledger/statement.d.ts +5 -4
  33. package/artifacts/graphql/queries/ledger/statement.js +5 -4
  34. package/artifacts/graphql/queries/ledger/statement.ts +5 -4
  35. package/artifacts/graphql/queries/ledger/structures.d.ts +1 -1
  36. package/artifacts/graphql/queries/ledger/structures.js +1 -1
  37. package/artifacts/graphql/queries/ledger/structures.ts +1 -1
  38. package/artifacts/graphql/queries/ledger/unmappedElements.d.ts +1 -1
  39. package/artifacts/graphql/queries/ledger/unmappedElements.js +1 -1
  40. package/artifacts/graphql/queries/ledger/unmappedElements.ts +1 -1
  41. package/artifacts/graphql/queries/library/arcs.d.ts +1 -1
  42. package/artifacts/graphql/queries/library/arcs.js +1 -1
  43. package/artifacts/graphql/queries/library/arcs.ts +1 -1
  44. package/artifacts/graphql/queries/library/elements.d.ts +1 -1
  45. package/artifacts/graphql/queries/library/elements.js +1 -1
  46. package/artifacts/graphql/queries/library/elements.ts +1 -1
  47. package/artifacts/hooks.d.ts +8 -8
  48. package/artifacts/hooks.js +8 -8
  49. package/artifacts/hooks.ts +8 -8
  50. package/package.json +2 -2
  51. package/sdk/sdk.gen.d.ts +13 -13
  52. package/sdk/sdk.gen.js +13 -13
  53. package/sdk/sdk.gen.ts +13 -13
  54. package/sdk/types.gen.d.ts +76 -67
  55. package/sdk/types.gen.ts +76 -67
  56. package/sdk.gen.d.ts +13 -13
  57. package/sdk.gen.js +13 -13
  58. package/sdk.gen.ts +13 -13
  59. package/types.gen.d.ts +76 -67
  60. package/types.gen.ts +76 -67
package/README.md CHANGED
@@ -3,7 +3,7 @@
3
3
  [![npm version](https://badge.fury.io/js/@robosystems%2Fclient.svg)](https://www.npmjs.com/package/@robosystems/client)
4
4
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5
5
 
6
- Official TypeScript client for the RoboSystems financial intelligence platform — accounting, financial reporting, and investment management over a knowledge graph API. Type-safe and modern, generated from the OpenAPI spec, with GraphQL reads and idempotent operation writes.
6
+ Part of RoboSystems, the open-source knowledge graph for finance. The official TypeScript client for the RoboSystems API: accounting, financial reporting, and investment management over the graph. Type-safe and modern, generated from the OpenAPI spec, with GraphQL reads and idempotent operation writes.
7
7
 
8
8
  ## Features
9
9
 
@@ -91,8 +91,10 @@ export declare class InvestorClient {
91
91
  /** Get a single security by id. Returns null if it doesn't exist. */
92
92
  getSecurity(graphId: string, securityId: string): Promise<InvestorSecurity | null>;
93
93
  /**
94
- * Create a new security. Passing `source_graph_id` auto-links to the
95
- * matching entity in the target graph.
94
+ * Create a new security. `entity_id` is the issuer. Without one,
95
+ * `source_graph_id` (the issuer's own graph) links the security to the
96
+ * entity this graph already holds for that graph, or, when there is none
97
+ * yet, once a report shared from it arrives.
96
98
  */
97
99
  createSecurity(graphId: string, body: CreateSecurityRequest): Promise<InvestorSecurity>;
98
100
  /** Update a security's metadata. Only provided fields are applied. */
@@ -86,8 +86,10 @@ class InvestorClient {
86
86
  return this.gqlQuery(graphId, graphql_1.GetInvestorSecurityDocument, { securityId }, 'Get security', (data) => data.security);
87
87
  }
88
88
  /**
89
- * Create a new security. Passing `source_graph_id` auto-links to the
90
- * matching entity in the target graph.
89
+ * Create a new security. `entity_id` is the issuer. Without one,
90
+ * `source_graph_id` (the issuer's own graph) links the security to the
91
+ * entity this graph already holds for that graph, or, when there is none
92
+ * yet, once a report shared from it arrives.
91
93
  */
92
94
  async createSecurity(graphId, body) {
93
95
  const envelope = await this.callOperation('Create security', (o) => (0, sdk_gen_1.createSecurity)({ ...o, path: { graph_id: graphId }, body }));
@@ -269,8 +269,10 @@ export class InvestorClient {
269
269
  }
270
270
 
271
271
  /**
272
- * Create a new security. Passing `source_graph_id` auto-links to the
273
- * matching entity in the target graph.
272
+ * Create a new security. `entity_id` is the issuer. Without one,
273
+ * `source_graph_id` (the issuer's own graph) links the security to the
274
+ * entity this graph already holds for that graph, or, when there is none
275
+ * yet, once a report shared from it arrives.
274
276
  */
275
277
  async createSecurity(graphId: string, body: CreateSecurityRequest): Promise<InvestorSecurity> {
276
278
  const envelope = await this.callOperation('Create security', (o) =>
@@ -171,7 +171,7 @@ export interface ClosePeriodResult {
171
171
  targetAutoAdvanced: boolean;
172
172
  fiscalCalendar: LedgerFiscalCalendar;
173
173
  /**
174
- * §3.8 — aggregated rule-eval outcome across every schedule Structure
174
+ * Aggregated rule-eval outcome across every schedule Structure
175
175
  * with facts in the closed period. Keys: `pass` / `fail` / `error` /
176
176
  * `skipped`. `null` when no schedules had facts in the period.
177
177
  */
@@ -205,7 +205,7 @@ export interface ScheduleCreated {
205
205
  totalPeriods: number;
206
206
  totalFacts: number;
207
207
  /**
208
- * §3.8 — populated when create_schedule (or update_schedule on a
208
+ * Populated when create_schedule (or update_schedule on a
209
209
  * template change) re-runs the rule engine. Keys: `pass` / `fail` /
210
210
  * `error` / `skipped`. `null` when no rules were re-evaluated.
211
211
  */
@@ -581,9 +581,9 @@ export interface CreateJournalEntryOptions {
581
581
  transactionId?: string | null;
582
582
  /**
583
583
  * Who fired the event. Defaults to `'manual'` (user-initiated journal
584
- * entry). Sync adapters (QuickBooks, Plaid, etc.) override with their
585
- * adapter name. Must match the server's CHECK constraint set:
586
- * `manual | schedule | system | quickbooks | xero | plaid`.
584
+ * entry). Otherwise `system`, `schedule`, a connected provider's name
585
+ * (e.g. `quickbooks`), or a source name registered through an `external`
586
+ * connection; the server validates it against the graph's connections.
587
587
  */
588
588
  source?: string;
589
589
  idempotencyKey?: string | null;
@@ -955,8 +955,8 @@ export declare class LedgerClient {
955
955
  /** Delete a mapping association. */
956
956
  deleteMappingAssociation(graphId: string, body: DeleteMappingAssociationOperation): Promise<DeleteResult>;
957
957
  /**
958
- * Trigger the AI MappingAgent. Returns the operation id — async; the
959
- * agent runs in the background. Consumers can subscribe to progress
958
+ * Trigger the AI mapping operator. Returns the operation id — async; the
959
+ * operator runs in the background. Consumers can subscribe to progress
960
960
  * via `/v1/operations/{operationId}/stream`.
961
961
  */
962
962
  autoMapElements(graphId: string, body: AutoMapElementsOperation): Promise<{
@@ -966,7 +966,7 @@ export declare class LedgerClient {
966
966
  /**
967
967
  * Fetch an Information Block envelope by id — the generic
968
968
  * cross-block-type read. Returns `null` when the block doesn't exist
969
- * (or its type isn't registered). See `information-block.md`.
969
+ * (or its type isn't registered).
970
970
  *
971
971
  * `options.scenarioId` selects the FactSet slice: omitted = actuals;
972
972
  * a forecast block's structure id = that scenario's parallel universe
@@ -1041,10 +1041,11 @@ export declare class LedgerClient {
1041
1041
  *
1042
1042
  * Generic wrapper over `create-information-block`. Pass a typed
1043
1043
  * `CreateInformationBlockRequest` body — the discriminator routes
1044
- * server-side to the correct dispatch handler. Convenience methods
1045
- * exist for specific block types (e.g. `createSchedule`); for
1046
- * block types without one (currently `rollforward`), use this
1047
- * generic entry.
1044
+ * server-side to the correct dispatch handler. It creates `schedule`
1045
+ * blocks (also `createSchedule`) and `forecast` blocks; every other
1046
+ * block type is built by its own operation (statements by
1047
+ * `createReport`, reconciliations by `refreshReconciliations`), and
1048
+ * naming one here returns 501 with a hint naming that operation.
1048
1049
  */
1049
1050
  createInformationBlock(graphId: string, body: CreateInformationBlockRequest, options?: {
1050
1051
  idempotencyKey?: string;
@@ -1440,10 +1441,15 @@ export declare class LedgerClient {
1440
1441
  */
1441
1442
  updateEventHandler(graphId: string, body: UpdateEventHandlerRequest): Promise<EventHandlerResponse>;
1442
1443
  /**
1443
- * Live financial statement — pulls facts directly from the graph for
1444
- * an explicit period window (or fiscal year) and returns the statement
1445
- * shape without a persisted Report row. Useful for ad-hoc previews and
1446
- * dashboards.
1444
+ * Live financial statement — rendered from the ledger (the extensions
1445
+ * database, no graph materialization) for an explicit period window (or
1446
+ * fiscal year), without a persisted Report row. Useful for ad-hoc
1447
+ * previews and dashboards. `scope` is `entity` (one entity's books, the
1448
+ * default), `combined` (on the group parent, every member consolidated in
1449
+ * full, summed) or `consolidated` (that sum plus the consolidation
1450
+ * entity's eliminations and noncontrolling interest); `consolidated: true`
1451
+ * is the older spelling of `scope: 'consolidated'`. Refused on shared
1452
+ * repositories, which use `financialStatementAnalysis`.
1447
1453
  */
1448
1454
  liveFinancialStatement(graphId: string, body: LiveFinancialStatementRequest): Promise<LiveFinancialStatementResponse>;
1449
1455
  /**
@@ -1461,10 +1467,11 @@ export declare class LedgerClient {
1461
1467
  */
1462
1468
  previewConsolidationEntries(graphId: string, period: string): Promise<PreviewConsolidationEntriesResponse>;
1463
1469
  /**
1464
- * Run a financial statement analysis against an existing report.
1465
- * On shared-repo graphs (e.g. SEC), `ticker` is required; on tenant
1466
- * graphs it's ignored. Either pass an explicit `report_id` or let the
1467
- * server auto-resolve via `fiscal_year` + `period_type`.
1470
+ * Read a rendered statement from the graph (Structure → FactSet → Fact).
1471
+ * On shared-repo graphs (e.g. SEC), pass `ticker` and the server resolves
1472
+ * the latest filing, narrowed by `fiscal_year` + `period_type`, or pass a
1473
+ * `report_id`. On tenant graphs `report_id` is required and the ledger
1474
+ * must have been materialized to the graph.
1468
1475
  */
1469
1476
  financialStatementAnalysis(graphId: string, body: FinancialStatementAnalysisRequest): Promise<FinancialStatementAnalysisResponse>;
1470
1477
  /**
@@ -1526,8 +1533,9 @@ export declare class LedgerClient {
1526
1533
  * A download is a read, so this resolves through GraphQL
1527
1534
  * (`reportDownloadUrl`) — the retired `GET .../reports/{id}/download`
1528
1535
  * REST resource is gone. Every flavor resolves to a presigned S3 URL:
1529
- * the Tavi model is stamped at publish time; the holon and XBRL are
1530
- * materialized + cached on first request. The returned `downloadUrl` is valid for
1536
+ * the holon is stamped at publish time; the Tavi model, the XBRL and the
1537
+ * holon with lineage are materialized + cached on first request. The
1538
+ * returned `downloadUrl` is valid for
1531
1539
  * `expiresIn` seconds (default 300, max 3600); browser callers
1532
1540
  * navigate to it via `window.location.href` (or an `<a href>` click)
1533
1541
  * to trigger the download — the server-set Content-Disposition forces
@@ -1543,7 +1551,7 @@ export declare class LedgerClient {
1543
1551
  * holon, which carries the whole report), `HOLON_JSONLD_LINEAGE` (the
1544
1552
  * holon with its `#lineage` graph: the ledger lines, entries and events
1545
1553
  * behind every frozen figure, for this graph's own members), `TAVI` (the
1546
- * Project Tavi compiled model stamped at publish), or `XBRL_2_1`.
1554
+ * Project Tavi compiled model), or `XBRL_2_1`.
1547
1555
  * @param options.expiresIn Presigned URL lifetime, in seconds.
1548
1556
  */
1549
1557
  getReportDownloadUrl(graphId: string, reportId: string, options?: {
@@ -512,8 +512,8 @@ class LedgerClient {
512
512
  return (envelope.result ?? { deleted: true });
513
513
  }
514
514
  /**
515
- * Trigger the AI MappingAgent. Returns the operation id — async; the
516
- * agent runs in the background. Consumers can subscribe to progress
515
+ * Trigger the AI mapping operator. Returns the operation id — async; the
516
+ * operator runs in the background. Consumers can subscribe to progress
517
517
  * via `/v1/operations/{operationId}/stream`.
518
518
  */
519
519
  async autoMapElements(graphId, body) {
@@ -524,7 +524,7 @@ class LedgerClient {
524
524
  /**
525
525
  * Fetch an Information Block envelope by id — the generic
526
526
  * cross-block-type read. Returns `null` when the block doesn't exist
527
- * (or its type isn't registered). See `information-block.md`.
527
+ * (or its type isn't registered).
528
528
  *
529
529
  * `options.scenarioId` selects the FactSet slice: omitted = actuals;
530
530
  * a forecast block's structure id = that scenario's parallel universe
@@ -618,10 +618,11 @@ class LedgerClient {
618
618
  *
619
619
  * Generic wrapper over `create-information-block`. Pass a typed
620
620
  * `CreateInformationBlockRequest` body — the discriminator routes
621
- * server-side to the correct dispatch handler. Convenience methods
622
- * exist for specific block types (e.g. `createSchedule`); for
623
- * block types without one (currently `rollforward`), use this
624
- * generic entry.
621
+ * server-side to the correct dispatch handler. It creates `schedule`
622
+ * blocks (also `createSchedule`) and `forecast` blocks; every other
623
+ * block type is built by its own operation (statements by
624
+ * `createReport`, reconciliations by `refreshReconciliations`), and
625
+ * naming one here returns 501 with a hint naming that operation.
625
626
  */
626
627
  async createInformationBlock(graphId, body, options) {
627
628
  const envelope = await this.callOperation('Create information block', (o) => (0, sdk_gen_1.createInformationBlock)({
@@ -1434,12 +1435,17 @@ class LedgerClient {
1434
1435
  const envelope = await this.callOperation('Update event handler', (o) => (0, sdk_gen_1.updateEventHandler)({ ...o, path: { graph_id: graphId }, body }));
1435
1436
  return this.requireResult('Update event handler', envelope.result);
1436
1437
  }
1437
- // ── Financial statements (graph-backed) ──────────────────────────────
1438
+ // ── Financial statements ─────────────────────────────────────────────
1438
1439
  /**
1439
- * Live financial statement — pulls facts directly from the graph for
1440
- * an explicit period window (or fiscal year) and returns the statement
1441
- * shape without a persisted Report row. Useful for ad-hoc previews and
1442
- * dashboards.
1440
+ * Live financial statement — rendered from the ledger (the extensions
1441
+ * database, no graph materialization) for an explicit period window (or
1442
+ * fiscal year), without a persisted Report row. Useful for ad-hoc
1443
+ * previews and dashboards. `scope` is `entity` (one entity's books, the
1444
+ * default), `combined` (on the group parent, every member consolidated in
1445
+ * full, summed) or `consolidated` (that sum plus the consolidation
1446
+ * entity's eliminations and noncontrolling interest); `consolidated: true`
1447
+ * is the older spelling of `scope: 'consolidated'`. Refused on shared
1448
+ * repositories, which use `financialStatementAnalysis`.
1443
1449
  */
1444
1450
  async liveFinancialStatement(graphId, body) {
1445
1451
  const envelope = await this.callOperation('Live financial statement', (o) => (0, sdk_gen_1.liveFinancialStatement)({ ...o, path: { graph_id: graphId }, body }));
@@ -1466,10 +1472,11 @@ class LedgerClient {
1466
1472
  return this.requireResult('Preview consolidation entries', envelope.result);
1467
1473
  }
1468
1474
  /**
1469
- * Run a financial statement analysis against an existing report.
1470
- * On shared-repo graphs (e.g. SEC), `ticker` is required; on tenant
1471
- * graphs it's ignored. Either pass an explicit `report_id` or let the
1472
- * server auto-resolve via `fiscal_year` + `period_type`.
1475
+ * Read a rendered statement from the graph (Structure → FactSet → Fact).
1476
+ * On shared-repo graphs (e.g. SEC), pass `ticker` and the server resolves
1477
+ * the latest filing, narrowed by `fiscal_year` + `period_type`, or pass a
1478
+ * `report_id`. On tenant graphs `report_id` is required and the ledger
1479
+ * must have been materialized to the graph.
1473
1480
  */
1474
1481
  async financialStatementAnalysis(graphId, body) {
1475
1482
  const envelope = await this.callOperation('Financial statement analysis', (o) => (0, sdk_gen_1.financialStatementAnalysis)({ ...o, path: { graph_id: graphId }, body }));
@@ -1598,8 +1605,9 @@ class LedgerClient {
1598
1605
  * A download is a read, so this resolves through GraphQL
1599
1606
  * (`reportDownloadUrl`) — the retired `GET .../reports/{id}/download`
1600
1607
  * REST resource is gone. Every flavor resolves to a presigned S3 URL:
1601
- * the Tavi model is stamped at publish time; the holon and XBRL are
1602
- * materialized + cached on first request. The returned `downloadUrl` is valid for
1608
+ * the holon is stamped at publish time; the Tavi model, the XBRL and the
1609
+ * holon with lineage are materialized + cached on first request. The
1610
+ * returned `downloadUrl` is valid for
1603
1611
  * `expiresIn` seconds (default 300, max 3600); browser callers
1604
1612
  * navigate to it via `window.location.href` (or an `<a href>` click)
1605
1613
  * to trigger the download — the server-set Content-Disposition forces
@@ -1615,7 +1623,7 @@ class LedgerClient {
1615
1623
  * holon, which carries the whole report), `HOLON_JSONLD_LINEAGE` (the
1616
1624
  * holon with its `#lineage` graph: the ledger lines, entries and events
1617
1625
  * behind every frozen figure, for this graph's own members), `TAVI` (the
1618
- * Project Tavi compiled model stamped at publish), or `XBRL_2_1`.
1626
+ * Project Tavi compiled model), or `XBRL_2_1`.
1619
1627
  * @param options.expiresIn Presigned URL lifetime, in seconds.
1620
1628
  */
1621
1629
  async getReportDownloadUrl(graphId, reportId, options = {}) {
@@ -619,7 +619,7 @@ interface RawClosePeriodResult {
619
619
  entries_posted_locally?: number
620
620
  target_auto_advanced: boolean
621
621
  fiscal_calendar: RawFiscalCalendar
622
- // §3.8 — auto-run rules on close. `null` when no schedules with facts
622
+ // Auto-run rules on close. `null` when no schedules with facts
623
623
  // in the period had rules attached. Otherwise a status-keyed tally.
624
624
  rule_summary?: Record<string, number> | null
625
625
  // ids of schedule Structures whose rules were evaluated during the
@@ -633,7 +633,7 @@ interface RawScheduleCreatedResult {
633
633
  taxonomy_id: string
634
634
  total_periods: number
635
635
  total_facts: number
636
- // §3.8 — populated when create_schedule (or update_schedule on a
636
+ // Populated when create_schedule (or update_schedule on a
637
637
  // template change) re-runs the rule engine. Otherwise null.
638
638
  rule_summary?: Record<string, number> | null
639
639
  }
@@ -660,7 +660,7 @@ export interface ClosePeriodResult {
660
660
  targetAutoAdvanced: boolean
661
661
  fiscalCalendar: LedgerFiscalCalendar
662
662
  /**
663
- * §3.8 — aggregated rule-eval outcome across every schedule Structure
663
+ * Aggregated rule-eval outcome across every schedule Structure
664
664
  * with facts in the closed period. Keys: `pass` / `fail` / `error` /
665
665
  * `skipped`. `null` when no schedules had facts in the period.
666
666
  */
@@ -696,7 +696,7 @@ export interface ScheduleCreated {
696
696
  totalPeriods: number
697
697
  totalFacts: number
698
698
  /**
699
- * §3.8 — populated when create_schedule (or update_schedule on a
699
+ * Populated when create_schedule (or update_schedule on a
700
700
  * template change) re-runs the rule engine. Keys: `pass` / `fail` /
701
701
  * `error` / `skipped`. `null` when no rules were re-evaluated.
702
702
  */
@@ -1160,9 +1160,9 @@ export interface CreateJournalEntryOptions {
1160
1160
  transactionId?: string | null
1161
1161
  /**
1162
1162
  * Who fired the event. Defaults to `'manual'` (user-initiated journal
1163
- * entry). Sync adapters (QuickBooks, Plaid, etc.) override with their
1164
- * adapter name. Must match the server's CHECK constraint set:
1165
- * `manual | schedule | system | quickbooks | xero | plaid`.
1163
+ * entry). Otherwise `system`, `schedule`, a connected provider's name
1164
+ * (e.g. `quickbooks`), or a source name registered through an `external`
1165
+ * connection; the server validates it against the graph's connections.
1166
1166
  */
1167
1167
  source?: string
1168
1168
  idempotencyKey?: string | null
@@ -2115,8 +2115,8 @@ export class LedgerClient {
2115
2115
  }
2116
2116
 
2117
2117
  /**
2118
- * Trigger the AI MappingAgent. Returns the operation id — async; the
2119
- * agent runs in the background. Consumers can subscribe to progress
2118
+ * Trigger the AI mapping operator. Returns the operation id — async; the
2119
+ * operator runs in the background. Consumers can subscribe to progress
2120
2120
  * via `/v1/operations/{operationId}/stream`.
2121
2121
  */
2122
2122
  async autoMapElements(
@@ -2134,7 +2134,7 @@ export class LedgerClient {
2134
2134
  /**
2135
2135
  * Fetch an Information Block envelope by id — the generic
2136
2136
  * cross-block-type read. Returns `null` when the block doesn't exist
2137
- * (or its type isn't registered). See `information-block.md`.
2137
+ * (or its type isn't registered).
2138
2138
  *
2139
2139
  * `options.scenarioId` selects the FactSet slice: omitted = actuals;
2140
2140
  * a forecast block's structure id = that scenario's parallel universe
@@ -2286,10 +2286,11 @@ export class LedgerClient {
2286
2286
  *
2287
2287
  * Generic wrapper over `create-information-block`. Pass a typed
2288
2288
  * `CreateInformationBlockRequest` body — the discriminator routes
2289
- * server-side to the correct dispatch handler. Convenience methods
2290
- * exist for specific block types (e.g. `createSchedule`); for
2291
- * block types without one (currently `rollforward`), use this
2292
- * generic entry.
2289
+ * server-side to the correct dispatch handler. It creates `schedule`
2290
+ * blocks (also `createSchedule`) and `forecast` blocks; every other
2291
+ * block type is built by its own operation (statements by
2292
+ * `createReport`, reconciliations by `refreshReconciliations`), and
2293
+ * naming one here returns 501 with a hint naming that operation.
2293
2294
  */
2294
2295
  async createInformationBlock(
2295
2296
  graphId: string,
@@ -3527,13 +3528,18 @@ export class LedgerClient {
3527
3528
  return this.requireResult('Update event handler', envelope.result)
3528
3529
  }
3529
3530
 
3530
- // ── Financial statements (graph-backed) ──────────────────────────────
3531
+ // ── Financial statements ─────────────────────────────────────────────
3531
3532
 
3532
3533
  /**
3533
- * Live financial statement — pulls facts directly from the graph for
3534
- * an explicit period window (or fiscal year) and returns the statement
3535
- * shape without a persisted Report row. Useful for ad-hoc previews and
3536
- * dashboards.
3534
+ * Live financial statement — rendered from the ledger (the extensions
3535
+ * database, no graph materialization) for an explicit period window (or
3536
+ * fiscal year), without a persisted Report row. Useful for ad-hoc
3537
+ * previews and dashboards. `scope` is `entity` (one entity's books, the
3538
+ * default), `combined` (on the group parent, every member consolidated in
3539
+ * full, summed) or `consolidated` (that sum plus the consolidation
3540
+ * entity's eliminations and noncontrolling interest); `consolidated: true`
3541
+ * is the older spelling of `scope: 'consolidated'`. Refused on shared
3542
+ * repositories, which use `financialStatementAnalysis`.
3537
3543
  */
3538
3544
  async liveFinancialStatement(
3539
3545
  graphId: string,
@@ -3578,10 +3584,11 @@ export class LedgerClient {
3578
3584
  }
3579
3585
 
3580
3586
  /**
3581
- * Run a financial statement analysis against an existing report.
3582
- * On shared-repo graphs (e.g. SEC), `ticker` is required; on tenant
3583
- * graphs it's ignored. Either pass an explicit `report_id` or let the
3584
- * server auto-resolve via `fiscal_year` + `period_type`.
3587
+ * Read a rendered statement from the graph (Structure → FactSet → Fact).
3588
+ * On shared-repo graphs (e.g. SEC), pass `ticker` and the server resolves
3589
+ * the latest filing, narrowed by `fiscal_year` + `period_type`, or pass a
3590
+ * `report_id`. On tenant graphs `report_id` is required and the ledger
3591
+ * must have been materialized to the graph.
3585
3592
  */
3586
3593
  async financialStatementAnalysis(
3587
3594
  graphId: string,
@@ -3779,8 +3786,9 @@ export class LedgerClient {
3779
3786
  * A download is a read, so this resolves through GraphQL
3780
3787
  * (`reportDownloadUrl`) — the retired `GET .../reports/{id}/download`
3781
3788
  * REST resource is gone. Every flavor resolves to a presigned S3 URL:
3782
- * the Tavi model is stamped at publish time; the holon and XBRL are
3783
- * materialized + cached on first request. The returned `downloadUrl` is valid for
3789
+ * the holon is stamped at publish time; the Tavi model, the XBRL and the
3790
+ * holon with lineage are materialized + cached on first request. The
3791
+ * returned `downloadUrl` is valid for
3784
3792
  * `expiresIn` seconds (default 300, max 3600); browser callers
3785
3793
  * navigate to it via `window.location.href` (or an `<a href>` click)
3786
3794
  * to trigger the download — the server-set Content-Disposition forces
@@ -3796,7 +3804,7 @@ export class LedgerClient {
3796
3804
  * holon, which carries the whole report), `HOLON_JSONLD_LINEAGE` (the
3797
3805
  * holon with its `#lineage` graph: the ledger lines, entries and events
3798
3806
  * behind every frozen figure, for this graph's own members), `TAVI` (the
3799
- * Project Tavi compiled model stamped at publish), or `XBRL_2_1`.
3807
+ * Project Tavi compiled model), or `XBRL_2_1`.
3800
3808
  * @param options.expiresIn Presigned URL lifetime, in seconds.
3801
3809
  */
3802
3810
  async getReportDownloadUrl(
@@ -86,8 +86,8 @@ export declare class LibraryClient {
86
86
  /**
87
87
  * List every taxonomy visible at this graph_id.
88
88
  *
89
- * On the `"library"` sentinel this is the canonical set (sfac6,
90
- * fac, rs-gaap, …). On a tenant graph_id this also includes the
89
+ * On the `"library"` sentinel this is the canonical set (fac, cm,
90
+ * rs-gaap, …). On a tenant graph_id this also includes the
91
91
  * tenant's own CoA and any custom taxonomies they've created.
92
92
  */
93
93
  listLibraryTaxonomies(graphId: string, options?: {
@@ -116,8 +116,8 @@ export declare class LibraryClient {
116
116
  getLibraryElement(graphId: string, identifier: GetLibraryElementIdentifier): Promise<LibraryElementDetail | null>;
117
117
  /**
118
118
  * All arcs contributed by a taxonomy, plus their total count, in one
119
- * round-trip. For mapping taxonomies (fac-to-rs-gaap, sfac6-to-fac,
120
- * type-subtype) this is the primary browse view.
119
+ * round-trip. For mapping taxonomies (fac-to-rs-gaap,
120
+ * rs-gaap-type-subtype, rs-gaap-calculations) this is the primary browse view.
121
121
  */
122
122
  listLibraryTaxonomyArcs(graphId: string, taxonomyId: string, options?: ListLibraryTaxonomyArcsOptions): Promise<ListLibraryTaxonomyArcsResult>;
123
123
  /**
@@ -25,8 +25,8 @@ class LibraryClient {
25
25
  /**
26
26
  * List every taxonomy visible at this graph_id.
27
27
  *
28
- * On the `"library"` sentinel this is the canonical set (sfac6,
29
- * fac, rs-gaap, …). On a tenant graph_id this also includes the
28
+ * On the `"library"` sentinel this is the canonical set (fac, cm,
29
+ * rs-gaap, …). On a tenant graph_id this also includes the
30
30
  * tenant's own CoA and any custom taxonomies they've created.
31
31
  */
32
32
  async listLibraryTaxonomies(graphId, options) {
@@ -84,8 +84,8 @@ class LibraryClient {
84
84
  // ── Arcs / Equivalence ──────────────────────────────────────────────
85
85
  /**
86
86
  * All arcs contributed by a taxonomy, plus their total count, in one
87
- * round-trip. For mapping taxonomies (fac-to-rs-gaap, sfac6-to-fac,
88
- * type-subtype) this is the primary browse view.
87
+ * round-trip. For mapping taxonomies (fac-to-rs-gaap,
88
+ * rs-gaap-type-subtype, rs-gaap-calculations) this is the primary browse view.
89
89
  */
90
90
  async listLibraryTaxonomyArcs(graphId, taxonomyId, options) {
91
91
  return this.gqlQuery(graphId, graphql_1.ListLibraryTaxonomyArcsDocument, {
@@ -4,7 +4,7 @@
4
4
  * Library Client for RoboSystems API
5
5
  *
6
6
  * Read-only facade for the taxonomy library — the shared reference
7
- * material (sfac6, fac, rs-gaap, …, mapping taxonomies) that lives
7
+ * material (fac, cm, rs-gaap and its packages, the mapping bridges) that lives
8
8
  * in the extensions DB public schema.
9
9
  *
10
10
  * **Two access modes** — picked by the caller's `graphId`:
@@ -173,8 +173,8 @@ export class LibraryClient {
173
173
  /**
174
174
  * List every taxonomy visible at this graph_id.
175
175
  *
176
- * On the `"library"` sentinel this is the canonical set (sfac6,
177
- * fac, rs-gaap, …). On a tenant graph_id this also includes the
176
+ * On the `"library"` sentinel this is the canonical set (fac, cm,
177
+ * rs-gaap, …). On a tenant graph_id this also includes the
178
178
  * tenant's own CoA and any custom taxonomies they've created.
179
179
  */
180
180
  async listLibraryTaxonomies(
@@ -286,8 +286,8 @@ export class LibraryClient {
286
286
 
287
287
  /**
288
288
  * All arcs contributed by a taxonomy, plus their total count, in one
289
- * round-trip. For mapping taxonomies (fac-to-rs-gaap, sfac6-to-fac,
290
- * type-subtype) this is the primary browse view.
289
+ * round-trip. For mapping taxonomies (fac-to-rs-gaap,
290
+ * rs-gaap-type-subtype, rs-gaap-calculations) this is the primary browse view.
291
291
  */
292
292
  async listLibraryTaxonomyArcs(
293
293
  graphId: string,
@@ -110,7 +110,7 @@ export declare class OperatorClient {
110
110
  */
111
111
  private pollForCompletion;
112
112
  /**
113
- * Convenience method for simple agent queries with auto-selection
113
+ * Convenience method for simple operator queries with auto-selection
114
114
  */
115
115
  query(graphId: string, message: string, context?: Record<string, any>): Promise<OperatorResult>;
116
116
  /**
@@ -129,7 +129,7 @@ export declare class OperatorRunError extends Error {
129
129
  constructor(message: string, status: 'failed' | 'cancelled', writes: Record<string, any>[]);
130
130
  }
131
131
  /**
132
- * Error thrown when agent execution is queued and maxWait is 0
132
+ * Error thrown when an operator run is queued and maxWait is 0
133
133
  */
134
134
  export declare class QueuedOperatorError extends Error {
135
135
  queueInfo: QueuedOperatorResponse;
@@ -316,7 +316,7 @@ class OperatorClient {
316
316
  }
317
317
  }
318
318
  /**
319
- * Convenience method for simple agent queries with auto-selection
319
+ * Convenience method for simple operator queries with auto-selection
320
320
  */
321
321
  async query(graphId, message, context) {
322
322
  return this.executeQuery(graphId, { message, context }, { mode: 'auto' });
@@ -356,7 +356,7 @@ const readWrites = (source) => {
356
356
  : [];
357
357
  };
358
358
  /**
359
- * Error thrown when agent execution is queued and maxWait is 0
359
+ * Error thrown when an operator run is queued and maxWait is 0
360
360
  */
361
361
  class QueuedOperatorError extends Error {
362
362
  constructor(queueInfo) {
@@ -471,7 +471,7 @@ export class OperatorClient {
471
471
  }
472
472
 
473
473
  /**
474
- * Convenience method for simple agent queries with auto-selection
474
+ * Convenience method for simple operator queries with auto-selection
475
475
  */
476
476
  async query(
477
477
  graphId: string,
@@ -519,7 +519,7 @@ const readWrites = (source: unknown): Record<string, any>[] => {
519
519
  }
520
520
 
521
521
  /**
522
- * Error thrown when agent execution is queued and maxWait is 0
522
+ * Error thrown when an operator run is queued and maxWait is 0
523
523
  */
524
524
  export class QueuedOperatorError extends Error {
525
525
  constructor(public queueInfo: QueuedOperatorResponse) {
@@ -3,7 +3,7 @@
3
3
  * classification beside the account: it overrides the account's default flow
4
4
  * on the cash flow and equity statements (a bank line's
5
5
  * `classified_flow_qname`, a journal-entry line's
6
- * `transaction_description_code`). These are the leaf investing and financing
6
+ * `flow_qname`). These are the leaf investing and financing
7
7
  * rows of the entity's cash flow statement under its Reporting Style
8
8
  * (`$entityId`, default the group parent) — the set the write path accepts —
9
9
  * so a picker built from them never offers a row the statement cannot
@@ -7,7 +7,7 @@ const graphql_request_1 = require("graphql-request");
7
7
  * classification beside the account: it overrides the account's default flow
8
8
  * on the cash flow and equity statements (a bank line's
9
9
  * `classified_flow_qname`, a journal-entry line's
10
- * `transaction_description_code`). These are the leaf investing and financing
10
+ * `flow_qname`). These are the leaf investing and financing
11
11
  * rows of the entity's cash flow statement under its Reporting Style
12
12
  * (`$entityId`, default the group parent) — the set the write path accepts —
13
13
  * so a picker built from them never offers a row the statement cannot
@@ -5,7 +5,7 @@ import { gql } from 'graphql-request'
5
5
  * classification beside the account: it overrides the account's default flow
6
6
  * on the cash flow and equity statements (a bank line's
7
7
  * `classified_flow_qname`, a journal-entry line's
8
- * `transaction_description_code`). These are the leaf investing and financing
8
+ * `flow_qname`). These are the leaf investing and financing
9
9
  * rows of the entity's cash flow statement under its Reporting Style
10
10
  * (`$entityId`, default the group parent) — the set the write path accepts —
11
11
  * so a picker built from them never offers a row the statement cannot
@@ -1,9 +1,7 @@
1
1
  /**
2
- * Information Block envelope — the cross-block-type read that replaces
3
- * block-specific reads like `scheduleFacts` and (eventually)
4
- * `statement`. Returns the assembled envelope with bundled atoms
5
- * (elements, connections, facts) plus the typed artifact mechanics
6
- * branch. See `local/docs/specs/information-block.md` §2.
2
+ * Information Block envelope — the read shared by every block type.
3
+ * Returns the assembled envelope with bundled atoms (elements,
4
+ * connections, facts) plus the typed artifact mechanics branch.
7
5
  */
8
6
  export declare const GET_INFORMATION_BLOCK: string;
9
7
  /**
@@ -3,11 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.LIST_INFORMATION_BLOCK_SUMMARIES = exports.LIST_INFORMATION_BLOCKS = exports.GET_INFORMATION_BLOCK_WINDOWED = exports.GET_INFORMATION_BLOCK = void 0;
4
4
  const graphql_request_1 = require("graphql-request");
5
5
  /**
6
- * Information Block envelope — the cross-block-type read that replaces
7
- * block-specific reads like `scheduleFacts` and (eventually)
8
- * `statement`. Returns the assembled envelope with bundled atoms
9
- * (elements, connections, facts) plus the typed artifact mechanics
10
- * branch. See `local/docs/specs/information-block.md` §2.
6
+ * Information Block envelope — the read shared by every block type.
7
+ * Returns the assembled envelope with bundled atoms (elements,
8
+ * connections, facts) plus the typed artifact mechanics branch.
11
9
  */
12
10
  exports.GET_INFORMATION_BLOCK = (0, graphql_request_1.gql) `
13
11
  query GetInformationBlock(
@@ -1,11 +1,9 @@
1
1
  import { gql } from 'graphql-request'
2
2
 
3
3
  /**
4
- * Information Block envelope — the cross-block-type read that replaces
5
- * block-specific reads like `scheduleFacts` and (eventually)
6
- * `statement`. Returns the assembled envelope with bundled atoms
7
- * (elements, connections, facts) plus the typed artifact mechanics
8
- * branch. See `local/docs/specs/information-block.md` §2.
4
+ * Information Block envelope — the read shared by every block type.
5
+ * Returns the assembled envelope with bundled atoms (elements,
6
+ * connections, facts) plus the typed artifact mechanics branch.
9
7
  */
10
8
  export const GET_INFORMATION_BLOCK = gql`
11
9
  query GetInformationBlock(