@robosystems/client 0.3.24 → 0.3.26

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

@@ -23,7 +23,7 @@ export const GET_INFORMATION_BLOCK = gql`
       }
       artifact {
         topic
-        parentheticalNote
+        rendererNote
         template
         mechanics
       }
@@ -62,10 +62,19 @@ export const GET_INFORMATION_BLOCK = gql`
         id
         ruleCategory
         rulePattern
+        ruleCheckKind
         ruleExpression
         ruleMessage
         ruleSeverity
         ruleOrigin
+        ruleTarget {
+          targetKind
+          targetRefId
+        }
+        ruleVariables {
+          variableName
+          variableQname
+        }
       }
       factSet {
         id
@@ -139,7 +148,7 @@ export const LIST_INFORMATION_BLOCKS = gql`
       }
       artifact {
         topic
-        parentheticalNote
+        rendererNote
         template
         mechanics
       }
@@ -178,10 +187,19 @@ export const LIST_INFORMATION_BLOCKS = gql`
         id
         ruleCategory
         rulePattern
+        ruleCheckKind
         ruleExpression
         ruleMessage
         ruleSeverity
         ruleOrigin
+        ruleTarget {
+          targetKind
+          targetRefId
+        }
+        ruleVariables {
+          variableName
+          variableQname
+        }
       }
       factSet {
         id

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

@@ -11,7 +11,7 @@ exports.GET_MAPPING = (0, graphql_request_1.gql) `
     mapping(mappingId: $mappingId) {
       id
       name
-      structureType
+      blockType
       taxonomyId
       totalAssociations
       associations {

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

@@ -9,7 +9,7 @@ export const GET_MAPPING = gql`
     mapping(mappingId: $mappingId) {
       id
       name
-      structureType
+      blockType
       taxonomyId
       totalAssociations
       associations {

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

@@ -1,6 +1,6 @@
 /**
  * All active coa_mapping structures. Returned as a StructureList (same
  * wire shape as `structures`, just filtered server-side to
- * `structure_type = 'coa_mapping'`).
+ * `block_type = 'coa_mapping'`).
  */
 export declare const LIST_MAPPINGS: string;

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

@@ -5,7 +5,7 @@ const graphql_request_1 = require("graphql-request");
 /**
  * All active coa_mapping structures. Returned as a StructureList (same
  * wire shape as `structures`, just filtered server-side to
- * `structure_type = 'coa_mapping'`).
+ * `block_type = 'coa_mapping'`).
  */
 exports.LIST_MAPPINGS = (0, graphql_request_1.gql) `
   query ListLedgerMappings {
@@ -14,7 +14,7 @@ exports.LIST_MAPPINGS = (0, graphql_request_1.gql) `
         id
         name
         description
-        structureType
+        blockType
         taxonomyId
         isActive
       }

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

@@ -3,7 +3,7 @@ import { gql } from 'graphql-request'
 /**
  * All active coa_mapping structures. Returned as a StructureList (same
  * wire shape as `structures`, just filtered server-side to
- * `structure_type = 'coa_mapping'`).
+ * `block_type = 'coa_mapping'`).
  */
 export const LIST_MAPPINGS = gql`
   query ListLedgerMappings {
@@ -12,7 +12,7 @@ export const LIST_MAPPINGS = gql`
         id
         name
         description
-        structureType
+        blockType
         taxonomyId
         isActive
       }

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

@@ -33,7 +33,7 @@ exports.GET_REPORT = (0, graphql_request_1.gql) `
       structures {
         id
         name
-        structureType
+        blockType
       }
     }
   }

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

@@ -31,7 +31,7 @@ export const GET_REPORT = gql`
       structures {
         id
         name
-        structureType
+        blockType
       }
     }
   }

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

@@ -2,7 +2,7 @@
  * Report rehydrated as a package — Report metadata + N rendered
  * Information Block envelopes (one per attached FactSet). Drives the
  * `/reports/[id]` package viewer; replaces the per-statement
- * `getStatement(reportId, structureType)` round-trip flow.
+ * `getStatement(reportId, blockType)` round-trip flow.
  *
  * Each item's `block` is a fully-rehydrated `InformationBlock` envelope
  * pinned to its specific FactSet snapshot, so the frontend can render

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

