@robosystems/client 0.3.12 → 0.3.14

package/artifacts/LedgerClient.d.ts

@@ -1,6 +1,6 @@
 import type { AutoMapElementsOperation, CreateAgentRequest, CreateEventBlockRequest, CreateEventHandlerRequest, CreateMappingAssociationOperation, CreateTaxonomyBlockRequest, CreateViewRequest, DeleteMappingAssociationOperation, DeleteTaxonomyBlockRequest, EvaluateRulesRequest, FinancialStatementAnalysisRequest, LinkEntityTaxonomyRequest, LiveFinancialStatementRequest, OperationEnvelope, UpdateAgentRequest, UpdateEntityRequest, UpdateEventBlockRequest, UpdateEventHandlerRequest, UpdateJournalEntryRequest, UpdateTaxonomyBlockRequest } from '../types.gen';
 import type { TokenProvider } from './graphql/client';
-import { type GetInformationBlockQuery, type GetLedgerAccountRollupsQuery, type GetLedgerAccountTreeQuery, type GetLedgerClosingBookStructuresQuery, type GetLedgerEntityQuery, type GetLedgerFiscalCalendarQuery, type GetLedgerMappedTrialBalanceQuery, type GetLedgerMappingCoverageQuery, type GetLedgerMappingQuery, type GetLedgerPeriodCloseStatusQuery, type GetLedgerPeriodDraftsQuery, type GetLedgerPublishListQuery, type GetLedgerReportingTaxonomyQuery, type GetLedgerReportQuery, type GetLedgerStatementQuery, type GetLedgerSummaryQuery, type GetLedgerTransactionQuery, type GetLedgerTrialBalanceQuery, type ListInformationBlocksQuery, type ListLedgerAccountsQuery, type ListLedgerElementsQuery, type ListLedgerEntitiesQuery, type ListLedgerMappingsQuery, type ListLedgerPublishListsQuery, type ListLedgerReportsQuery, type ListLedgerStructuresQuery, type ListLedgerTaxonomiesQuery, type ListLedgerTransactionsQuery, type ListLedgerUnmappedElementsQuery } from './graphql/generated/graphql';
+import { type GetInformationBlockQuery, type GetLedgerAccountRollupsQuery, type GetLedgerAccountTreeQuery, type GetLedgerClosingBookStructuresQuery, type GetLedgerEntityQuery, type GetLedgerFiscalCalendarQuery, type GetLedgerMappedTrialBalanceQuery, type GetLedgerMappingCoverageQuery, type GetLedgerMappingQuery, type GetLedgerPeriodCloseStatusQuery, type GetLedgerPeriodDraftsQuery, type GetLedgerPublishListQuery, type GetLedgerReportingTaxonomyQuery, type GetLedgerReportPackageQuery, type GetLedgerReportQuery, type GetLedgerStatementQuery, type GetLedgerSummaryQuery, type GetLedgerTransactionQuery, type GetLedgerTrialBalanceQuery, type ListInformationBlocksQuery, type ListLedgerAccountsQuery, type ListLedgerElementsQuery, type ListLedgerEntitiesQuery, type ListLedgerMappingsQuery, type ListLedgerPublishListsQuery, type ListLedgerReportsQuery, type ListLedgerStructuresQuery, type ListLedgerTaxonomiesQuery, type ListLedgerTransactionsQuery, type ListLedgerUnmappedElementsQuery } from './graphql/generated/graphql';
 export type LedgerEntity = NonNullable<GetLedgerEntityQuery['entity']>;
 export type LedgerEntitySummary = ListLedgerEntitiesQuery['entities'][number];
 export type LedgerSummary = NonNullable<GetLedgerSummaryQuery['summary']>;
@@ -39,6 +39,8 @@ export type LedgerClosingBookStructures = NonNullable<GetLedgerClosingBookStruct
 export type LedgerFiscalCalendar = NonNullable<GetLedgerFiscalCalendarQuery['fiscalCalendar']>;
 export type LedgerFiscalPeriod = LedgerFiscalCalendar['periods'][number];
 export type Report = NonNullable<GetLedgerReportQuery['report']>;
+export type ReportPackage = NonNullable<GetLedgerReportPackageQuery['reportPackage']>;
+export type ReportPackageItem = ReportPackage['items'][number];
 export type ReportListItem = NonNullable<ListLedgerReportsQuery['reports']>['reports'][number];
 export type StatementData = NonNullable<GetLedgerStatementQuery['statement']>;
 export type StatementPeriod = StatementData['periods'][number];
