@robosystems/client 0.5.6 → 0.5.7

package/artifacts/LedgerClient.d.ts

@@ -368,18 +368,28 @@ export declare class LedgerClient {
      * Fetch an Information Block envelope by id — the generic
      * cross-block-type read. Returns `null` when the block doesn't exist
      * (or its type isn't registered). See `information-block.md`.
+     *
+     * `options.scenarioId` selects the FactSet slice: omitted = actuals;
+     * a forecast block's structure id = that scenario's parallel universe
+     * (statement envelopes bind its latest computed month, metric
+     * envelopes extend the series with "(forecast)"-labeled columns).
      */
-    getInformationBlock(graphId: string, id: string): Promise<InformationBlock | null>;
+    getInformationBlock(graphId: string, id: string, options?: {
+        scenarioId?: string;
+    }): Promise<InformationBlock | null>;
     /**
      * List Information Block envelopes with optional block_type + category
      * filters. Replaces the old `listSchedules` method — callers use
      * `{blockType: 'schedule'}` to get the same set of blocks.
+     * `options.scenarioId` threads into each envelope's FactSet binding
+     * (the block list itself is scenario-independent).
      */
     listInformationBlocks(graphId: string, options?: {
         blockType?: string;
         category?: string;
         limit?: number;
         offset?: number;
+        scenarioId?: string;
     }): Promise<InformationBlockList>;
     /** Create a new schedule with pre-generated monthly facts. */
     /**

package/artifacts/LedgerClient.js

@@ -254,15 +254,22 @@ class LedgerClient {
      * Fetch an Information Block envelope by id — the generic
      * cross-block-type read. Returns `null` when the block doesn't exist
      * (or its type isn't registered). See `information-block.md`.
+     *
+     * `options.scenarioId` selects the FactSet slice: omitted = actuals;
+     * a forecast block's structure id = that scenario's parallel universe
+     * (statement envelopes bind its latest computed month, metric
+     * envelopes extend the series with "(forecast)"-labeled columns).
      */
-    async getInformationBlock(graphId, id) {
-        const block = await this.gqlQuery(graphId, graphql_1.GetInformationBlockDocument, { id }, 'Get information block', (data) => data.informationBlock ?? null);
+    async getInformationBlock(graphId, id, options) {
+        const block = await this.gqlQuery(graphId, graphql_1.GetInformationBlockDocument, { id, scenarioId: options?.scenarioId ?? null }, 'Get information block', (data) => data.informationBlock ?? null);
         return block ?? null;
     }
     /**
      * List Information Block envelopes with optional block_type + category
      * filters. Replaces the old `listSchedules` method — callers use
      * `{blockType: 'schedule'}` to get the same set of blocks.
+     * `options.scenarioId` threads into each envelope's FactSet binding
+     * (the block list itself is scenario-independent).
      */
     async listInformationBlocks(graphId, options) {
         const blocks = await this.gqlQuery(graphId, graphql_1.ListInformationBlocksDocument, {
@@ -270,6 +277,7 @@ class LedgerClient {
             category: options?.category ?? null,
             limit: options?.limit ?? null,
             offset: options?.offset ?? null,
+            scenarioId: options?.scenarioId ?? null,
         }, 'List information blocks', (data) => data.informationBlocks);
         return blocks ?? [];
     }

package/artifacts/LedgerClient.ts

@@ -1080,12 +1080,21 @@ export class LedgerClient {
    * Fetch an Information Block envelope by id — the generic
    * cross-block-type read. Returns `null` when the block doesn't exist
    * (or its type isn't registered). See `information-block.md`.
+   *
+   * `options.scenarioId` selects the FactSet slice: omitted = actuals;
+   * a forecast block's structure id = that scenario's parallel universe
+   * (statement envelopes bind its latest computed month, metric
+   * envelopes extend the series with "(forecast)"-labeled columns).
    */
-  async getInformationBlock(graphId: string, id: string): Promise<InformationBlock | null> {
+  async getInformationBlock(
+    graphId: string,
+    id: string,
+    options?: { scenarioId?: string }
+  ): Promise<InformationBlock | null> {
     const block = await this.gqlQuery(
       graphId,
       GetInformationBlockDocument,
-      { id },
+      { id, scenarioId: options?.scenarioId ?? null },
       'Get information block',
       (data) => data.informationBlock ?? null
     )
@@ -1096,6 +1105,8 @@ export class LedgerClient {
    * List Information Block envelopes with optional block_type + category
    * filters. Replaces the old `listSchedules` method — callers use
    * `{blockType: 'schedule'}` to get the same set of blocks.
+   * `options.scenarioId` threads into each envelope's FactSet binding
+   * (the block list itself is scenario-independent).
    */
   async listInformationBlocks(
     graphId: string,
@@ -1104,6 +1115,7 @@ export class LedgerClient {
       category?: string
       limit?: number
       offset?: number
+      scenarioId?: string
     }
   ): Promise<InformationBlockList> {
     const blocks = await this.gqlQuery(
@@ -1114,6 +1126,7 @@ export class LedgerClient {
         category: options?.category ?? null,
         limit: options?.limit ?? null,
         offset: options?.offset ?? null,
+        scenarioId: options?.scenarioId ?? null,
       },
       'List information blocks',
       (data) => data.informationBlocks

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

@@ -606,7 +606,7 @@ export type InformationBlockFact = {
  */
 export type InformationBlockFactSet = {
     entityId: Scalars['String']['output'];
-    /** 'report' | 'schedule' | 'custom' | 'disclosure'. Enum closure enforced by the ``public.fact_sets`` CHECK constraint. */
+    /** 'report' | 'schedule' | 'custom' | 'disclosure' | 'metric'. Enum closure enforced by the ``public.fact_sets`` CHECK constraint. */
     factsetType: Scalars['String']['output'];
     id: Scalars['String']['output'];
     periodEnd: Scalars['Date']['output'];
@@ -615,6 +615,8 @@ export type InformationBlockFactSet = {
     provenance: Maybe<Scalars['JSON']['output']>;
     /** Back-pointer to the ``reports`` table while ``report_id`` still lives on facts. Drops out once the retirement migration lands. */
     reportId: Maybe<Scalars['String']['output']>;
+    /** Scenario axis (the forecast engine). NULL = actuals; non-NULL names the owning forecast block whose parallel universe this set belongs to. */
+    scenarioId: Maybe<Scalars['String']['output']>;
     structureId: Maybe<Scalars['String']['output']>;
 };
 /**
@@ -1619,12 +1621,14 @@ export type QueryHoldingsArgs = {
 };
 export type QueryInformationBlockArgs = {
     id: Scalars['ID']['input'];
+    scenarioId?: InputMaybe<Scalars['String']['input']>;
 };
 export type QueryInformationBlocksArgs = {
     blockType?: InputMaybe<Scalars['String']['input']>;
     category?: InputMaybe<Scalars['String']['input']>;
     limit?: InputMaybe<Scalars['Int']['input']>;
     offset?: InputMaybe<Scalars['Int']['input']>;
+    scenarioId?: InputMaybe<Scalars['String']['input']>;
 };
 export type QueryLibraryElementArgs = {
     id?: InputMaybe<Scalars['ID']['input']>;
@@ -2768,6 +2772,7 @@ export type GetLedgerFiscalCalendarQuery = {
 };
 export type GetInformationBlockQueryVariables = Exact<{
     id: Scalars['ID']['input'];
+    scenarioId: InputMaybe<Scalars['String']['input']>;
 }>;
 export type GetInformationBlockQuery = {
     informationBlock: {
@@ -2848,6 +2853,7 @@ export type GetInformationBlockQuery = {
             factsetType: string;
             entityId: string;
             reportId: string | null;
+            scenarioId: string | null;
             provenance: any | null;
         } | null;
         verificationResults: Array<{
@@ -2923,6 +2929,7 @@ export type ListInformationBlocksQueryVariables = Exact<{
     category: InputMaybe<Scalars['String']['input']>;
     limit: InputMaybe<Scalars['Int']['input']>;
     offset: InputMaybe<Scalars['Int']['input']>;
+    scenarioId: InputMaybe<Scalars['String']['input']>;
 }>;
 export type ListInformationBlocksQuery = {
     informationBlocks: Array<{
@@ -3003,6 +3010,7 @@ export type ListInformationBlocksQuery = {
             factsetType: string;
             entityId: string;
             reportId: string | null;
+            scenarioId: string | null;
             provenance: any | null;
         } | null;
         verificationResults: Array<{
@@ -3424,6 +3432,7 @@ export type GetLedgerReportPackageQuery = {
                     factsetType: string;
                     entityId: string;
                     reportId: string | null;
+                    scenarioId: string | null;
                     provenance: any | null;
                 } | null;
                 verificationResults: Array<{

package/artifacts/graphql/generated/graphql.js

@@ -1662,6 +1662,11 @@ exports.GetInformationBlockDocument = {
                         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' } },
+                },
             ],
             selectionSet: {
                 kind: 'SelectionSet',
@@ -1675,6 +1680,11 @@ exports.GetInformationBlockDocument = {
                                 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' } },
+                            },
                         ],
                         selectionSet: {
                             kind: 'SelectionSet',
@@ -1817,6 +1827,7 @@ exports.GetInformationBlockDocument = {
                                             { 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' } },
                                         ],
                                     },
@@ -2006,6 +2017,11 @@ exports.ListInformationBlocksDocument = {
                     variable: { kind: 'Variable', name: { kind: 'Name', value: 'offset' } },
                     type: { kind: 'NamedType', name: { kind: 'Name', value: 'Int' } },
                 },
+                {
+                    kind: 'VariableDefinition',
+                    variable: { kind: 'Variable', name: { kind: 'Name', value: 'scenarioId' } },
+                    type: { kind: 'NamedType', name: { kind: 'Name', value: 'String' } },
+                },
             ],
             selectionSet: {
                 kind: 'SelectionSet',
@@ -2034,6 +2050,11 @@ exports.ListInformationBlocksDocument = {
                                 name: { kind: 'Name', value: 'offset' },
                                 value: { kind: 'Variable', name: { kind: 'Name', value: 'offset' } },
                             },
+                            {
+                                kind: 'Argument',
+                                name: { kind: 'Name', value: 'scenarioId' },
+                                value: { kind: 'Variable', name: { kind: 'Name', value: 'scenarioId' } },
+                            },
                         ],
                         selectionSet: {
                             kind: 'SelectionSet',
@@ -2176,6 +2197,7 @@ exports.ListInformationBlocksDocument = {
                                             { 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' } },
                                         ],
                                     },
@@ -3309,6 +3331,7 @@ exports.GetLedgerReportPackageDocument = {
                                                                     { 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' } },
                                                                 ],
                                                             },

package/artifacts/graphql/generated/graphql.ts

@@ -605,7 +605,7 @@ export type InformationBlockFact = {
  */
 export type InformationBlockFactSet = {
   entityId: Scalars['String']['output']
-  /** 'report' | 'schedule' | 'custom' | 'disclosure'. Enum closure enforced by the ``public.fact_sets`` CHECK constraint. */
+  /** 'report' | 'schedule' | 'custom' | 'disclosure' | 'metric'. Enum closure enforced by the ``public.fact_sets`` CHECK constraint. */
   factsetType: Scalars['String']['output']
   id: Scalars['String']['output']
   periodEnd: Scalars['Date']['output']
@@ -614,6 +614,8 @@ export type InformationBlockFactSet = {
   provenance: Maybe<Scalars['JSON']['output']>
   /** Back-pointer to the ``reports`` table while ``report_id`` still lives on facts. Drops out once the retirement migration lands. */
   reportId: Maybe<Scalars['String']['output']>
+  /** Scenario axis (the forecast engine). NULL = actuals; non-NULL names the owning forecast block whose parallel universe this set belongs to. */
+  scenarioId: Maybe<Scalars['String']['output']>
   structureId: Maybe<Scalars['String']['output']>
 }
 
@@ -1681,6 +1683,7 @@ export type QueryHoldingsArgs = {
 
 export type QueryInformationBlockArgs = {
   id: Scalars['ID']['input']
+  scenarioId?: InputMaybe<Scalars['String']['input']>
 }
 
 export type QueryInformationBlocksArgs = {
@@ -1688,6 +1691,7 @@ export type QueryInformationBlocksArgs = {
   category?: InputMaybe<Scalars['String']['input']>
   limit?: InputMaybe<Scalars['Int']['input']>
   offset?: InputMaybe<Scalars['Int']['input']>
+  scenarioId?: InputMaybe<Scalars['String']['input']>
 }
 
 export type QueryLibraryElementArgs = {
@@ -2894,6 +2898,7 @@ export type GetLedgerFiscalCalendarQuery = {
 
 export type GetInformationBlockQueryVariables = Exact<{
   id: Scalars['ID']['input']
+  scenarioId: InputMaybe<Scalars['String']['input']>
 }>
 
 export type GetInformationBlockQuery = {
@@ -2966,6 +2971,7 @@ export type GetInformationBlockQuery = {
       factsetType: string
       entityId: string
       reportId: string | null
+      scenarioId: string | null
       provenance: any | null
     } | null
     verificationResults: Array<{
@@ -3034,6 +3040,7 @@ export type ListInformationBlocksQueryVariables = Exact<{
   category: InputMaybe<Scalars['String']['input']>
   limit: InputMaybe<Scalars['Int']['input']>
   offset: InputMaybe<Scalars['Int']['input']>
+  scenarioId: InputMaybe<Scalars['String']['input']>
 }>
 
 export type ListInformationBlocksQuery = {
@@ -3106,6 +3113,7 @@ export type ListInformationBlocksQuery = {
       factsetType: string
       entityId: string
       reportId: string | null
+      scenarioId: string | null
       provenance: any | null
     } | null
     verificationResults: Array<{
@@ -3514,6 +3522,7 @@ export type GetLedgerReportPackageQuery = {
           factsetType: string
           entityId: string
           reportId: string | null
+          scenarioId: string | null
           provenance: any | null
         } | null
         verificationResults: Array<{
@@ -5733,6 +5742,11 @@ export const GetInformationBlockDocument = {
             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' } },
+        },
       ],
       selectionSet: {
         kind: 'SelectionSet',
@@ -5746,6 +5760,11 @@ export const GetInformationBlockDocument = {
                 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' } },
+              },
             ],
             selectionSet: {
               kind: 'SelectionSet',
@@ -5888,6 +5907,7 @@ export const GetInformationBlockDocument = {
                       { 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' } },
                     ],
                   },
@@ -6077,6 +6097,11 @@ export const ListInformationBlocksDocument = {
           variable: { kind: 'Variable', name: { kind: 'Name', value: 'offset' } },
           type: { kind: 'NamedType', name: { kind: 'Name', value: 'Int' } },
         },
+        {
+          kind: 'VariableDefinition',
+          variable: { kind: 'Variable', name: { kind: 'Name', value: 'scenarioId' } },
+          type: { kind: 'NamedType', name: { kind: 'Name', value: 'String' } },
+        },
       ],
       selectionSet: {
         kind: 'SelectionSet',
@@ -6105,6 +6130,11 @@ export const ListInformationBlocksDocument = {
                 name: { kind: 'Name', value: 'offset' },
                 value: { kind: 'Variable', name: { kind: 'Name', value: 'offset' } },
               },
+              {
+                kind: 'Argument',
+                name: { kind: 'Name', value: 'scenarioId' },
+                value: { kind: 'Variable', name: { kind: 'Name', value: 'scenarioId' } },
+              },
             ],
             selectionSet: {
               kind: 'SelectionSet',
@@ -6247,6 +6277,7 @@ export const ListInformationBlocksDocument = {
                       { 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' } },
                     ],
                   },
@@ -7389,6 +7420,7 @@ export const GetLedgerReportPackageDocument = {
                                   { 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' } },
                                 ],
                               },

package/artifacts/graphql/queries/ledger/informationBlock.js

@@ -10,8 +10,8 @@ const graphql_request_1 = require("graphql-request");
  * branch. See `local/docs/specs/information-block.md` §2.
  */
 exports.GET_INFORMATION_BLOCK = (0, graphql_request_1.gql) `
-  query GetInformationBlock($id: ID!) {
-    informationBlock(id: $id) {
+  query GetInformationBlock($id: ID!, $scenarioId: String) {
+    informationBlock(id: $id, scenarioId: $scenarioId) {
       id
       blockType
       name
@@ -89,6 +89,7 @@ exports.GET_INFORMATION_BLOCK = (0, graphql_request_1.gql) `
         factsetType
         entityId
         reportId
+        scenarioId
         provenance
       }
       verificationResults {
@@ -167,8 +168,20 @@ exports.GET_INFORMATION_BLOCK = (0, graphql_request_1.gql) `
  * blocks.
  */
 exports.LIST_INFORMATION_BLOCKS = (0, graphql_request_1.gql) `
-  query ListInformationBlocks($blockType: String, $category: String, $limit: Int, $offset: Int) {
-    informationBlocks(blockType: $blockType, category: $category, limit: $limit, offset: $offset) {
+  query ListInformationBlocks(
+    $blockType: String
+    $category: String
+    $limit: Int
+    $offset: Int
+    $scenarioId: String
+  ) {
+    informationBlocks(
+      blockType: $blockType
+      category: $category
+      limit: $limit
+      offset: $offset
+      scenarioId: $scenarioId
+    ) {
       id
       blockType
       name
@@ -246,6 +259,7 @@ exports.LIST_INFORMATION_BLOCKS = (0, graphql_request_1.gql) `
         factsetType
         entityId
         reportId
+        scenarioId
         provenance
       }
       verificationResults {

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

@@ -8,8 +8,8 @@ import { gql } from 'graphql-request'
  * branch. See `local/docs/specs/information-block.md` §2.
  */
 export const GET_INFORMATION_BLOCK = gql`
-  query GetInformationBlock($id: ID!) {
-    informationBlock(id: $id) {
+  query GetInformationBlock($id: ID!, $scenarioId: String) {
+    informationBlock(id: $id, scenarioId: $scenarioId) {
       id
       blockType
       name
@@ -87,6 +87,7 @@ export const GET_INFORMATION_BLOCK = gql`
         factsetType
         entityId
         reportId
+        scenarioId
         provenance
       }
       verificationResults {
@@ -166,8 +167,20 @@ export const GET_INFORMATION_BLOCK = gql`
  * blocks.
  */
 export const LIST_INFORMATION_BLOCKS = gql`
-  query ListInformationBlocks($blockType: String, $category: String, $limit: Int, $offset: Int) {
-    informationBlocks(blockType: $blockType, category: $category, limit: $limit, offset: $offset) {
+  query ListInformationBlocks(
+    $blockType: String
+    $category: String
+    $limit: Int
+    $offset: Int
+    $scenarioId: String
+  ) {
+    informationBlocks(
+      blockType: $blockType
+      category: $category
+      limit: $limit
+      offset: $offset
+      scenarioId: $scenarioId
+    ) {
       id
       blockType
       name
@@ -245,6 +258,7 @@ export const LIST_INFORMATION_BLOCKS = gql`
         factsetType
         entityId
         reportId
+        scenarioId
         provenance
       }
       verificationResults {

package/artifacts/graphql/queries/ledger/reportPackage.js

@@ -118,6 +118,7 @@ exports.GET_REPORT_PACKAGE = (0, graphql_request_1.gql) `
             factsetType
             entityId
             reportId
+            scenarioId
             provenance
           }
           verificationResults {

package/artifacts/graphql/queries/ledger/reportPackage.ts

@@ -116,6 +116,7 @@ export const GET_REPORT_PACKAGE = gql`
             factsetType
             entityId
             reportId
+            scenarioId
             provenance
           }
           verificationResults {