@robosystems/client 0.2.38 → 0.2.40

package/sdk-extensions/ReportClient.js

@@ -0,0 +1,182 @@
+'use client';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReportClient = void 0;
+/**
+ * Report Client for RoboSystems API
+ *
+ * High-level client for report lifecycle: create, list, view statements,
+ * regenerate, share, and delete. Reports consume ledger data (mappings,
+ * trial balance) as inputs — use LedgerClient for those concerns.
+ */
+const sdk_gen_1 = require("../sdk/sdk.gen");
+// ── Client ──────────────────────────────────────────────────────────────
+class ReportClient {
+    constructor(config) {
+        this.config = config;
+    }
+    /**
+     * Create a report — generates facts for all structures in the taxonomy.
+     */
+    async create(graphId, options) {
+        const response = await (0, sdk_gen_1.createReport)({
+            path: { graph_id: graphId },
+            body: {
+                name: options.name,
+                mapping_id: options.mappingId,
+                period_start: options.periodStart,
+                period_end: options.periodEnd,
+                taxonomy_id: options.taxonomyId ?? 'tax_usgaap_reporting',
+                period_type: options.periodType ?? 'quarterly',
+                comparative: options.comparative ?? true,
+            },
+        });
+        if (response.error) {
+            throw new Error(`Create report failed: ${JSON.stringify(response.error)}`);
+        }
+        return this._toReport(response.data);
+    }
+    /**
+     * List all reports for a graph (includes received shared reports).
+     */
+    async list(graphId) {
+        const response = await (0, sdk_gen_1.listReports)({
+            path: { graph_id: graphId },
+        });
+        if (response.error) {
+            throw new Error(`List reports failed: ${JSON.stringify(response.error)}`);
+        }
+        const data = response.data;
+        return (data.reports ?? []).map((r) => this._toReport(r));
+    }
+    /**
+     * Get a report with its available structures.
+     */
+    async get(graphId, reportId) {
+        const response = await (0, sdk_gen_1.getReport)({
+            path: { graph_id: graphId, report_id: reportId },
+        });
+        if (response.error) {
+            throw new Error(`Get report failed: ${JSON.stringify(response.error)}`);
+        }
+        return this._toReport(response.data);
+    }
+    /**
+     * Render a financial statement — facts viewed through a structure.
+     *
+     * @param structureType - income_statement, balance_sheet, cash_flow_statement
+     */
+    async statement(graphId, reportId, structureType) {
+        const response = await (0, sdk_gen_1.getStatement)({
+            path: { graph_id: graphId, report_id: reportId, structure_type: structureType },
+        });
+        if (response.error) {
+            throw new Error(`Get statement failed: ${JSON.stringify(response.error)}`);
+        }
+        const data = response.data;
+        return {
+            reportId: data.report_id,
+            structureId: data.structure_id,
+            structureName: data.structure_name,
+            structureType: data.structure_type,
+            periodStart: data.period_start,
+            periodEnd: data.period_end,
+            comparativePeriodStart: data.comparative_period_start ?? null,
+            comparativePeriodEnd: data.comparative_period_end ?? null,
+            rows: (data.rows ?? []).map((r) => ({
+                elementId: r.element_id,
+                elementQname: r.element_qname,
+                elementName: r.element_name,
+                classification: r.classification,
+                currentValue: r.current_value,
+                priorValue: r.prior_value ?? null,
+                isSubtotal: r.is_subtotal ?? false,
+                depth: r.depth ?? 0,
+            })),
+            validation: data.validation
+                ? {
+                    passed: data.validation.passed,
+                    checks: data.validation.checks,
+                    failures: data.validation.failures,
+                    warnings: data.validation.warnings,
+                }
+                : null,
+            unmappedCount: data.unmapped_count ?? 0,
+        };
+    }
+    /**
+     * Regenerate a report with new period dates.
+     */
+    async regenerate(graphId, reportId, periodStart, periodEnd) {
+        const response = await (0, sdk_gen_1.regenerateReport)({
+            path: { graph_id: graphId, report_id: reportId },
+            body: { period_start: periodStart, period_end: periodEnd },
+        });
+        if (response.error) {
+            throw new Error(`Regenerate report failed: ${JSON.stringify(response.error)}`);
+        }
+        return this._toReport(response.data);
+    }
+    /**
+     * Delete a report and its generated facts.
+     */
+    async delete(graphId, reportId) {
+        const response = await (0, sdk_gen_1.deleteReport)({
+            path: { graph_id: graphId, report_id: reportId },
+        });
+        if (response.error) {
+            throw new Error(`Delete report failed: ${JSON.stringify(response.error)}`);
+        }
+    }
+    /**
+     * Share a published report to other graphs (snapshot copy).
+     */
+    async share(graphId, reportId, targetGraphIds) {
+        const response = await (0, sdk_gen_1.shareReport)({
+            path: { graph_id: graphId, report_id: reportId },
+            body: { target_graph_ids: targetGraphIds },
+        });
+        if (response.error) {
+            throw new Error(`Share report failed: ${JSON.stringify(response.error)}`);
+        }
+        const data = response.data;
+        return {
+            reportId: data.report_id,
+            results: (data.results ?? []).map((r) => ({
+                targetGraphId: r.target_graph_id,
+                status: r.status,
+                error: r.error ?? null,
+                factCount: r.fact_count ?? 0,
+            })),
+        };
+    }
+    /** Check if a report was received via sharing (vs locally created). */
+    isSharedReport(report) {
+        return report.sourceGraphId !== null;
+    }
+    _toReport(r) {
+        return {
+            id: r.id,
+            name: r.name,
+            taxonomyId: r.taxonomy_id,
+            generationStatus: r.generation_status,
+            periodType: r.period_type,
+            periodStart: r.period_start ?? null,
+            periodEnd: r.period_end ?? null,
+            comparative: r.comparative,
+            mappingId: r.mapping_id ?? null,
+            aiGenerated: r.ai_generated ?? false,
+            createdAt: r.created_at,
+            lastGenerated: r.last_generated ?? null,
+            structures: (r.structures ?? []).map((s) => ({
+                id: s.id,
+                name: s.name,
+                structureType: s.structure_type,
+            })),
+            sourceGraphId: r.source_graph_id ?? null,
+            sourceReportId: r.source_report_id ?? null,
+            sharedAt: r.shared_at ?? null,
+        };
+    }
+}
+exports.ReportClient = ReportClient;