@@ -6,7 +6,7 @@ const graphql_request_1 = require("graphql-request");
  * Report rehydrated as a package — Report metadata + N rendered
  * Information Block envelopes (one per attached FactSet). Drives the
  * `/reports/[id]` package viewer; replaces the per-statement
- * `getStatement(reportId, structureType)` round-trip flow.
+ * `getStatement(reportId, blockType)` round-trip flow.
  *
  * Each item's `block` is a fully-rehydrated `InformationBlock` envelope
  * pinned to its specific FactSet snapshot, so the frontend can render
@@ -54,7 +54,7 @@ exports.GET_REPORT_PACKAGE = (0, graphql_request_1.gql) `
           }
           artifact {
             topic
-            parentheticalNote
+            rendererNote
             template
             mechanics
           }
@@ -97,6 +97,14 @@ exports.GET_REPORT_PACKAGE = (0, graphql_request_1.gql) `
             ruleMessage
             ruleSeverity
             ruleOrigin
+            ruleTarget {
+              targetKind
+              targetRefId
+            }
+            ruleVariables {
+              variableName
+              variableQname
+            }
           }
           factSet {
             id

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

@@ -4,7 +4,7 @@ import { gql } from 'graphql-request'
  * Report rehydrated as a package — Report metadata + N rendered
  * Information Block envelopes (one per attached FactSet). Drives the
  * `/reports/[id]` package viewer; replaces the per-statement
- * `getStatement(reportId, structureType)` round-trip flow.
+ * `getStatement(reportId, blockType)` round-trip flow.
  *
  * Each item's `block` is a fully-rehydrated `InformationBlock` envelope
  * pinned to its specific FactSet snapshot, so the frontend can render
@@ -52,7 +52,7 @@ export const GET_REPORT_PACKAGE = gql`
           }
           artifact {
             topic
-            parentheticalNote
+            rendererNote
             template
             mechanics
           }
@@ -95,6 +95,14 @@ export const GET_REPORT_PACKAGE = gql`
             ruleMessage
             ruleSeverity
             ruleOrigin
+            ruleTarget {
+              targetKind
+              targetRefId
+            }
+            ruleVariables {
+              variableName
+              variableQname
+            }
           }
           factSet {
             id

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

@@ -37,7 +37,7 @@ exports.LIST_REPORTS = (0, graphql_request_1.gql) `
         structures {
           id
           name
-          structureType
+          blockType
         }
       }
     }

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

@@ -35,7 +35,7 @@ export const LIST_REPORTS = gql`
         structures {
           id
           name
-          structureType
+          blockType
         }
       }
     }

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

@@ -1,5 +1,5 @@
 /**
- * Render a financial statement for a report + structure_type.
+ * Render a financial statement for a report + block_type.
  *
  * Structure types: `income_statement`, `balance_sheet`,
  * `equity_statement`, `custom`. Returns hierarchically-ordered rows

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

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.GET_STATEMENT = void 0;
 const graphql_request_1 = require("graphql-request");
 /**
- * Render a financial statement for a report + structure_type.
+ * Render a financial statement for a report + block_type.
  *
  * Structure types: `income_statement`, `balance_sheet`,
  * `equity_statement`, `custom`. Returns hierarchically-ordered rows
@@ -11,12 +11,12 @@ const graphql_request_1 = require("graphql-request");
  * The caller usually renders `rows` directly as a nested tree.
  */
 exports.GET_STATEMENT = (0, graphql_request_1.gql) `
-  query GetLedgerStatement($reportId: String!, $structureType: String!) {
-    statement(reportId: $reportId, structureType: $structureType) {
+  query GetLedgerStatement($reportId: String!, $blockType: String!) {
+    statement(reportId: $reportId, blockType: $blockType) {
       reportId
       structureId
       structureName
-      structureType
+      blockType
       unmappedCount
       periods {
         start

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

@@ -1,7 +1,7 @@
 import { gql } from 'graphql-request'
 
 /**
- * Render a financial statement for a report + structure_type.
+ * Render a financial statement for a report + block_type.
  *
  * Structure types: `income_statement`, `balance_sheet`,
  * `equity_statement`, `custom`. Returns hierarchically-ordered rows
@@ -9,12 +9,12 @@ import { gql } from 'graphql-request'
  * The caller usually renders `rows` directly as a nested tree.
  */
 export const GET_STATEMENT = gql`
