@robosystems/client 0.5.8 → 0.5.10

package/artifacts/LedgerClient.d.ts

@@ -379,10 +379,20 @@ export declare class LedgerClient {
      * columns cross the actuals/forecast seam and forecast columns carry
      * `periods[].forecast === true`. Non-statement block types ignore it
      * (metric envelopes are always the full series).
+     *
+     * `options.seriesHistory` / `options.seriesForecast` window the series
+     * to its seam-adjacent columns — the last N actual columns and the
+     * first N forecast columns; omitted = unbounded. Passing either sends
+     * the windowed query document, which requires a backend that knows the
+     * window arguments — a pre-window server rejects it. Callers that
+     * never pass a window keep the un-windowed document and stay
+     * compatible with older backends.
      */
     getInformationBlock(graphId: string, id: string, options?: {
         scenarioId?: string;
         series?: boolean;
+        seriesHistory?: number;
+        seriesForecast?: number;
     }): Promise<InformationBlock | null>;
     /**
      * List Information Block envelopes with optional block_type + category

package/artifacts/LedgerClient.js

@@ -265,13 +265,30 @@ class LedgerClient {
      * columns cross the actuals/forecast seam and forecast columns carry
      * `periods[].forecast === true`. Non-statement block types ignore it
      * (metric envelopes are always the full series).
+     *
+     * `options.seriesHistory` / `options.seriesForecast` window the series
+     * to its seam-adjacent columns — the last N actual columns and the
+     * first N forecast columns; omitted = unbounded. Passing either sends
+     * the windowed query document, which requires a backend that knows the
+     * window arguments — a pre-window server rejects it. Callers that
+     * never pass a window keep the un-windowed document and stay
+     * compatible with older backends.
      */
     async getInformationBlock(graphId, id, options) {
-        const block = await this.gqlQuery(graphId, graphql_1.GetInformationBlockDocument, {
-            id,
-            scenarioId: options?.scenarioId ?? null,
-            series: options?.series ?? false,
-        }, 'Get information block', (data) => data.informationBlock ?? null);
+        const windowed = options?.seriesHistory !== undefined || options?.seriesForecast !== undefined;
+        const block = windowed
+            ? await this.gqlQuery(graphId, graphql_1.GetInformationBlockWindowedDocument, {
+                id,
+                scenarioId: options?.scenarioId ?? null,
+                series: options?.series ?? false,
+                seriesHistory: options?.seriesHistory ?? null,
+                seriesForecast: options?.seriesForecast ?? null,
+            }, 'Get information block', (data) => data.informationBlock ?? null)
+            : await this.gqlQuery(graphId, graphql_1.GetInformationBlockDocument, {
+                id,
+                scenarioId: options?.scenarioId ?? null,
+                series: options?.series ?? false,
+            }, 'Get information block', (data) => data.informationBlock ?? null);
         return block ?? null;
     }
     /**

package/artifacts/LedgerClient.ts

@@ -130,6 +130,7 @@ import type { TokenProvider } from './graphql/client'
 import { GraphQLClientCache } from './graphql/client'
 import {
   GetInformationBlockDocument,
+  GetInformationBlockWindowedDocument,
   GetLedgerAccountRollupsDocument,
   GetLedgerAccountTreeDocument,
   GetLedgerAgentDocument,
@@ -1091,23 +1092,51 @@ export class LedgerClient {
    * columns cross the actuals/forecast seam and forecast columns carry
    * `periods[].forecast === true`. Non-statement block types ignore it
    * (metric envelopes are always the full series).
+   *
+   * `options.seriesHistory` / `options.seriesForecast` window the series
+   * to its seam-adjacent columns — the last N actual columns and the
+   * first N forecast columns; omitted = unbounded. Passing either sends
+   * the windowed query document, which requires a backend that knows the
+   * window arguments — a pre-window server rejects it. Callers that
+   * never pass a window keep the un-windowed document and stay
+   * compatible with older backends.
    */
   async getInformationBlock(
     graphId: string,
     id: string,
-    options?: { scenarioId?: string; series?: boolean }
+    options?: {
+      scenarioId?: string
+      series?: boolean
+      seriesHistory?: number
+      seriesForecast?: number
+    }
   ): Promise<InformationBlock | null> {
-    const block = await this.gqlQuery(
-      graphId,
-      GetInformationBlockDocument,
-      {
-        id,
-        scenarioId: options?.scenarioId ?? null,
-        series: options?.series ?? false,
-      },
-      'Get information block',
-      (data) => data.informationBlock ?? null
-    )
+    const windowed = options?.seriesHistory !== undefined || options?.seriesForecast !== undefined
+    const block = windowed
+      ? await this.gqlQuery(
+          graphId,
+          GetInformationBlockWindowedDocument,
+          {
+            id,
+            scenarioId: options?.scenarioId ?? null,
+            series: options?.series ?? false,
+            seriesHistory: options?.seriesHistory ?? null,
+            seriesForecast: options?.seriesForecast ?? null,
+          },
+          'Get information block',
+          (data) => data.informationBlock ?? null
+        )
+      : await this.gqlQuery(
+          graphId,
+          GetInformationBlockDocument,
+          {
+            id,
+            scenarioId: options?.scenarioId ?? null,
+            series: options?.series ?? false,
+          },
+          'Get information block',
+          (data) => data.informationBlock ?? null
+        )
     return block ?? null
   }
 

package/artifacts/graphql/generated/graphql.d.ts

@@ -563,6 +563,8 @@ export type InformationBlockConnection = {
 export type InformationBlockElement = {
     balanceType: Maybe<Scalars['String']['output']>;
     code: Maybe<Scalars['String']['output']>;
+    /** The element's documentation-role label — the catalog's authoritative value semantics (e.g. whether a percent driver is a growth rate or a rate-on-base fraction). None when the element carries no documentation label. */
+    documentation: Maybe<Scalars['String']['output']>;
     /** concept | abstract | axis | member | hypercube */
     elementType: Scalars['String']['output'];
     id: Scalars['String']['output'];
@@ -1625,6 +1627,8 @@ export type QueryInformationBlockArgs = {
     id: Scalars['ID']['input'];
     scenarioId?: InputMaybe<Scalars['String']['input']>;
     series?: Scalars['Boolean']['input'];
+    seriesForecast?: InputMaybe<Scalars['Int']['input']>;
+    seriesHistory?: InputMaybe<Scalars['Int']['input']>;
 };
 export type QueryInformationBlocksArgs = {
     blockType?: InputMaybe<Scalars['String']['input']>;
@@ -2929,6 +2933,164 @@ export type GetInformationBlockQuery = {
         };
     } | null;
 };
+export type GetInformationBlockWindowedQueryVariables = Exact<{
+    id: Scalars['ID']['input'];
+    scenarioId: InputMaybe<Scalars['String']['input']>;
+    series?: Scalars['Boolean']['input'];
+    seriesHistory: InputMaybe<Scalars['Int']['input']>;
+    seriesForecast: InputMaybe<Scalars['Int']['input']>;
+}>;
+export type GetInformationBlockWindowedQuery = {
+    informationBlock: {
+        id: string;
+        blockType: string;
+        name: string;
+        displayName: string;
+        category: string;
+        taxonomyId: string | null;
+        taxonomyName: string | null;
+        informationModel: {
+            conceptArrangement: string | null;
+            memberArrangement: string | null;
+        };
+        artifact: {
+            topic: string | null;
+            rendererNote: string | null;
+            template: any | null;
+            mechanics: any;
+        };
+        elements: Array<{
+            id: string;
+            qname: string | null;
+            name: string;
+            code: string | null;
+            elementType: string;
+            isAbstract: boolean;
+            isMonetary: boolean;
+            balanceType: string | null;
+            periodType: string | null;
+        }>;
+        connections: Array<{
+            id: string;
+            fromElementId: string;
+            toElementId: string;
+            associationType: string;
+            arcrole: string | null;
+            orderValue: number | null;
+            weight: number | null;
+        }>;
+        facts: Array<{
+            id: string;
+            elementId: string;
+            value: number | null;
+            textValue: string | null;
+            factType: string;
+            contentType: string | null;
+            periodStart: any | null;
+            periodEnd: any;
+            periodType: string;
+            unit: string;
+            factScope: string;
+            factSetId: string | null;
+        }>;
+        rules: Array<{
+            id: string;
+            ruleCategory: string;
+            rulePattern: string | null;
+            ruleCheckKind: string | null;
+            ruleExpression: string;
+            ruleMessage: string | null;
+            ruleSeverity: string;
+            ruleOrigin: string;
+            ruleTarget: {
+                targetKind: string;
+                targetRefId: string;
+            } | null;
+            ruleVariables: Array<{
+                variableName: string;
+                variableQname: string | null;
+            }>;
+        }>;
+        factSet: {
+            id: string;
+            structureId: string | null;
+            periodStart: any | null;
+            periodEnd: any;
+            factsetType: string;
+            entityId: string;
+            reportId: string | null;
+            scenarioId: string | null;
+            provenance: any | null;
+        } | null;
+        verificationResults: Array<{
+            id: string;
+            ruleId: string;
+            structureId: string | null;
+            factSetId: string | null;
+            status: string;
+            message: string | null;
+            periodStart: any | null;
+            periodEnd: any | null;
+            evaluatedAt: any | null;
+        }>;
+        verificationSummary: {
+            total: number;
+            passed: number;
+            failed: number;
+            errored: number;
+            skipped: number;
+            byCategory: Array<{
+                category: string;
+                total: number;
+                passed: number;
+                failed: number;
+                errored: number;
+                skipped: number;
+            }>;
+        } | null;
+        view: {
+            rendering: {
+                unmappedCount: number;
+                rows: Array<{
+                    elementId: string;
+                    elementQname: string | null;
+                    elementName: string;
+                    classification: string | null;
+                    balanceType: string | null;
+                    itemType: string | null;
+                    values: Array<number | null>;
+                    textValue: string | null;
+                    isSubtotal: boolean;
+                    depth: number;
+                }>;
+                periods: Array<{
+                    start: any;
+                    end: any;
+                    label: string | null;
+                    forecast: boolean | null;
+                }>;
+                validation: {
+                    passed: boolean;
+                    checks: Array<string>;
+                    failures: Array<string>;
+                    warnings: Array<string>;
+                } | null;
+            } | null;
+            chart: {
+                panels: Array<{
+                    label: string | null;
+                    itemType: string | null;
+                    kind: string;
+                    series: Array<{
+                        key: string;
+                        elementId: string;
+                        label: string;
+                    }>;
+                }>;
+            } | null;
+        };
+    } | null;
+};
 export type ListInformationBlocksQueryVariables = Exact<{
     blockType: InputMaybe<Scalars['String']['input']>;
     category: InputMaybe<Scalars['String']['input']>;
@@ -4037,6 +4199,7 @@ export declare const GetLedgerEventBlockDocument: DocumentNode<GetLedgerEventBlo
 export declare const ListLedgerEventBlocksDocument: DocumentNode<ListLedgerEventBlocksQuery, ListLedgerEventBlocksQueryVariables>;
 export declare const GetLedgerFiscalCalendarDocument: DocumentNode<GetLedgerFiscalCalendarQuery, GetLedgerFiscalCalendarQueryVariables>;
 export declare const GetInformationBlockDocument: DocumentNode<GetInformationBlockQuery, GetInformationBlockQueryVariables>;
+export declare const GetInformationBlockWindowedDocument: DocumentNode<GetInformationBlockWindowedQuery, GetInformationBlockWindowedQueryVariables>;
 export declare const ListInformationBlocksDocument: DocumentNode<ListInformationBlocksQuery, ListInformationBlocksQueryVariables>;
 export declare const GetLedgerMappedTrialBalanceDocument: DocumentNode<GetLedgerMappedTrialBalanceQuery, GetLedgerMappedTrialBalanceQueryVariables>;
 export declare const GetLedgerMappingDocument: DocumentNode<GetLedgerMappingQuery, GetLedgerMappingQueryVariables>;