package/sdk-extensions/ReportClient.ts

@@ -0,0 +1,320 @@
+'use client'
+
+/**
+ * Report Client for RoboSystems API
+ *
+ * High-level client for report lifecycle: create, list, view statements,
+ * regenerate, share, and delete. Reports consume ledger data (mappings,
+ * trial balance) as inputs — use LedgerClient for those concerns.
+ */
+
+import {
+  createReport,
+  deleteReport,
+  getReport,
+  getStatement,
+  listReports,
+  regenerateReport,
+  shareReport,
+} from '../sdk/sdk.gen'
+import type {
+  CreateReportRequest,
+  FactRowResponse,
+  RegenerateReportRequest,
+  ReportListResponse,
+  ReportResponse,
+  ShareReportResponse,
+  StatementResponse,
+  StructureSummary,
+  ValidationCheckResponse,
+} from '../sdk/types.gen'
+
+// ── Friendly types ──────────────────────────────────────────────────────
+
+export interface Report {
+  id: string
+  name: string
+  taxonomyId: string
+  generationStatus: string
+  periodType: string
+  periodStart: string | null
+  periodEnd: string | null
+  comparative: boolean
+  mappingId: string | null
+  aiGenerated: boolean
+  createdAt: string
+  lastGenerated: string | null
+  structures: Structure[]
+  /** Non-null when this report was shared from another graph */
+  sourceGraphId: string | null
+  sourceReportId: string | null
+  sharedAt: string | null
+}
+
+// Structure type re-exported from LedgerClient
+import type { Structure } from './LedgerClient'
+export type { Structure } from './LedgerClient'
+
+export interface StatementRow {
+  elementId: string
+  elementQname: string
+  elementName: string
+  classification: string
+  currentValue: number
+  priorValue: number | null
+  isSubtotal: boolean
+  depth: number
+}
+
+export interface StatementData {
+  reportId: string
+  structureId: string
+  structureName: string
+  structureType: string
+  periodStart: string
+  periodEnd: string
+  comparativePeriodStart: string | null
+  comparativePeriodEnd: string | null
+  rows: StatementRow[]
+  validation: {
+    passed: boolean
+    checks: string[]
+    failures: string[]
+    warnings: string[]
+  } | null
+  unmappedCount: number
+}
+
+export interface ShareResult {
+  reportId: string
+  results: Array<{
+    targetGraphId: string
+    status: 'shared' | 'error'
+    error: string | null
+    factCount: number
+  }>
+}
+
+export interface CreateReportOptions {
+  name: string
+  mappingId: string
+  periodStart: string
+  periodEnd: string
+  taxonomyId?: string
+  periodType?: string
+  comparative?: boolean
+}
+
+// ── Client ──────────────────────────────────────────────────────────────
+
+export class ReportClient {
+  private config: {
+    baseUrl: string
+    credentials?: 'include' | 'same-origin' | 'omit'
+    headers?: Record<string, string>
+    token?: string
+  }
+
+  constructor(config: {
+    baseUrl: string
+    credentials?: 'include' | 'same-origin' | 'omit'
+    headers?: Record<string, string>
+    token?: string
+  }) {
+    this.config = config
+  }
+
+  /**
+   * Create a report — generates facts for all structures in the taxonomy.
+   */
+  async create(graphId: string, options: CreateReportOptions): Promise<Report> {
+    const response = await createReport({
+      path: { graph_id: graphId },
+      body: {
+        name: options.name,
+        mapping_id: options.mappingId,
+        period_start: options.periodStart,
+        period_end: options.periodEnd,
+        taxonomy_id: options.taxonomyId ?? 'tax_usgaap_reporting',
+        period_type: options.periodType ?? 'quarterly',
+        comparative: options.comparative ?? true,
+      } as CreateReportRequest,
+    })
+
+    if (response.error) {
+      throw new Error(`Create report failed: ${JSON.stringify(response.error)}`)
+    }
+
+    return this._toReport(response.data as ReportResponse)
+  }
+
+  /**
+   * List all reports for a graph (includes received shared reports).
+   */
+  async list(graphId: string): Promise<Report[]> {
+    const response = await listReports({
+      path: { graph_id: graphId },
+    })
+
+    if (response.error) {
+      throw new Error(`List reports failed: ${JSON.stringify(response.error)}`)
+    }
+
+    const data = response.data as ReportListResponse
+    return (data.reports ?? []).map((r) => this._toReport(r))
+  }
+
+  /**
+   * Get a report with its available structures.
+   */
+  async get(graphId: string, reportId: string): Promise<Report> {
+    const response = await getReport({
+      path: { graph_id: graphId, report_id: reportId },
+    })
+
+    if (response.error) {
+      throw new Error(`Get report failed: ${JSON.stringify(response.error)}`)
+    }
+
+    return this._toReport(response.data as ReportResponse)
+  }
+
+  /**
+   * Render a financial statement — facts viewed through a structure.
+   *
+   * @param structureType - income_statement, balance_sheet, cash_flow_statement
+   */
+  async statement(
+    graphId: string,
+    reportId: string,
+    structureType: string
+  ): Promise<StatementData> {
+    const response = await getStatement({
+      path: { graph_id: graphId, report_id: reportId, structure_type: structureType },
+    })
+
+    if (response.error) {
+      throw new Error(`Get statement failed: ${JSON.stringify(response.error)}`)
+    }
+
+    const data = response.data as StatementResponse
+    return {
+      reportId: data.report_id,
+      structureId: data.structure_id,
+      structureName: data.structure_name,
+      structureType: data.structure_type,
+      periodStart: data.period_start,
+      periodEnd: data.period_end,
+      comparativePeriodStart: data.comparative_period_start ?? null,
+      comparativePeriodEnd: data.comparative_period_end ?? null,
+      rows: (data.rows ?? []).map((r: FactRowResponse) => ({
+        elementId: r.element_id,
+        elementQname: r.element_qname,
+        elementName: r.element_name,
+        classification: r.classification,
+        currentValue: r.current_value,
+        priorValue: r.prior_value ?? null,
+        isSubtotal: r.is_subtotal ?? false,
+        depth: r.depth ?? 0,
+      })),
+      validation: data.validation
+        ? {
+            passed: (data.validation as ValidationCheckResponse).passed,
+            checks: (data.validation as ValidationCheckResponse).checks,
+            failures: (data.validation as ValidationCheckResponse).failures,
+            warnings: (data.validation as ValidationCheckResponse).warnings,
+          }
+        : null,
+      unmappedCount: data.unmapped_count ?? 0,
+    }
+  }
+
+  /**
+   * Regenerate a report with new period dates.
+   */
+  async regenerate(
+    graphId: string,
+    reportId: string,
+    periodStart: string,
+    periodEnd: string
+  ): Promise<Report> {
+    const response = await regenerateReport({
+      path: { graph_id: graphId, report_id: reportId },
+      body: { period_start: periodStart, period_end: periodEnd } as RegenerateReportRequest,
+    })
+
+    if (response.error) {
+      throw new Error(`Regenerate report failed: ${JSON.stringify(response.error)}`)
+    }
+
+    return this._toReport(response.data as ReportResponse)
+  }
+
+  /**
+   * Delete a report and its generated facts.
+   */
+  async delete(graphId: string, reportId: string): Promise<void> {
+    const response = await deleteReport({
+      path: { graph_id: graphId, report_id: reportId },
+    })
+
+    if (response.error) {
+      throw new Error(`Delete report failed: ${JSON.stringify(response.error)}`)
+    }
+  }
+
+  /**
+   * Share a published report to other graphs (snapshot copy).
+   */
+  async share(graphId: string, reportId: string, targetGraphIds: string[]): Promise<ShareResult> {
+    const response = await shareReport({
+      path: { graph_id: graphId, report_id: reportId },
+      body: { target_graph_ids: targetGraphIds },
+    })
+
+    if (response.error) {
+      throw new Error(`Share report failed: ${JSON.stringify(response.error)}`)
+    }
+
+    const data = response.data as ShareReportResponse
+    return {
+      reportId: data.report_id,
+      results: (data.results ?? []).map((r) => ({
+        targetGraphId: r.target_graph_id,
+        status: r.status as 'shared' | 'error',
+        error: r.error ?? null,
+        factCount: r.fact_count ?? 0,
+      })),
+    }
+  }
+
+  /** Check if a report was received via sharing (vs locally created). */
+  isSharedReport(report: Report): boolean {
+    return report.sourceGraphId !== null
+  }
+
+  private _toReport(r: ReportResponse): Report {
+    return {
+      id: r.id,
+      name: r.name,
+      taxonomyId: r.taxonomy_id,
+      generationStatus: r.generation_status,
+      periodType: r.period_type,
+      periodStart: r.period_start ?? null,
+      periodEnd: r.period_end ?? null,
+      comparative: r.comparative,
+      mappingId: r.mapping_id ?? null,
+      aiGenerated: r.ai_generated ?? false,
+      createdAt: r.created_at,
+      lastGenerated: r.last_generated ?? null,
+      structures: (r.structures ?? []).map((s: StructureSummary) => ({
+        id: s.id,
+        name: s.name,
+        structureType: s.structure_type,
+      })),
+      sourceGraphId: r.source_graph_id ?? null,
+      sourceReportId: r.source_report_id ?? null,
+      sharedAt: r.shared_at ?? null,
+    }
+  }
+}