-  query GetLedgerStatement($reportId: String!, $structureType: String!) {
-    statement(reportId: $reportId, structureType: $structureType) {
+  query GetLedgerStatement($reportId: String!, $blockType: String!) {
+    statement(reportId: $reportId, blockType: $blockType) {
       reportId
       structureId
       structureName
-      structureType
+      blockType
       unmappedCount
       periods {
         start

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

@@ -7,13 +7,13 @@ const graphql_request_1 = require("graphql-request");
  * (e.g. "coa_mapping", "statement_income", "schedule").
  */
 exports.LIST_STRUCTURES = (0, graphql_request_1.gql) `
-  query ListLedgerStructures($taxonomyId: String, $structureType: String) {
-    structures(taxonomyId: $taxonomyId, structureType: $structureType) {
+  query ListLedgerStructures($taxonomyId: String, $blockType: String) {
+    structures(taxonomyId: $taxonomyId, blockType: $blockType) {
       structures {
         id
         name
         description
-        structureType
+        blockType
         taxonomyId
         isActive
       }

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

@@ -5,13 +5,13 @@ import { gql } from 'graphql-request'
  * (e.g. "coa_mapping", "statement_income", "schedule").
  */
 export const LIST_STRUCTURES = gql`
-  query ListLedgerStructures($taxonomyId: String, $structureType: String) {
-    structures(taxonomyId: $taxonomyId, structureType: $structureType) {
+  query ListLedgerStructures($taxonomyId: String, $blockType: String) {
+    structures(taxonomyId: $taxonomyId, blockType: $blockType) {
       structures {
         id
         name
         description
-        structureType
+        blockType
         taxonomyId
         isActive
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@robosystems/client",
-  "version": "0.3.24",
+  "version": "0.3.26",
   "description": "TypeScript client library for RoboSystems Financial Knowledge Graph API",
   "main": "index.js",
   "types": "index.d.ts",

package/sdk/types.gen.d.ts

@@ -448,11 +448,11 @@ export type ArtifactResponse = {
      */
     topic?: string | null;
     /**
-     * Parenthetical Note
+     * Renderer Note
      *
      * e.g. 'in thousands', 'except per share'.
      */
-    parenthetical_note?: string | null;
+    renderer_note?: string | null;
     /**
      * Template
      *
@@ -1028,7 +1028,7 @@ export type CancelSubscriptionRequest = {
  *
  * Switches the graph to a different Reporting Style. The target Style
  * must be a library- or customer-authored Structure with
- * ``structure_type='reporting_style'`` and a complete composition
+ * ``block_type='reporting_style'`` and a complete composition
  * (one Network per required statement type — BS / IS / CF / SE). Filed
  * Reports are unaffected because each ``Report`` already pins its own
  * ``structure_id`` per FactSet at create-time; new reports use the new
@@ -1038,7 +1038,7 @@ export type ChangeReportingStyleOp = {
     /**
      * Reporting Style Id
      *
-     * Structure id of the target Reporting Style (e.g., `025f5d48-12ce-5d65-b9eb-4f137a10ef06` for the library-seeded Default Style). Must resolve to a Structure with structure_type='reporting_style' that has a complete composition in the graph's tenant schema.
+     * Structure id of the target Reporting Style (e.g., `025f5d48-12ce-5d65-b9eb-4f137a10ef06` for the library-seeded Default Style). Must resolve to a Structure with block_type='reporting_style' that has a complete composition in the graph's tenant schema.
      */
     reporting_style_id: string;
 };
@@ -1160,7 +1160,7 @@ export type ClassificationLite = {
     /**
      * Identifier
      *
-     * Vocabulary identifier within the category — e.g. 'RollUp', 'aggregation', 'AssetsRollUp'.
+     * Vocabulary identifier within the category — e.g. 'RollUp', 'whole_part', 'AssetsRollUp'.
      */
     identifier: string;
     /**
@@ -5654,7 +5654,7 @@ export type InformationModelResponse = {
     /**
      * Member Arrangement
      *
-     * aggregation | nonaggregation, or null if non-hypercube.
+     * is_a | whole_part | nested_whole_part | two_dimension_aggregation | complex_aggregating_whole_part, or null if non-hypercube.
      */
     member_arrangement?: string | null;
 };
@@ -9708,9 +9708,15 @@ export type RuleLite = {
     /**
      * Rule Pattern
      *
-     * One of 10 cm:BusinessRulePattern mechanisms — Adjustment, CoExists, EqualTo, Exists, GreaterThan, GreaterThanOrEqualToZero, LessThan, RollForward, RollUp, Variance.
+     * Arithmetic / logical pattern evaluated over fact values. One of 11 cm:BusinessRulePattern mechanisms — Adjustment, CoExists, EqualTo, Exists, GreaterThan, GreaterThanOrEqualToZero, LessThan, RollForward, RollUp, SumEquals, Variance. Null when the rule is a structural check (see rule_check_kind).
      */
-    rule_pattern: string;
+    rule_pattern?: string | null;
+    /**
+     * Rule Check Kind
+     *
+     * Model-structure check kind evaluated over the association graph. One of 6 kinds — LeafHasClassification, LibraryOriginImmutability, NoCycles, NoOrphanArcs, ParentBeforeChild, UniqueQNameInTaxonomy. Null when the rule is an arithmetic pattern (see rule_pattern). Exactly one of rule_pattern / rule_check_kind is non-null per rule.
+     */
+    rule_check_kind?: string | null;
     /**
      * Rule Expression
      */
@@ -10717,11 +10723,11 @@ export type StructureSummary = {
      */
     name: string;
     /**
-     * Structure Type
+     * Block Type
      *
      * Structure category: `balance_sheet`, `income_statement`, `cash_flow_statement`, `equity_statement`, `schedule`.
      */
-    structure_type: string;
+    block_type: string;
 };
 /**
  * StructureUpdatePatch
@@ -11574,9 +11580,9 @@ export type TaxonomyBlockStructure = {
      */
     name: string;
     /**
-     * Structure Type
+     * Block Type
      */
-    structure_type: string;
+    block_type: string;
     /**
      * Description
      */
@@ -11599,11 +11605,11 @@ export type TaxonomyBlockStructureRequest = {
      */
     name: string;
     /**
-     * Structure Type
+     * Block Type
      *
-     * DB ``structures.structure_type`` enum. CoA blocks use ``chart_of_accounts``; reporting extensions use the statement family or ``custom``; custom ontology uses ``custom``.
+     * DB ``structures.block_type`` enum. CoA blocks use ``chart_of_accounts``; reporting extensions use the statement family or ``custom``; custom ontology uses ``custom``.
      */
-    structure_type: 'chart_of_accounts' | 'custom' | 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'coa_mapping' | 'schedule' | 'rollforward' | 'reconciliation' | 'policy' | 'metric';
+    block_type: 'chart_of_accounts' | 'custom' | 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'coa_mapping' | 'schedule' | 'rollforward' | 'reconciliation' | 'policy' | 'metric';
     /**
      * Description
      */

package/sdk/types.gen.ts

@@ -464,11 +464,11 @@ export type ArtifactResponse = {
      */
     topic?: string | null;
     /**
-     * Parenthetical Note
+     * Renderer Note
      *
      * e.g. 'in thousands', 'except per share'.
      */
-    parenthetical_note?: string | null;
+    renderer_note?: string | null;
     /**
      * Template
      *
@@ -1061,7 +1061,7 @@ export type CancelSubscriptionRequest = {
  *
  * Switches the graph to a different Reporting Style. The target Style
  * must be a library- or customer-authored Structure with
- * ``structure_type='reporting_style'`` and a complete composition
+ * ``block_type='reporting_style'`` and a complete composition
  * (one Network per required statement type — BS / IS / CF / SE). Filed
  * Reports are unaffected because each ``Report`` already pins its own
  * ``structure_id`` per FactSet at create-time; new reports use the new
@@ -1071,7 +1071,7 @@ export type ChangeReportingStyleOp = {
     /**
      * Reporting Style Id
      *
-     * Structure id of the target Reporting Style (e.g., `025f5d48-12ce-5d65-b9eb-4f137a10ef06` for the library-seeded Default Style). Must resolve to a Structure with structure_type='reporting_style' that has a complete composition in the graph's tenant schema.
+     * Structure id of the target Reporting Style (e.g., `025f5d48-12ce-5d65-b9eb-4f137a10ef06` for the library-seeded Default Style). Must resolve to a Structure with block_type='reporting_style' that has a complete composition in the graph's tenant schema.
      */
     reporting_style_id: string;
 };
@@ -1197,7 +1197,7 @@ export type ClassificationLite = {
     /**
      * Identifier
      *
-     * Vocabulary identifier within the category — e.g. 'RollUp', 'aggregation', 'AssetsRollUp'.
+     * Vocabulary identifier within the category — e.g. 'RollUp', 'whole_part', 'AssetsRollUp'.
      */
     identifier: string;
     /**
@@ -5795,7 +5795,7 @@ export type InformationModelResponse = {
     /**
      * Member Arrangement
      *
-     * aggregation | nonaggregation, or null if non-hypercube.
+     * is_a | whole_part | nested_whole_part | two_dimension_aggregation | complex_aggregating_whole_part, or null if non-hypercube.
      */
     member_arrangement?: string | null;
 };
@@ -9948,9 +9948,15 @@ export type RuleLite = {
     /**
      * Rule Pattern
      *
-     * One of 10 cm:BusinessRulePattern mechanisms — Adjustment, CoExists, EqualTo, Exists, GreaterThan, GreaterThanOrEqualToZero, LessThan, RollForward, RollUp, Variance.
+     * Arithmetic / logical pattern evaluated over fact values. One of 11 cm:BusinessRulePattern mechanisms — Adjustment, CoExists, EqualTo, Exists, GreaterThan, GreaterThanOrEqualToZero, LessThan, RollForward, RollUp, SumEquals, Variance. Null when the rule is a structural check (see rule_check_kind).
      */
-    rule_pattern: string;
+    rule_pattern?: string | null;
+    /**
+     * Rule Check Kind
+     *
+     * Model-structure check kind evaluated over the association graph. One of 6 kinds — LeafHasClassification, LibraryOriginImmutability, NoCycles, NoOrphanArcs, ParentBeforeChild, UniqueQNameInTaxonomy. Null when the rule is an arithmetic pattern (see rule_pattern). Exactly one of rule_pattern / rule_check_kind is non-null per rule.
+     */
+    rule_check_kind?: string | null;
     /**
      * Rule Expression
      */
@@ -10986,11 +10992,11 @@ export type StructureSummary = {
      */
     name: string;
     /**
-     * Structure Type
+     * Block Type
      *
      * Structure category: `balance_sheet`, `income_statement`, `cash_flow_statement`, `equity_statement`, `schedule`.
      */
-    structure_type: string;
+    block_type: string;
 };
 
 /**
@@ -11862,9 +11868,9 @@ export type TaxonomyBlockStructure = {
      */
     name: string;
     /**
-     * Structure Type
+     * Block Type
      */
-    structure_type: string;
+    block_type: string;
     /**
      * Description
      */
@@ -11888,11 +11894,11 @@ export type TaxonomyBlockStructureRequest = {
      */
     name: string;
     /**
-     * Structure Type
+     * Block Type
      *
-     * DB ``structures.structure_type`` enum. CoA blocks use ``chart_of_accounts``; reporting extensions use the statement family or ``custom``; custom ontology uses ``custom``.
+     * DB ``structures.block_type`` enum. CoA blocks use ``chart_of_accounts``; reporting extensions use the statement family or ``custom``; custom ontology uses ``custom``.
      */
-    structure_type: 'chart_of_accounts' | 'custom' | 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'coa_mapping' | 'schedule' | 'rollforward' | 'reconciliation' | 'policy' | 'metric';
+    block_type: 'chart_of_accounts' | 'custom' | 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'coa_mapping' | 'schedule' | 'rollforward' | 'reconciliation' | 'policy' | 'metric';
     /**
      * Description
      */