@robosystems/client 0.2.48 → 0.3.0

package/sdk-extensions/ReportClient.d.ts

@@ -1,151 +0,0 @@
-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[];
-    /** Entity name (source company for shared reports, own entity for native) */
-    entityName: string | null;
-    /** Non-null when this report was shared from another graph */
-    sourceGraphId: string | null;
-    sourceReportId: string | null;
-    sharedAt: string | null;
-}
-import type { Structure } from './LedgerClient';
-export type { Structure } from './LedgerClient';
-export interface StatementPeriod {
-    start: string;
-    end: string;
-    label: string;
-}
-export interface StatementRow {
-    elementId: string;
-    elementQname: string;
-    elementName: string;
-    classification: string;
-    values: (number | null)[];
-    isSubtotal: boolean;
-    depth: number;
-}
-export interface StatementData {
-    reportId: string;
-    structureId: string;
-    structureName: string;
-    structureType: string;
-    periods: StatementPeriod[];
-    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 PublishList {
-    id: string;
-    name: string;
-    description: string | null;
-    memberCount: number;
-    createdBy: string;
-    createdAt: string;
-    updatedAt: string;
-}
-export interface PublishListDetail extends PublishList {
-    members: PublishListMember[];
-}
-export interface PublishListMember {
-    id: string;
-    targetGraphId: string;
-    targetGraphName: string | null;
-    targetOrgName: string | null;
-    addedBy: string;
-    addedAt: string;
-}
-export interface PeriodSpecInput {
-    start: string;
-    end: string;
-    label: string;
-}
-export interface CreateReportOptions {
-    name: string;
-    mappingId: string;
-    periodStart: string;
-    periodEnd: string;
-    taxonomyId?: string;
-    periodType?: string;
-    comparative?: boolean;
-    /** When set, overrides periodStart/periodEnd/comparative with N explicit periods. */
-    periods?: PeriodSpecInput[];
-}
-export declare class ReportClient {
-    private config;
-    constructor(config: {
-        baseUrl: string;
-        credentials?: 'include' | 'same-origin' | 'omit';
-        headers?: Record<string, string>;
-        token?: string;
-    });
-    /**
-     * Create a report — generates facts for all structures in the taxonomy.
-     */
-    create(graphId: string, options: CreateReportOptions): Promise<Report>;
-    /**
-     * List all reports for a graph (includes received shared reports).
-     */
-    list(graphId: string): Promise<Report[]>;
-    /**
-     * Get a report with its available structures.
-     */
-    get(graphId: string, reportId: string): Promise<Report>;
-    /**
-     * Render a financial statement — facts viewed through a structure.
-     *
-     * @param structureType - income_statement, balance_sheet, cash_flow_statement
-     */
-    statement(graphId: string, reportId: string, structureType: string): Promise<StatementData>;
-    /**
-     * Regenerate a report with new period dates.
-     */
-    regenerate(graphId: string, reportId: string, periodStart: string, periodEnd: string): Promise<Report>;
-    /**
-     * Delete a report and its generated facts.
-     */
-    delete(graphId: string, reportId: string): Promise<void>;
-    /**
-     * Share a published report to all members of a publish list (snapshot copy).
-     */
-    share(graphId: string, reportId: string, publishListId: string): Promise<ShareResult>;
-    /** Check if a report was received via sharing (vs locally created). */
-    isSharedReport(report: Report): boolean;
-    listPublishLists(graphId: string): Promise<PublishList[]>;
-    createPublishList(graphId: string, name: string, description?: string): Promise<PublishList>;
-    getPublishList(graphId: string, listId: string): Promise<PublishListDetail>;
-    updatePublishList(graphId: string, listId: string, updates: {
-        name?: string;
-        description?: string;
-    }): Promise<PublishList>;
-    deletePublishList(graphId: string, listId: string): Promise<void>;
-    addMembers(graphId: string, listId: string, targetGraphIds: string[]): Promise<PublishListMember[]>;
-    removeMember(graphId: string, listId: string, memberId: string): Promise<void>;
-    private _toPublishList;
-    private _toMember;
-    private _toReport;
-}

package/sdk-extensions/ReportClient.js

@@ -1,278 +0,0 @@
-'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 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 (options.periods && options.periods.length > 0) {
-            body.periods = options.periods;
-        }
-        const response = await (0, sdk_gen_1.createReport)({
-            path: { graph_id: graphId },
-            body,
-        });
-        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,
-            periods: (data.periods ?? []).map((p) => ({
-                start: p.start,
-                end: p.end,
-                label: p.label,
-            })),
-            rows: (data.rows ?? []).map((r) => ({
-                elementId: r.element_id,
-                elementQname: r.element_qname,
-                elementName: r.element_name,
-                classification: r.classification,
-                values: r.values ?? [],
-                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 all members of a publish list (snapshot copy).
-     */
-    async share(graphId, reportId, publishListId) {
-        const response = await (0, sdk_gen_1.shareReport)({
-            path: { graph_id: graphId, report_id: reportId },
-            body: { publish_list_id: publishListId },
-        });
-        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;
-    }
-    // ── Publish Lists ────────────────────────────────────────────────────
-    async listPublishLists(graphId) {
-        const response = await (0, sdk_gen_1.listPublishLists)({
-            path: { graph_id: graphId },
-        });
-        if (response.error) {
-            throw new Error(`List publish lists failed: ${JSON.stringify(response.error)}`);
-        }
-        const data = response.data;
-        return (data.publish_lists ?? []).map((pl) => this._toPublishList(pl));
-    }
-    async createPublishList(graphId, name, description) {
-        const response = await (0, sdk_gen_1.createPublishList)({
-            path: { graph_id: graphId },
-            body: { name, description: description ?? null },
-        });
-        if (response.error) {
-            throw new Error(`Create publish list failed: ${JSON.stringify(response.error)}`);
-        }
-        return this._toPublishList(response.data);
-    }
-    async getPublishList(graphId, listId) {
-        const response = await (0, sdk_gen_1.getPublishList)({
-            path: { graph_id: graphId, list_id: listId },
-        });
-        if (response.error) {
-            throw new Error(`Get publish list failed: ${JSON.stringify(response.error)}`);
-        }
-        const data = response.data;
-        return {
-            ...this._toPublishList(data),
-            members: (data.members ?? []).map((m) => this._toMember(m)),
-        };
-    }
-    async updatePublishList(graphId, listId, updates) {
-        const response = await (0, sdk_gen_1.updatePublishList)({
-            path: { graph_id: graphId, list_id: listId },
-            body: updates,
-        });
-        if (response.error) {
-            throw new Error(`Update publish list failed: ${JSON.stringify(response.error)}`);
-        }
-        return this._toPublishList(response.data);
-    }
-    async deletePublishList(graphId, listId) {
-        const response = await (0, sdk_gen_1.deletePublishList)({
-            path: { graph_id: graphId, list_id: listId },
-        });
-        if (response.error) {
-            throw new Error(`Delete publish list failed: ${JSON.stringify(response.error)}`);
-        }
-    }
-    async addMembers(graphId, listId, targetGraphIds) {
-        const response = await (0, sdk_gen_1.addPublishListMembers)({
-            path: { graph_id: graphId, list_id: listId },
-            body: { target_graph_ids: targetGraphIds },
-        });
-        if (response.error) {
-            throw new Error(`Add members failed: ${JSON.stringify(response.error)}`);
-        }
-        return (response.data ?? []).map((m) => this._toMember(m));
-    }
-    async removeMember(graphId, listId, memberId) {
-        const response = await (0, sdk_gen_1.removePublishListMember)({
-            path: { graph_id: graphId, list_id: listId, member_id: memberId },
-        });
-        if (response.error) {
-            throw new Error(`Remove member failed: ${JSON.stringify(response.error)}`);
-        }
-    }
-    _toPublishList(pl) {
-        return {
-            id: pl.id,
-            name: pl.name,
-            description: pl.description ?? null,
-            memberCount: pl.member_count ?? 0,
-            createdBy: pl.created_by,
-            createdAt: pl.created_at,
-            updatedAt: pl.updated_at,
-        };
-    }
-    _toMember(m) {
-        return {
-            id: m.id,
-            targetGraphId: m.target_graph_id,
-            targetGraphName: m.target_graph_name ?? null,
-            targetOrgName: m.target_org_name ?? null,
-            addedBy: m.added_by,
-            addedAt: m.added_at,
-        };
-    }
-    _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,
-            })),
-            entityName: r.entity_name ?? null,
-            sourceGraphId: r.source_graph_id ?? null,
-            sourceReportId: r.source_report_id ?? null,
-            sharedAt: r.shared_at ?? null,
-        };
-    }
-}
-exports.ReportClient = ReportClient;