package/sdk-extensions/index.d.ts

@@ -11,6 +11,8 @@ import { MaterializationClient } from './MaterializationClient';
 import { TableClient } from './TableClient';
 import { GraphClient } from './GraphClient';
 import { DocumentClient } from './DocumentClient';
+import { LedgerClient } from './LedgerClient';
+import { ReportClient } from './ReportClient';
 export interface RoboSystemsExtensionConfig {
     baseUrl?: string;
     credentials?: 'include' | 'same-origin' | 'omit';
@@ -29,6 +31,8 @@ export declare class RoboSystemsExtensions {
     readonly tables: TableClient;
     readonly graphs: GraphClient;
     readonly documents: DocumentClient;
+    readonly ledger: LedgerClient;
+    readonly reports: ReportClient;
     private config;
     constructor(config?: RoboSystemsExtensionConfig);
     /**
@@ -52,10 +56,12 @@ export * from './FileClient';
 export * from './MaterializationClient';
 export * from './GraphClient';
 export * from './DocumentClient';
+export * from './LedgerClient';
+export * from './ReportClient';
 export * from './config';
 export type { TableInfo, TableQueryResult } from './TableClient';
 export { TableClient } from './TableClient';
-export { OperationClient, QueryClient, AgentClient, SSEClient, FileClient, MaterializationClient, GraphClient, DocumentClient, };
+export { OperationClient, QueryClient, AgentClient, SSEClient, FileClient, MaterializationClient, GraphClient, DocumentClient, LedgerClient, ReportClient, };
 export { useMultipleOperations, useOperation, useQuery, useSDKClients, useStreamingQuery, useTableUpload, } from './hooks';
 export declare const extensions: {
     readonly query: QueryClient;
@@ -66,6 +72,8 @@ export declare const extensions: {
     readonly tables: TableClient;
     readonly graphs: GraphClient;
     readonly documents: DocumentClient;
+    readonly ledger: LedgerClient;
+    readonly reports: ReportClient;
     monitorOperation: (operationId: string, onProgress?: (progress: any) => void) => Promise<any>;
     createSSEClient: () => SSEClient;
     close: () => void;

package/sdk-extensions/index.js

@@ -18,7 +18,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.analyzeFinancials = exports.agentQuery = exports.streamQuery = exports.executeQuery = exports.monitorOperation = exports.extensions = exports.useTableUpload = exports.useStreamingQuery = exports.useSDKClients = exports.useQuery = exports.useOperation = exports.useMultipleOperations = exports.DocumentClient = exports.GraphClient = exports.MaterializationClient = exports.FileClient = exports.SSEClient = exports.AgentClient = exports.QueryClient = exports.OperationClient = exports.TableClient = exports.RoboSystemsExtensions = void 0;
+exports.analyzeFinancials = exports.agentQuery = exports.streamQuery = exports.executeQuery = exports.monitorOperation = exports.extensions = exports.useTableUpload = exports.useStreamingQuery = exports.useSDKClients = exports.useQuery = exports.useOperation = exports.useMultipleOperations = exports.ReportClient = exports.LedgerClient = exports.DocumentClient = exports.GraphClient = exports.MaterializationClient = exports.FileClient = exports.SSEClient = exports.AgentClient = exports.QueryClient = exports.OperationClient = exports.TableClient = exports.RoboSystemsExtensions = void 0;
 const client_gen_1 = require("../sdk/client.gen");
 const config_1 = require("./config");
 const OperationClient_1 = require("./OperationClient");
@@ -38,6 +38,10 @@ const GraphClient_1 = require("./GraphClient");
 Object.defineProperty(exports, "GraphClient", { enumerable: true, get: function () { return GraphClient_1.GraphClient; } });
 const DocumentClient_1 = require("./DocumentClient");
 Object.defineProperty(exports, "DocumentClient", { enumerable: true, get: function () { return DocumentClient_1.DocumentClient; } });
+const LedgerClient_1 = require("./LedgerClient");
+Object.defineProperty(exports, "LedgerClient", { enumerable: true, get: function () { return LedgerClient_1.LedgerClient; } });
+const ReportClient_1 = require("./ReportClient");
+Object.defineProperty(exports, "ReportClient", { enumerable: true, get: function () { return ReportClient_1.ReportClient; } });
 class RoboSystemsExtensions {
     constructor(config = {}) {
         // Get base URL from SDK client config or use provided/default
@@ -103,6 +107,18 @@ class RoboSystemsExtensions {
             token: this.config.token,
             headers: this.config.headers,
         });
+        this.ledger = new LedgerClient_1.LedgerClient({
+            baseUrl: this.config.baseUrl,
+            credentials: this.config.credentials,
+            token: this.config.token,
+            headers: this.config.headers,
+        });
+        this.reports = new ReportClient_1.ReportClient({
+            baseUrl: this.config.baseUrl,
+            credentials: this.config.credentials,
+            token: this.config.token,
+            headers: this.config.headers,
+        });
     }
     /**
      * Convenience method to monitor any operation
@@ -143,6 +159,8 @@ __exportStar(require("./FileClient"), exports);
 __exportStar(require("./MaterializationClient"), exports);
 __exportStar(require("./GraphClient"), exports);
 __exportStar(require("./DocumentClient"), exports);
+__exportStar(require("./LedgerClient"), exports);
+__exportStar(require("./ReportClient"), exports);
 __exportStar(require("./config"), exports);
 var TableClient_2 = require("./TableClient");
 Object.defineProperty(exports, "TableClient", { enumerable: true, get: function () { return TableClient_2.TableClient; } });
@@ -187,6 +205,12 @@ exports.extensions = {
     get documents() {
         return getExtensions().documents;
     },
+    get ledger() {
+        return getExtensions().ledger;
+    },
+    get reports() {
+        return getExtensions().reports;
+    },
     monitorOperation: (operationId, onProgress) => getExtensions().monitorOperation(operationId, onProgress),
     createSSEClient: () => getExtensions().createSSEClient(),
     close: () => getExtensions().close(),

package/sdk-extensions/index.ts

@@ -14,6 +14,8 @@ import { MaterializationClient } from './MaterializationClient'
 import { TableClient } from './TableClient'
 import { GraphClient } from './GraphClient'
 import { DocumentClient } from './DocumentClient'
+import { LedgerClient } from './LedgerClient'
+import { ReportClient } from './ReportClient'
 
 export interface RoboSystemsExtensionConfig {
   baseUrl?: string
@@ -45,6 +47,8 @@ export class RoboSystemsExtensions {
   public readonly tables: TableClient
   public readonly graphs: GraphClient
   public readonly documents: DocumentClient
+  public readonly ledger: LedgerClient
+  public readonly reports: ReportClient
   private config: ResolvedConfig
 
   constructor(config: RoboSystemsExtensionConfig = {}) {
@@ -121,6 +125,20 @@ export class RoboSystemsExtensions {
       token: this.config.token,
       headers: this.config.headers,
     })
+
+    this.ledger = new LedgerClient({
+      baseUrl: this.config.baseUrl,
+      credentials: this.config.credentials,
+      token: this.config.token,
+      headers: this.config.headers,
+    })
+
+    this.reports = new ReportClient({
+      baseUrl: this.config.baseUrl,
+      credentials: this.config.credentials,
+      token: this.config.token,
+      headers: this.config.headers,
+    })
   }
 
   /**
@@ -164,6 +182,8 @@ export * from './FileClient'
 export * from './MaterializationClient'
 export * from './GraphClient'
 export * from './DocumentClient'
+export * from './LedgerClient'
+export * from './ReportClient'
 export * from './config'
 
 // Export TableClient types individually to avoid conflicts with QueryClient's QueryResult
@@ -179,6 +199,8 @@ export {
   MaterializationClient,
   GraphClient,
   DocumentClient,
+  LedgerClient,
+  ReportClient,
 }
 
 // Export React hooks
@@ -226,6 +248,12 @@ export const extensions = {
   get documents() {
     return getExtensions().documents
   },
+  get ledger() {
+    return getExtensions().ledger
+  },
+  get reports() {
+    return getExtensions().reports
+  },
   monitorOperation: (operationId: string, onProgress?: (progress: any) => void) =>
     getExtensions().monitorOperation(operationId, onProgress),
   createSSEClient: () => getExtensions().createSSEClient(),