@robosystems/client 0.3.1 → 0.3.3

package/extensions/ReportClient.d.ts

@@ -1,120 +0,0 @@
-import type { OperationEnvelope } from '../types.gen';
-import type { TokenProvider } from './graphql/client';
-import { type GetLedgerPublishListQuery, type GetLedgerReportQuery, type GetLedgerStatementQuery, type ListLedgerPublishListsQuery, type ListLedgerReportsQuery } from './graphql/generated/graphql';
-export type Report = NonNullable<GetLedgerReportQuery['report']>;
-export type ReportListItem = NonNullable<ListLedgerReportsQuery['reports']>['reports'][number];
-export type StatementData = NonNullable<GetLedgerStatementQuery['statement']>;
-export type StatementPeriod = StatementData['periods'][number];
-export type StatementRow = StatementData['rows'][number];
-export type PublishList = NonNullable<ListLedgerPublishListsQuery['publishLists']>['publishLists'][number];
-export type PublishListDetail = NonNullable<GetLedgerPublishListQuery['publishList']>;
-export type PublishListMember = PublishListDetail['members'][number];
-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[];
-}
-/**
- * Envelope around a report operation. `status === "completed"` means the
- * backend produced the report synchronously — `result` contains the
- * freshly-created report shape (same fields as `ReportListItem`), so
- * consumers can read `result?.id` immediately. For pending/failed
- * dispatches, `result` is null and consumers should subscribe to
- * `/v1/operations/{operationId}/stream` for progress.
- *
- * The loose `{ id; name; ... }` shape here intentionally mirrors the
- * GraphQL `report` field without pulling in every nullable child relation
- * — `create_report` and `regenerate_report` return a freshly-generated
- * row, not a fully-resolved GraphQL projection.
- */
-export interface ReportOperationAck {
-    operationId: string;
-    status: OperationEnvelope['status'];
-    /**
-     * Synchronous command result. Populated for `status === "completed"`
-     * dispatches where the backend produced the report inline.
-     */
-    result: Record<string, unknown> | null;
-}
-interface ReportClientConfig {
-    baseUrl: string;
-    credentials?: 'include' | 'same-origin' | 'omit';
-    headers?: Record<string, string>;
-    /** Static credential — use `tokenProvider` instead if the JWT rotates. */
-    token?: string;
-    /**
-     * Dynamic credential callback. When set, invoked on every GraphQL
-     * request so refreshes flow through automatically.
-     */
-    tokenProvider?: TokenProvider;
-}
-export declare class ReportClient {
-    private config;
-    private gql;
-    constructor(config: ReportClientConfig);
-    /**
-     * Kick off report creation (async). Use the returned `operationId` to
-     * subscribe to progress via SSE, then call `get()` once finished.
-     */
-    create(graphId: string, options: CreateReportOptions): Promise<ReportOperationAck>;
-    /** List all reports for a graph (includes received shared reports). */
-    list(graphId: string): Promise<ReportListItem[]>;
-    /** Get a single report with its period list + available structures. */
-    get(graphId: string, reportId: string): Promise<Report | null>;
-    /**
-     * 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 | null>;
-    /**
-     * Regenerate an existing report (async). Returns an operation id;
-     * subscribe via SSE for progress.
-     */
-    regenerate(graphId: string, reportId: string, periodStart?: string, periodEnd?: string): Promise<ReportOperationAck>;
-    /** Delete a report and its generated facts. */
-    delete(graphId: string, reportId: string): Promise<void>;
-    /**
-     * Share a published report to every member of a publish list (async).
-     * Each target graph receives a snapshot copy of the report's facts.
-     */
-    share(graphId: string, reportId: string, publishListId: string): Promise<ReportOperationAck>;
-    /** Check if a report was received via sharing (vs locally created). */
-    isSharedReport(report: Report): boolean;
-    /** List publish lists with pagination. */
-    listPublishLists(graphId: string, options?: {
-        limit?: number;
-        offset?: number;
-    }): Promise<PublishList[]>;
-    /** Create a new publish list. */
-    createPublishList(graphId: string, name: string, description?: string): Promise<Record<string, unknown>>;
-    /** Get a single publish list with its full member list. */
-    getPublishList(graphId: string, listId: string): Promise<PublishListDetail | null>;
-    /** Update a publish list's name or description. */
-    updatePublishList(graphId: string, listId: string, updates: {
-        name?: string;
-        description?: string | null;
-    }): Promise<Record<string, unknown>>;
-    /** Delete a publish list. */
-    deletePublishList(graphId: string, listId: string): Promise<void>;
-    /** Add target graphs as members of a publish list. */
-    addMembers(graphId: string, listId: string, targetGraphIds: string[]): Promise<Record<string, unknown>>;
-    /** Remove a single member from a publish list. */
-    removeMember(graphId: string, listId: string, memberId: string): Promise<{
-        deleted: boolean;
-    }>;
-    private gqlQuery;
-    private callOperation;
-}
-export {};

