@robosystems/client 0.5.8 → 0.5.10

package/artifacts/graphql/generated/graphql.ts

@@ -560,6 +560,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']
@@ -1687,6 +1689,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 = {
@@ -3039,6 +3043,148 @@ 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']>
@@ -6088,6 +6234,387 @@ export const GetInformationBlockDocument = {
     },
   ],
 } as unknown as DocumentNode<GetInformationBlockQuery, GetInformationBlockQueryVariables>
+export const GetInformationBlockWindowedDocument = {
+  kind: 'Document',
+  definitions: [
+    {
+      kind: 'OperationDefinition',
+      operation: 'query',
+      name: { kind: 'Name', value: 'GetInformationBlockWindowed' },
+      variableDefinitions: [
+        {
+          kind: 'VariableDefinition',
+          variable: { kind: 'Variable', name: { kind: 'Name', value: 'id' } },
+          type: {
+            kind: 'NonNullType',
+            type: { kind: 'NamedType', name: { kind: 'Name', value: 'ID' } },
+          },
+        },
+        {
+          kind: 'VariableDefinition',
+          variable: { kind: 'Variable', name: { kind: 'Name', value: 'scenarioId' } },
+          type: { kind: 'NamedType', name: { kind: 'Name', value: 'String' } },
+        },
+        {
+          kind: 'VariableDefinition',
+          variable: { kind: 'Variable', name: { kind: 'Name', value: 'series' } },
+          type: {
+            kind: 'NonNullType',
+            type: { kind: 'NamedType', name: { kind: 'Name', value: 'Boolean' } },
+          },
+          defaultValue: { kind: 'BooleanValue', value: false },
+        },
+        {
+          kind: 'VariableDefinition',
+          variable: { kind: 'Variable', name: { kind: 'Name', value: 'seriesHistory' } },
+          type: { kind: 'NamedType', name: { kind: 'Name', value: 'Int' } },
+        },
+        {
+          kind: 'VariableDefinition',
+          variable: { kind: 'Variable', name: { kind: 'Name', value: 'seriesForecast' } },
+          type: { kind: 'NamedType', name: { kind: 'Name', value: 'Int' } },
+        },
+      ],
+      selectionSet: {
+        kind: 'SelectionSet',
+        selections: [
+          {
+            kind: 'Field',
+            name: { kind: 'Name', value: 'informationBlock' },
+            arguments: [
+              {
+                kind: 'Argument',
+                name: { kind: 'Name', value: 'id' },
+                value: { kind: 'Variable', name: { kind: 'Name', value: 'id' } },
+              },
+              {
+                kind: 'Argument',
+                name: { kind: 'Name', value: 'scenarioId' },
+                value: { kind: 'Variable', name: { kind: 'Name', value: 'scenarioId' } },
+              },
+              {
+                kind: 'Argument',
+                name: { kind: 'Name', value: 'series' },
+                value: { kind: 'Variable', name: { kind: 'Name', value: 'series' } },
+              },
+              {
+                kind: 'Argument',
+                name: { kind: 'Name', value: 'seriesHistory' },
+                value: { kind: 'Variable', name: { kind: 'Name', value: 'seriesHistory' } },
+              },
+              {
+                kind: 'Argument',
+                name: { kind: 'Name', value: 'seriesForecast' },
+                value: { kind: 'Variable', name: { kind: 'Name', value: 'seriesForecast' } },
+              },
+            ],
+            selectionSet: {
+              kind: 'SelectionSet',
+              selections: [
+                { kind: 'Field', name: { kind: 'Name', value: 'id' } },
+                { kind: 'Field', name: { kind: 'Name', value: 'blockType' } },
+                { kind: 'Field', name: { kind: 'Name', value: 'name' } },
+                { kind: 'Field', name: { kind: 'Name', value: 'displayName' } },
+                { kind: 'Field', name: { kind: 'Name', value: 'category' } },
+                { kind: 'Field', name: { kind: 'Name', value: 'taxonomyId' } },
+                { kind: 'Field', name: { kind: 'Name', value: 'taxonomyName' } },
+                {
+                  kind: 'Field',
+                  name: { kind: 'Name', value: 'informationModel' },
+                  selectionSet: {
+                    kind: 'SelectionSet',
+                    selections: [
+                      { kind: 'Field', name: { kind: 'Name', value: 'conceptArrangement' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'memberArrangement' } },
+                    ],
+                  },
+                },
+                {
+                  kind: 'Field',
+                  name: { kind: 'Name', value: 'artifact' },
+                  selectionSet: {
+                    kind: 'SelectionSet',
+                    selections: [
+                      { kind: 'Field', name: { kind: 'Name', value: 'topic' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'rendererNote' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'template' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'mechanics' } },
+                    ],
+                  },
+                },
+                {
+                  kind: 'Field',
+                  name: { kind: 'Name', value: 'elements' },
+                  selectionSet: {
+                    kind: 'SelectionSet',
+                    selections: [
+                      { kind: 'Field', name: { kind: 'Name', value: 'id' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'qname' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'name' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'code' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'elementType' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'isAbstract' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'isMonetary' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'balanceType' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'periodType' } },
+                    ],
+                  },
+                },
+                {
+                  kind: 'Field',
+                  name: { kind: 'Name', value: 'connections' },
+                  selectionSet: {
+                    kind: 'SelectionSet',
+                    selections: [
+                      { kind: 'Field', name: { kind: 'Name', value: 'id' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'fromElementId' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'toElementId' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'associationType' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'arcrole' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'orderValue' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'weight' } },
+                    ],
+                  },
+                },
+                {
+                  kind: 'Field',
+                  name: { kind: 'Name', value: 'facts' },
+                  selectionSet: {
+                    kind: 'SelectionSet',
+                    selections: [
+                      { kind: 'Field', name: { kind: 'Name', value: 'id' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'elementId' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'value' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'textValue' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'factType' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'contentType' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'periodStart' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'periodEnd' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'periodType' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'unit' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'factScope' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'factSetId' } },
+                    ],
+                  },
+                },
+                {
+                  kind: 'Field',
+                  name: { kind: 'Name', value: 'rules' },
+                  selectionSet: {
+                    kind: 'SelectionSet',
+                    selections: [
+                      { kind: 'Field', name: { kind: 'Name', value: 'id' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'ruleCategory' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'rulePattern' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'ruleCheckKind' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'ruleExpression' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'ruleMessage' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'ruleSeverity' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'ruleOrigin' } },
+                      {
+                        kind: 'Field',
+                        name: { kind: 'Name', value: 'ruleTarget' },
+                        selectionSet: {
+                          kind: 'SelectionSet',
+                          selections: [
+                            { kind: 'Field', name: { kind: 'Name', value: 'targetKind' } },
+                            { kind: 'Field', name: { kind: 'Name', value: 'targetRefId' } },
+                          ],
+                        },
+                      },
+                      {
+                        kind: 'Field',
+                        name: { kind: 'Name', value: 'ruleVariables' },
+                        selectionSet: {
+                          kind: 'SelectionSet',
+                          selections: [
+                            { kind: 'Field', name: { kind: 'Name', value: 'variableName' } },
+                            { kind: 'Field', name: { kind: 'Name', value: 'variableQname' } },
+                          ],
+                        },
+                      },
+                    ],
+                  },
+                },
+                {
+                  kind: 'Field',
+                  name: { kind: 'Name', value: 'factSet' },
+                  selectionSet: {
+                    kind: 'SelectionSet',
+                    selections: [
+                      { kind: 'Field', name: { kind: 'Name', value: 'id' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'structureId' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'periodStart' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'periodEnd' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'factsetType' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'entityId' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'reportId' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'scenarioId' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'provenance' } },
+                    ],
+                  },
+                },
+                {
+                  kind: 'Field',
+                  name: { kind: 'Name', value: 'verificationResults' },
+                  selectionSet: {
+                    kind: 'SelectionSet',
+                    selections: [
+                      { kind: 'Field', name: { kind: 'Name', value: 'id' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'ruleId' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'structureId' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'factSetId' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'status' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'message' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'periodStart' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'periodEnd' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'evaluatedAt' } },
+                    ],
+                  },
+                },
+                {
+                  kind: 'Field',
+                  name: { kind: 'Name', value: 'verificationSummary' },
+                  selectionSet: {
+                    kind: 'SelectionSet',
+                    selections: [
+                      { kind: 'Field', name: { kind: 'Name', value: 'total' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'passed' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'failed' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'errored' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'skipped' } },
+                      {
+                        kind: 'Field',
+                        name: { kind: 'Name', value: 'byCategory' },
+                        selectionSet: {
+                          kind: 'SelectionSet',
+                          selections: [
+                            { kind: 'Field', name: { kind: 'Name', value: 'category' } },
+                            { kind: 'Field', name: { kind: 'Name', value: 'total' } },
+                            { kind: 'Field', name: { kind: 'Name', value: 'passed' } },
+                            { kind: 'Field', name: { kind: 'Name', value: 'failed' } },
+                            { kind: 'Field', name: { kind: 'Name', value: 'errored' } },
+                            { kind: 'Field', name: { kind: 'Name', value: 'skipped' } },
+                          ],
+                        },
+                      },
+                    ],
+                  },
+                },
+                {
+                  kind: 'Field',
+                  name: { kind: 'Name', value: 'view' },
+                  selectionSet: {
+                    kind: 'SelectionSet',
+                    selections: [
+                      {
+                        kind: 'Field',
+                        name: { kind: 'Name', value: 'rendering' },
+                        selectionSet: {
+                          kind: 'SelectionSet',
+                          selections: [
+                            {
+                              kind: 'Field',
+                              name: { kind: 'Name', value: 'rows' },
+                              selectionSet: {
+                                kind: 'SelectionSet',
+                                selections: [
+                                  { kind: 'Field', name: { kind: 'Name', value: 'elementId' } },
+                                  { kind: 'Field', name: { kind: 'Name', value: 'elementQname' } },
+                                  { kind: 'Field', name: { kind: 'Name', value: 'elementName' } },
+                                  {
+                                    kind: 'Field',
+                                    name: { kind: 'Name', value: 'classification' },
+                                  },
+                                  { kind: 'Field', name: { kind: 'Name', value: 'balanceType' } },
+                                  { kind: 'Field', name: { kind: 'Name', value: 'itemType' } },
+                                  { kind: 'Field', name: { kind: 'Name', value: 'values' } },
+                                  { kind: 'Field', name: { kind: 'Name', value: 'textValue' } },
+                                  { kind: 'Field', name: { kind: 'Name', value: 'isSubtotal' } },
+                                  { kind: 'Field', name: { kind: 'Name', value: 'depth' } },
+                                ],
+                              },
+                            },
+                            {
+                              kind: 'Field',
+                              name: { kind: 'Name', value: 'periods' },
+                              selectionSet: {
+                                kind: 'SelectionSet',
+                                selections: [
+                                  { kind: 'Field', name: { kind: 'Name', value: 'start' } },
+                                  { kind: 'Field', name: { kind: 'Name', value: 'end' } },
+                                  { kind: 'Field', name: { kind: 'Name', value: 'label' } },
+                                  { kind: 'Field', name: { kind: 'Name', value: 'forecast' } },
+                                ],
+                              },
+                            },
+                            {
+                              kind: 'Field',
+                              name: { kind: 'Name', value: 'validation' },
+                              selectionSet: {
+                                kind: 'SelectionSet',
+                                selections: [
+                                  { kind: 'Field', name: { kind: 'Name', value: 'passed' } },
+                                  { kind: 'Field', name: { kind: 'Name', value: 'checks' } },
+                                  { kind: 'Field', name: { kind: 'Name', value: 'failures' } },
+                                  { kind: 'Field', name: { kind: 'Name', value: 'warnings' } },
+                                ],
+                              },
+                            },
+                            { kind: 'Field', name: { kind: 'Name', value: 'unmappedCount' } },
+                          ],
+                        },
+                      },
+                      {
+                        kind: 'Field',
+                        name: { kind: 'Name', value: 'chart' },
+                        selectionSet: {
+                          kind: 'SelectionSet',
+                          selections: [
+                            {
+                              kind: 'Field',
+                              name: { kind: 'Name', value: 'panels' },
+                              selectionSet: {
+                                kind: 'SelectionSet',
+                                selections: [
+                                  { kind: 'Field', name: { kind: 'Name', value: 'label' } },
+                                  { kind: 'Field', name: { kind: 'Name', value: 'itemType' } },
+                                  { kind: 'Field', name: { kind: 'Name', value: 'kind' } },
+                                  {
+                                    kind: 'Field',
+                                    name: { kind: 'Name', value: 'series' },
+                                    selectionSet: {
+                                      kind: 'SelectionSet',
+                                      selections: [
+                                        { kind: 'Field', name: { kind: 'Name', value: 'key' } },
+                                        {
+                                          kind: 'Field',
+                                          name: { kind: 'Name', value: 'elementId' },
+                                        },
+                                        { kind: 'Field', name: { kind: 'Name', value: 'label' } },
+                                      ],
+                                    },
+                                  },
+                                ],
+                              },
+                            },
+                          ],
+                        },
+                      },
+                    ],
+                  },
+                },
+              ],
+            },
+          },
+        ],
+      },
+    },
+  ],
+} as unknown as DocumentNode<
+  GetInformationBlockWindowedQuery,
+  GetInformationBlockWindowedQueryVariables
+>
 export const ListInformationBlocksDocument = {
   kind: 'Document',
   definitions: [

package/artifacts/graphql/queries/ledger/informationBlock.d.ts

@@ -6,6 +6,18 @@
  * branch. See `local/docs/specs/information-block.md` §2.
  */
 export declare const GET_INFORMATION_BLOCK: string;
+/**
+ * The windowed variant of `GET_INFORMATION_BLOCK` — identical selection
+ * set plus the `seriesHistory` / `seriesForecast` window arguments
+ * (statement series only: last N actual + first N forecast columns).
+ *
+ * A SEPARATE document on purpose: a server that predates the window
+ * arguments rejects any query that names them, so the facade sends this
+ * document only when a caller actually passes a window — every existing
+ * call keeps the un-windowed document and stays compatible with older
+ * backends.
+ */
+export declare const GET_INFORMATION_BLOCK_WINDOWED: string;
 /**
  * List Information Block envelopes with optional block_type + category
  * filters. Each returned envelope has the same shape as the