@@ -446,6 +448,13 @@ export declare class LedgerClient {
     listReports(graphId: string): Promise<ReportListItem[]>;
     /** Get a single report with its period list + available structures. */
     getReport(graphId: string, reportId: string): Promise<Report | null>;
+    /**
+     * Rehydrate a Report as a package — Report metadata + N
+     * `InformationBlock` envelopes (one per attached FactSet). Drives the
+     * package viewer; returns everything needed to render BS + IS (and any
+     * other statements the Report generated) without per-section fetches.
+     */
+    getReportPackage(graphId: string, reportId: string): Promise<ReportPackage | null>;
     /**
      * Render a financial statement — facts viewed through a structure.
      *
@@ -464,6 +473,18 @@ export declare class LedgerClient {
      * Each target graph receives a snapshot copy of the report's facts.
      */
     shareReport(graphId: string, reportId: string, publishListId: string): Promise<ReportOperationAck>;
+    /**
+     * Transition a Report's filing_status to 'filed' — locks the package.
+     * Allowed from 'draft' or 'under_review'. Stamps filed_at + filed_by
+     * from the auth context + server clock.
+     */
+    fileReport(graphId: string, reportId: string): Promise<ReportOperationAck>;
+    /**
+     * Move a Report along the non-file legs of the filing lifecycle
+     * (draft ↔ under_review, filed → archived). Use ``fileReport`` to
+     * reach 'filed' so the audit fields land cleanly.
+     */
+    transitionFilingStatus(graphId: string, reportId: string, targetStatus: string): Promise<ReportOperationAck>;
     /** Check if a report was received via sharing (vs locally created). */
     isSharedReport(report: Report): boolean;
     /** List publish lists with pagination. */

package/artifacts/LedgerClient.js

@@ -624,6 +624,15 @@ class LedgerClient {
     async getReport(graphId, reportId) {
         return this.gqlQuery(graphId, graphql_1.GetLedgerReportDocument, { reportId }, 'Get report', (data) => data.report);
     }
+    /**
+     * Rehydrate a Report as a package — Report metadata + N
+     * `InformationBlock` envelopes (one per attached FactSet). Drives the
+     * package viewer; returns everything needed to render BS + IS (and any
+     * other statements the Report generated) without per-section fetches.
+     */
+    async getReportPackage(graphId, reportId) {
+        return this.gqlQuery(graphId, graphql_1.GetLedgerReportPackageDocument, { reportId }, 'Get report package', (data) => data.reportPackage);
+    }
     /**
      * Render a financial statement — facts viewed through a structure.
      *
@@ -676,6 +685,37 @@ class LedgerClient {
             result: envelope.result ?? null,
         };
     }
+    /**
+     * Transition a Report's filing_status to 'filed' — locks the package.
+     * Allowed from 'draft' or 'under_review'. Stamps filed_at + filed_by
+     * from the auth context + server clock.
+     */
+    async fileReport(graphId, reportId) {
+        const body = { report_id: reportId };
+        const envelope = await this.callOperation('File report', (0, sdk_gen_1.opFileReport)({ path: { graph_id: graphId }, body }));
+        return {
+            operationId: envelope.operationId,
+            status: envelope.status,
+            result: envelope.result ?? null,
+        };
+    }
+    /**
+     * Move a Report along the non-file legs of the filing lifecycle
+     * (draft ↔ under_review, filed → archived). Use ``fileReport`` to
+     * reach 'filed' so the audit fields land cleanly.
+     */
+    async transitionFilingStatus(graphId, reportId, targetStatus) {
+        const body = {
+            report_id: reportId,
+            target_status: targetStatus,
+        };
+        const envelope = await this.callOperation('Transition filing status', (0, sdk_gen_1.opTransitionFilingStatus)({ path: { graph_id: graphId }, body }));
+        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;

package/artifacts/LedgerClient.ts

@@ -44,6 +44,7 @@ import {
   opDeleteReport,
   opDeleteTaxonomyBlock,
   opEvaluateRules,
+  opFileReport,
   opFinancialStatementAnalysis,
   opInitializeLedger,
   opLinkEntityTaxonomy,
@@ -54,6 +55,7 @@ import {
   opReopenPeriod,
   opSetCloseTarget,
   opShareReport,
+  opTransitionFilingStatus,
   opUpdateAgent,
   opUpdateEntity,
   opUpdateEventBlock,
@@ -81,6 +83,7 @@ import type {
   DeleteMappingAssociationOperation,
   DeleteTaxonomyBlockRequest,
   EvaluateRulesRequest,
+  FileReportRequest,
   FinancialStatementAnalysisRequest,
   InitializeLedgerRequest,
   LinkEntityTaxonomyRequest,
@@ -88,6 +91,7 @@ import type {
   OperationEnvelope,
   ReopenPeriodOperation,
   SetCloseTargetOperation,
+  TransitionFilingStatusRequest,
   UpdateAgentRequest,
   UpdateEntityRequest,
   UpdateEventBlockRequest,
@@ -114,6 +118,7 @@ import {
   GetLedgerPublishListDocument,
   GetLedgerReportDocument,
   GetLedgerReportingTaxonomyDocument,
+  GetLedgerReportPackageDocument,
   GetLedgerStatementDocument,
   GetLedgerSummaryDocument,
   GetLedgerTransactionDocument,
@@ -142,6 +147,7 @@ import {
   type GetLedgerPeriodDraftsQuery,
   type GetLedgerPublishListQuery,
   type GetLedgerReportingTaxonomyQuery,
+  type GetLedgerReportPackageQuery,
   type GetLedgerReportQuery,
   type GetLedgerStatementQuery,
   type GetLedgerSummaryQuery,
@@ -227,6 +233,8 @@ export type LedgerFiscalPeriod = LedgerFiscalCalendar['periods'][number]
 
 // Reports + publish lists + statements
 export type Report = NonNullable<GetLedgerReportQuery['report']>
+export type ReportPackage = NonNullable<GetLedgerReportPackageQuery['reportPackage']>
+export type ReportPackageItem = ReportPackage['items'][number]
 export type ReportListItem = NonNullable<ListLedgerReportsQuery['reports']>['reports'][number]
 export type StatementData = NonNullable<GetLedgerStatementQuery['statement']>
 export type StatementPeriod = StatementData['periods'][number]
@@ -1532,6 +1540,22 @@ export class LedgerClient {
     )
   }
 
+  /**
+   * Rehydrate a Report as a package — Report metadata + N
+   * `InformationBlock` envelopes (one per attached FactSet). Drives the
+   * package viewer; returns everything needed to render BS + IS (and any
+   * other statements the Report generated) without per-section fetches.
+   */
+  async getReportPackage(graphId: string, reportId: string): Promise<ReportPackage | null> {
+    return this.gqlQuery(
+      graphId,
+      GetLedgerReportPackageDocument,
+      { reportId },
+      'Get report package',
+      (data) => data.reportPackage
+    )
+  }
+
   /**
    * Render a financial statement — facts viewed through a structure.
    *
@@ -1616,6 +1640,49 @@ export class LedgerClient {
     }
   }
 
+  /**
+   * Transition a Report's filing_status to 'filed' — locks the package.
+   * Allowed from 'draft' or 'under_review'. Stamps filed_at + filed_by
+   * from the auth context + server clock.
+   */
+  async fileReport(graphId: string, reportId: string): Promise<ReportOperationAck> {
+    const body: FileReportRequest = { report_id: reportId }
+    const envelope = await this.callOperation(
+      'File report',
+      opFileReport({ path: { graph_id: graphId }, body })
+    )
+    return {
+      operationId: envelope.operationId,
+      status: envelope.status,
+      result: (envelope.result as Record<string, unknown> | null) ?? null,
+    }
+  }
+
+  /**
+   * Move a Report along the non-file legs of the filing lifecycle
+   * (draft ↔ under_review, filed → archived). Use ``fileReport`` to
+   * reach 'filed' so the audit fields land cleanly.
+   */
+  async transitionFilingStatus(
+    graphId: string,
+    reportId: string,
+    targetStatus: string
+  ): Promise<ReportOperationAck> {
+    const body: TransitionFilingStatusRequest = {
+      report_id: reportId,
+      target_status: targetStatus,
+    }
+    const envelope = await this.callOperation(
+      'Transition filing status',
+      opTransitionFilingStatus({ path: { graph_id: graphId }, body })
+    )
+    return {
+      operationId: envelope.operationId,
+      status: envelope.status,
+      result: (envelope.result as Record<string, unknown> | null) ?? null,
+    }
+  }
+
   /** Check if a report was received via sharing (vs locally created). */
   isSharedReport(report: Report): boolean {
     return report.sourceGraphId !== null