package/extensions/ReportClient.js

@@ -1,191 +0,0 @@
-'use client';
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReportClient = void 0;
-const graphql_request_1 = require("graphql-request");
-const sdk_gen_1 = require("../sdk.gen");
-const client_1 = require("./graphql/client");
-const graphql_1 = require("./graphql/generated/graphql");
-class ReportClient {
-    constructor(config) {
-        this.config = config;
-        this.gql = new client_1.GraphQLClientCache(config);
-    }
-    // ── Reports ─────────────────────────────────────────────────────────
-    /**
-     * Kick off report creation (async). Use the returned `operationId` to
-     * subscribe to progress via SSE, then call `get()` once finished.
-     */
-    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 envelope = await this.callOperation('Create report', (0, sdk_gen_1.opCreateReport)({ path: { graph_id: graphId }, body }));
-        return {
-            operationId: envelope.operationId,
-            status: envelope.status,
-            result: envelope.result ?? null,
-        };
-    }
-    /** List all reports for a graph (includes received shared reports). */
-    async list(graphId) {
-        const list = await this.gqlQuery(graphId, graphql_1.ListLedgerReportsDocument, undefined, 'List reports', (data) => data.reports);
-        return list?.reports ?? [];
-    }
-    /** Get a single report with its period list + available structures. */
-    async get(graphId, reportId) {
-        return this.gqlQuery(graphId, graphql_1.GetLedgerReportDocument, { reportId }, 'Get report', (data) => data.report);
-    }
-    /**
-     * Render a financial statement — facts viewed through a structure.
-     *
-     * @param structureType - income_statement, balance_sheet, cash_flow_statement
-     */
-    async statement(graphId, reportId, structureType) {
-        return this.gqlQuery(graphId, graphql_1.GetLedgerStatementDocument, { reportId, structureType }, 'Get statement', (data) => data.statement);
-    }
-    /**
-     * Regenerate an existing report (async). Returns an operation id;
-     * subscribe via SSE for progress.
-     */
-    async regenerate(graphId, reportId, periodStart, periodEnd) {
-        const envelope = await this.callOperation('Regenerate report', (0, sdk_gen_1.opRegenerateReport)({
-            path: { graph_id: graphId },
-            body: {
-                report_id: reportId,
-                period_start: periodStart,
-                period_end: periodEnd,
-            },
-        }));
-        return {
-            operationId: envelope.operationId,
-            status: envelope.status,
-            result: envelope.result ?? null,
-        };
-    }
-    /** Delete a report and its generated facts. */
-    async delete(graphId, reportId) {
-        await this.callOperation('Delete report', (0, sdk_gen_1.opDeleteReport)({
-            path: { graph_id: graphId },
-            body: { report_id: reportId },
-        }));
-    }
-    /**
-     * Share a published report to every member of a publish list (async).
-     * Each target graph receives a snapshot copy of the report's facts.
-     */
-    async share(graphId, reportId, publishListId) {
-        const envelope = await this.callOperation('Share report', (0, sdk_gen_1.opShareReport)({
-            path: { graph_id: graphId },
-            body: {
-                report_id: reportId,
-                publish_list_id: publishListId,
-            },
-        }));
-        return {
-            operationId: envelope.operationId,
-            status: envelope.status,
-            result: envelope.result ?? null,
-        };
-    }
-    /** Check if a report was received via sharing (vs locally created). */
-    isSharedReport(report) {
-        return report.sourceGraphId !== null;
-    }
-    // ── Publish Lists ────────────────────────────────────────────────────
-    /** List publish lists with pagination. */
-    async listPublishLists(graphId, options) {
-        const list = await this.gqlQuery(graphId, graphql_1.ListLedgerPublishListsDocument, {
-            limit: options?.limit ?? 100,
-            offset: options?.offset ?? 0,
-        }, 'List publish lists', (data) => data.publishLists);
-        return list?.publishLists ?? [];
-    }
-    /** Create a new publish list. */
-    async createPublishList(graphId, name, description) {
-        const body = {
-            name,
-            description: description ?? null,
-        };
-        const envelope = await this.callOperation('Create publish list', (0, sdk_gen_1.opCreatePublishList)({ path: { graph_id: graphId }, body }));
-        return (envelope.result ?? {});
-    }
-    /** Get a single publish list with its full member list. */
-    async getPublishList(graphId, listId) {
-        return this.gqlQuery(graphId, graphql_1.GetLedgerPublishListDocument, { listId }, 'Get publish list', (data) => data.publishList);
-    }
-    /** Update a publish list's name or description. */
-    async updatePublishList(graphId, listId, updates) {
-        const envelope = await this.callOperation('Update publish list', (0, sdk_gen_1.opUpdatePublishList)({
-            path: { graph_id: graphId },
-            body: {
-                list_id: listId,
-                name: updates.name,
-                description: updates.description ?? null,
-            },
-        }));
-        return (envelope.result ?? {});
-    }
-    /** Delete a publish list. */
-    async deletePublishList(graphId, listId) {
-        await this.callOperation('Delete publish list', (0, sdk_gen_1.opDeletePublishList)({
-            path: { graph_id: graphId },
-            body: { list_id: listId },
-        }));
-    }
-    /** Add target graphs as members of a publish list. */
-    async addMembers(graphId, listId, targetGraphIds) {
-        const envelope = await this.callOperation('Add publish list members', (0, sdk_gen_1.opAddPublishListMembers)({
-            path: { graph_id: graphId },
-            body: {
-                list_id: listId,
-                target_graph_ids: targetGraphIds,
-            },
-        }));
-        return (envelope.result ?? {});
-    }
-    /** Remove a single member from a publish list. */
-    async removeMember(graphId, listId, memberId) {
-        const envelope = await this.callOperation('Remove publish list member', (0, sdk_gen_1.opRemovePublishListMember)({
-            path: { graph_id: graphId },
-            body: { list_id: listId, member_id: memberId },
-        }));
-        return (envelope.result ?? { deleted: true });
-    }
-    // ── Internal helpers ────────────────────────────────────────────────
-    async gqlQuery(graphId, document, variables, label, pick) {
-        try {
-            const client = this.gql.get(graphId);
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            const raw = client.request;
-            const data = (await raw.call(client, document, variables));
-            return pick(data);
-        }
-        catch (err) {
-            if (err instanceof graphql_request_1.ClientError) {
-                throw new Error(`${label} failed: ${JSON.stringify(err.response.errors ?? err.message)}`);
-            }
-            throw err;
-        }
-    }
-    async callOperation(label, call) {
-        const response = await call;
-        if (response.error !== undefined) {
-            throw new Error(`${label} failed: ${JSON.stringify(response.error)}`);
-        }
-        if (response.data === undefined) {
-            throw new Error(`${label} failed: empty response`);
-        }
-        return response.data;
-    }
-}
-exports.ReportClient = ReportClient;