@robosystems/client 0.3.25 → 0.3.27

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/artifacts/LedgerClient.d.ts +3 -3
  2. package/artifacts/LedgerClient.js +4 -4
  3. package/artifacts/LedgerClient.ts +5 -5
  4. package/artifacts/graphql/generated/graphql.d.ts +39 -34
  5. package/artifacts/graphql/generated/graphql.js +19 -19
  6. package/artifacts/graphql/generated/graphql.ts +58 -53
  7. package/artifacts/graphql/queries/ledger/closingBookStructures.js +1 -1
  8. package/artifacts/graphql/queries/ledger/closingBookStructures.ts +1 -1
  9. package/artifacts/graphql/queries/ledger/informationBlock.js +4 -2
  10. package/artifacts/graphql/queries/ledger/informationBlock.ts +4 -2
  11. package/artifacts/graphql/queries/ledger/mapping.js +1 -1
  12. package/artifacts/graphql/queries/ledger/mapping.ts +1 -1
  13. package/artifacts/graphql/queries/ledger/mappings.d.ts +1 -1
  14. package/artifacts/graphql/queries/ledger/mappings.js +2 -2
  15. package/artifacts/graphql/queries/ledger/mappings.ts +2 -2
  16. package/artifacts/graphql/queries/ledger/report.js +1 -1
  17. package/artifacts/graphql/queries/ledger/report.ts +1 -1
  18. package/artifacts/graphql/queries/ledger/reportPackage.d.ts +1 -1
  19. package/artifacts/graphql/queries/ledger/reportPackage.js +3 -2
  20. package/artifacts/graphql/queries/ledger/reportPackage.ts +3 -2
  21. package/artifacts/graphql/queries/ledger/reports.js +1 -1
  22. package/artifacts/graphql/queries/ledger/reports.ts +1 -1
  23. package/artifacts/graphql/queries/ledger/statement.d.ts +1 -1
  24. package/artifacts/graphql/queries/ledger/statement.js +4 -4
  25. package/artifacts/graphql/queries/ledger/statement.ts +4 -4
  26. package/artifacts/graphql/queries/ledger/structures.js +3 -3
  27. package/artifacts/graphql/queries/ledger/structures.ts +3 -3
  28. package/package.json +1 -1
  29. package/sdk/types.gen.d.ts +40 -16
  30. package/sdk/types.gen.ts +40 -16
  31. package/types.gen.d.ts +40 -16
  32. package/types.gen.ts +40 -16
@@ -6,7 +6,7 @@ const graphql_request_1 = require("graphql-request");
6
6
  * Report rehydrated as a package — Report metadata + N rendered
7
7
  * Information Block envelopes (one per attached FactSet). Drives the
8
8
  * `/reports/[id]` package viewer; replaces the per-statement
9
- * `getStatement(reportId, structureType)` round-trip flow.
9
+ * `getStatement(reportId, blockType)` round-trip flow.
10
10
  *
11
11
  * Each item's `block` is a fully-rehydrated `InformationBlock` envelope
12
12
  * pinned to its specific FactSet snapshot, so the frontend can render
@@ -54,7 +54,7 @@ exports.GET_REPORT_PACKAGE = (0, graphql_request_1.gql) `
54
54
  }
55
55
  artifact {
56
56
  topic
57
- parentheticalNote
57
+ rendererNote
58
58
  template
59
59
  mechanics
60
60
  }
@@ -93,6 +93,7 @@ exports.GET_REPORT_PACKAGE = (0, graphql_request_1.gql) `
93
93
  id
94
94
  ruleCategory
95
95
  rulePattern
96
+ ruleCheckKind
96
97
  ruleExpression
97
98
  ruleMessage
98
99
  ruleSeverity
@@ -4,7 +4,7 @@ import { gql } from 'graphql-request'
4
4
  * Report rehydrated as a package — Report metadata + N rendered
5
5
  * Information Block envelopes (one per attached FactSet). Drives the
6
6
  * `/reports/[id]` package viewer; replaces the per-statement
7
- * `getStatement(reportId, structureType)` round-trip flow.
7
+ * `getStatement(reportId, blockType)` round-trip flow.
8
8
  *
9
9
  * Each item's `block` is a fully-rehydrated `InformationBlock` envelope
10
10
  * pinned to its specific FactSet snapshot, so the frontend can render
@@ -52,7 +52,7 @@ export const GET_REPORT_PACKAGE = gql`
52
52
  }
53
53
  artifact {
54
54
  topic
55
- parentheticalNote
55
+ rendererNote
56
56
  template
57
57
  mechanics
58
58
  }
@@ -91,6 +91,7 @@ export const GET_REPORT_PACKAGE = gql`
91
91
  id
92
92
  ruleCategory
93
93
  rulePattern
94
+ ruleCheckKind
94
95
  ruleExpression
95
96
  ruleMessage
96
97
  ruleSeverity
@@ -37,7 +37,7 @@ exports.LIST_REPORTS = (0, graphql_request_1.gql) `
37
37
  structures {
38
38
  id
39
39
  name
40
- structureType
40
+ blockType
41
41
  }
42
42
  }
43
43
  }
@@ -35,7 +35,7 @@ export const LIST_REPORTS = gql`
35
35
  structures {
36
36
  id
37
37
  name
38
- structureType
38
+ blockType
39
39
  }
40
40
  }
41
41
  }
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Render a financial statement for a report + structure_type.
2
+ * Render a financial statement for a report + block_type.
3
3
  *
4
4
  * Structure types: `income_statement`, `balance_sheet`,
5
5
  * `equity_statement`, `custom`. Returns hierarchically-ordered rows
@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.GET_STATEMENT = void 0;
4
4
  const graphql_request_1 = require("graphql-request");
5
5
  /**
6
- * Render a financial statement for a report + structure_type.
6
+ * Render a financial statement for a report + block_type.
7
7
  *
8
8
  * Structure types: `income_statement`, `balance_sheet`,
9
9
  * `equity_statement`, `custom`. Returns hierarchically-ordered rows
@@ -11,12 +11,12 @@ const graphql_request_1 = require("graphql-request");
11
11
  * The caller usually renders `rows` directly as a nested tree.
12
12
  */
13
13
  exports.GET_STATEMENT = (0, graphql_request_1.gql) `
14
- query GetLedgerStatement($reportId: String!, $structureType: String!) {
15
- statement(reportId: $reportId, structureType: $structureType) {
14
+ query GetLedgerStatement($reportId: String!, $blockType: String!) {
15
+ statement(reportId: $reportId, blockType: $blockType) {
16
16
  reportId
17
17
  structureId
18
18
  structureName
19
- structureType
19
+ blockType
20
20
  unmappedCount
21
21
  periods {
22
22
  start
@@ -1,7 +1,7 @@
1
1
  import { gql } from 'graphql-request'
2
2
 
3
3
  /**
4
- * Render a financial statement for a report + structure_type.
4
+ * Render a financial statement for a report + block_type.
5
5
  *
6
6
  * Structure types: `income_statement`, `balance_sheet`,
7
7
  * `equity_statement`, `custom`. Returns hierarchically-ordered rows
@@ -9,12 +9,12 @@ import { gql } from 'graphql-request'
9
9
  * The caller usually renders `rows` directly as a nested tree.
10
10
  */
11
11
  export const GET_STATEMENT = gql`
12
- query GetLedgerStatement($reportId: String!, $structureType: String!) {
13
- statement(reportId: $reportId, structureType: $structureType) {
12
+ query GetLedgerStatement($reportId: String!, $blockType: String!) {
13
+ statement(reportId: $reportId, blockType: $blockType) {
14
14
  reportId
15
15
  structureId
16
16
  structureName
17
- structureType
17
+ blockType
18
18
  unmappedCount
19
19
  periods {
20
20
  start
@@ -7,13 +7,13 @@ const graphql_request_1 = require("graphql-request");
7
7
  * (e.g. "coa_mapping", "statement_income", "schedule").
8
8
  */
9
9
  exports.LIST_STRUCTURES = (0, graphql_request_1.gql) `
10
- query ListLedgerStructures($taxonomyId: String, $structureType: String) {
11
- structures(taxonomyId: $taxonomyId, structureType: $structureType) {
10
+ query ListLedgerStructures($taxonomyId: String, $blockType: String) {
11
+ structures(taxonomyId: $taxonomyId, blockType: $blockType) {
12
12
  structures {
13
13
  id
14
14
  name
15
15
  description
16
- structureType
16
+ blockType
17
17
  taxonomyId
18
18
  isActive
19
19
  }
@@ -5,13 +5,13 @@ import { gql } from 'graphql-request'
5
5
  * (e.g. "coa_mapping", "statement_income", "schedule").
6
6
  */
7
7
  export const LIST_STRUCTURES = gql`
8
- query ListLedgerStructures($taxonomyId: String, $structureType: String) {
9
- structures(taxonomyId: $taxonomyId, structureType: $structureType) {
8
+ query ListLedgerStructures($taxonomyId: String, $blockType: String) {
9
+ structures(taxonomyId: $taxonomyId, blockType: $blockType) {
10
10
  structures {
11
11
  id
12
12
  name
13
13
  description
14
- structureType
14
+ blockType
15
15
  taxonomyId
16
16
  isActive
17
17
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@robosystems/client",
3
- "version": "0.3.25",
3
+ "version": "0.3.27",
4
4
  "description": "TypeScript client library for RoboSystems Financial Knowledge Graph API",
5
5
  "main": "index.js",
6
6
  "types": "index.d.ts",
@@ -448,11 +448,11 @@ export type ArtifactResponse = {
448
448
  */
449
449
  topic?: string | null;
450
450
  /**
451
- * Parenthetical Note
451
+ * Renderer Note
452
452
  *
453
453
  * e.g. 'in thousands', 'except per share'.
454
454
  */
455
- parenthetical_note?: string | null;
455
+ renderer_note?: string | null;
456
456
  /**
457
457
  * Template
458
458
  *
@@ -1028,7 +1028,7 @@ export type CancelSubscriptionRequest = {
1028
1028
  *
1029
1029
  * Switches the graph to a different Reporting Style. The target Style
1030
1030
  * must be a library- or customer-authored Structure with
1031
- * ``structure_type='reporting_style'`` and a complete composition
1031
+ * ``block_type='reporting_style'`` and a complete composition
1032
1032
  * (one Network per required statement type — BS / IS / CF / SE). Filed
1033
1033
  * Reports are unaffected because each ``Report`` already pins its own
1034
1034
  * ``structure_id`` per FactSet at create-time; new reports use the new
@@ -1038,7 +1038,7 @@ export type ChangeReportingStyleOp = {
1038
1038
  /**
1039
1039
  * Reporting Style Id
1040
1040
  *
1041
- * 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.
1041
+ * 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.
1042
1042
  */
1043
1043
  reporting_style_id: string;
1044
1044
  };
@@ -1160,7 +1160,7 @@ export type ClassificationLite = {
1160
1160
  /**
1161
1161
  * Identifier
1162
1162
  *
1163
- * Vocabulary identifier within the category — e.g. 'RollUp', 'aggregation', 'AssetsRollUp'.
1163
+ * Vocabulary identifier within the category — e.g. 'RollUp', 'whole_part', 'AssetsRollUp'.
1164
1164
  */
1165
1165
  identifier: string;
1166
1166
  /**
@@ -5654,7 +5654,7 @@ export type InformationModelResponse = {
5654
5654
  /**
5655
5655
  * Member Arrangement
5656
5656
  *
5657
- * aggregation | nonaggregation, or null if non-hypercube.
5657
+ * is_a | whole_part | nested_whole_part | two_dimension_aggregation | complex_aggregating_whole_part, or null if non-hypercube.
5658
5658
  */
5659
5659
  member_arrangement?: string | null;
5660
5660
  };
@@ -9708,9 +9708,15 @@ export type RuleLite = {
9708
9708
  /**
9709
9709
  * Rule Pattern
9710
9710
  *
9711
- * One of 10 cm:BusinessRulePattern mechanisms — Adjustment, CoExists, EqualTo, Exists, GreaterThan, GreaterThanOrEqualToZero, LessThan, RollForward, RollUp, Variance.
9711
+ * 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).
9712
9712
  */
9713
- rule_pattern: string;
9713
+ rule_pattern?: string | null;
9714
+ /**
9715
+ * Rule Check Kind
9716
+ *
9717
+ * 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.
9718
+ */
9719
+ rule_check_kind?: string | null;
9714
9720
  /**
9715
9721
  * Rule Expression
9716
9722
  */
@@ -10717,11 +10723,11 @@ export type StructureSummary = {
10717
10723
  */
10718
10724
  name: string;
10719
10725
  /**
10720
- * Structure Type
10726
+ * Block Type
10721
10727
  *
10722
10728
  * Structure category: `balance_sheet`, `income_statement`, `cash_flow_statement`, `equity_statement`, `schedule`.
10723
10729
  */
10724
- structure_type: string;
10730
+ block_type: string;
10725
10731
  };
10726
10732
  /**
10727
10733
  * StructureUpdatePatch
@@ -11437,6 +11443,11 @@ export type TaxonomyBlockEnvelope = {
11437
11443
  * TaxonomyBlockRule
11438
11444
  *
11439
11445
  * Rule projection for the Taxonomy Block envelope.
11446
+ *
11447
+ * Exactly one of ``rule_pattern`` (arithmetic) or ``rule_check_kind``
11448
+ * (model-structure) is non-null per row, enforced by the
11449
+ * ``check_rule_pattern_kind_xor`` DB constraint. See
11450
+ * information-block.md §5.2.2.
11440
11451
  */
11441
11452
  export type TaxonomyBlockRule = {
11442
11453
  /**
@@ -11454,7 +11465,11 @@ export type TaxonomyBlockRule = {
11454
11465
  /**
11455
11466
  * Rule Pattern
11456
11467
  */
11457
- rule_pattern: string;
11468
+ rule_pattern?: string | null;
11469
+ /**
11470
+ * Rule Check Kind
11471
+ */
11472
+ rule_check_kind?: string | null;
11458
11473
  /**
11459
11474
  * Rule Expression
11460
11475
  */
@@ -11488,6 +11503,15 @@ export type TaxonomyBlockRule = {
11488
11503
  * Exactly one of ``target_structure_ref``, ``target_element_qname``, or
11489
11504
  * ``target_taxonomy_self`` must be set (or all null for a global rule).
11490
11505
  * The ``model_validator`` enforces this contract at the Pydantic layer.
11506
+ *
11507
+ * Only **arithmetic** rule patterns are user-creatable via this API
11508
+ * (the ``rule_pattern`` Literal below). The 6 model-structure check
11509
+ * kinds (``NoCycles``, ``NoOrphanArcs``, ``ParentBeforeChild``,
11510
+ * ``LeafHasClassification``, ``LibraryOriginImmutability``,
11511
+ * ``UniqueQNameInTaxonomy``) are system-managed — they're auto-emitted
11512
+ * by :func:`emit_auto_rules` at taxonomy-block creation time and
11513
+ * populate ``rules.rule_check_kind`` instead of ``rule_pattern``. See
11514
+ * information-block.md §5.2.2 for the axis split.
11491
11515
  */
11492
11516
  export type TaxonomyBlockRuleRequest = {
11493
11517
  /**
@@ -11574,9 +11598,9 @@ export type TaxonomyBlockStructure = {
11574
11598
  */
11575
11599
  name: string;
11576
11600
  /**
11577
- * Structure Type
11601
+ * Block Type
11578
11602
  */
11579
- structure_type: string;
11603
+ block_type: string;
11580
11604
  /**
11581
11605
  * Description
11582
11606
  */
@@ -11599,11 +11623,11 @@ export type TaxonomyBlockStructureRequest = {
11599
11623
  */
11600
11624
  name: string;
11601
11625
  /**
11602
- * Structure Type
11626
+ * Block Type
11603
11627
  *
11604
- * DB ``structures.structure_type`` enum. CoA blocks use ``chart_of_accounts``; reporting extensions use the statement family or ``custom``; custom ontology uses ``custom``.
11628
+ * DB ``structures.block_type`` enum. CoA blocks use ``chart_of_accounts``; reporting extensions use the statement family or ``custom``; custom ontology uses ``custom``.
11605
11629
  */
11606
- structure_type: 'chart_of_accounts' | 'custom' | 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'coa_mapping' | 'schedule' | 'rollforward' | 'reconciliation' | 'policy' | 'metric';
11630
+ block_type: 'chart_of_accounts' | 'custom' | 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'coa_mapping' | 'schedule' | 'rollforward' | 'reconciliation' | 'policy' | 'metric';
11607
11631
  /**
11608
11632
  * Description
11609
11633
  */
package/sdk/types.gen.ts CHANGED
@@ -464,11 +464,11 @@ export type ArtifactResponse = {
464
464
  */
465
465
  topic?: string | null;
466
466
  /**
467
- * Parenthetical Note
467
+ * Renderer Note
468
468
  *
469
469
  * e.g. 'in thousands', 'except per share'.
470
470
  */
471
- parenthetical_note?: string | null;
471
+ renderer_note?: string | null;
472
472
  /**
473
473
  * Template
474
474
  *
@@ -1061,7 +1061,7 @@ export type CancelSubscriptionRequest = {
1061
1061
  *
1062
1062
  * Switches the graph to a different Reporting Style. The target Style
1063
1063
  * must be a library- or customer-authored Structure with
1064
- * ``structure_type='reporting_style'`` and a complete composition
1064
+ * ``block_type='reporting_style'`` and a complete composition
1065
1065
  * (one Network per required statement type — BS / IS / CF / SE). Filed
1066
1066
  * Reports are unaffected because each ``Report`` already pins its own
1067
1067
  * ``structure_id`` per FactSet at create-time; new reports use the new
@@ -1071,7 +1071,7 @@ export type ChangeReportingStyleOp = {
1071
1071
  /**
1072
1072
  * Reporting Style Id
1073
1073
  *
1074
- * 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.
1074
+ * 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.
1075
1075
  */
1076
1076
  reporting_style_id: string;
1077
1077
  };
@@ -1197,7 +1197,7 @@ export type ClassificationLite = {
1197
1197
  /**
1198
1198
  * Identifier
1199
1199
  *
1200
- * Vocabulary identifier within the category — e.g. 'RollUp', 'aggregation', 'AssetsRollUp'.
1200
+ * Vocabulary identifier within the category — e.g. 'RollUp', 'whole_part', 'AssetsRollUp'.
1201
1201
  */
1202
1202
  identifier: string;
1203
1203
  /**
@@ -5795,7 +5795,7 @@ export type InformationModelResponse = {
5795
5795
  /**
5796
5796
  * Member Arrangement
5797
5797
  *
5798
- * aggregation | nonaggregation, or null if non-hypercube.
5798
+ * is_a | whole_part | nested_whole_part | two_dimension_aggregation | complex_aggregating_whole_part, or null if non-hypercube.
5799
5799
  */
5800
5800
  member_arrangement?: string | null;
5801
5801
  };
@@ -9948,9 +9948,15 @@ export type RuleLite = {
9948
9948
  /**
9949
9949
  * Rule Pattern
9950
9950
  *
9951
- * One of 10 cm:BusinessRulePattern mechanisms — Adjustment, CoExists, EqualTo, Exists, GreaterThan, GreaterThanOrEqualToZero, LessThan, RollForward, RollUp, Variance.
9951
+ * 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).
9952
9952
  */
9953
- rule_pattern: string;
9953
+ rule_pattern?: string | null;
9954
+ /**
9955
+ * Rule Check Kind
9956
+ *
9957
+ * 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.
9958
+ */
9959
+ rule_check_kind?: string | null;
9954
9960
  /**
9955
9961
  * Rule Expression
9956
9962
  */
@@ -10986,11 +10992,11 @@ export type StructureSummary = {
10986
10992
  */
10987
10993
  name: string;
10988
10994
  /**
10989
- * Structure Type
10995
+ * Block Type
10990
10996
  *
10991
10997
  * Structure category: `balance_sheet`, `income_statement`, `cash_flow_statement`, `equity_statement`, `schedule`.
10992
10998
  */
10993
- structure_type: string;
10999
+ block_type: string;
10994
11000
  };
10995
11001
 
10996
11002
  /**
@@ -11723,6 +11729,11 @@ export type TaxonomyBlockEnvelope = {
11723
11729
  * TaxonomyBlockRule
11724
11730
  *
11725
11731
  * Rule projection for the Taxonomy Block envelope.
11732
+ *
11733
+ * Exactly one of ``rule_pattern`` (arithmetic) or ``rule_check_kind``
11734
+ * (model-structure) is non-null per row, enforced by the
11735
+ * ``check_rule_pattern_kind_xor`` DB constraint. See
11736
+ * information-block.md §5.2.2.
11726
11737
  */
11727
11738
  export type TaxonomyBlockRule = {
11728
11739
  /**
@@ -11740,7 +11751,11 @@ export type TaxonomyBlockRule = {
11740
11751
  /**
11741
11752
  * Rule Pattern
11742
11753
  */
11743
- rule_pattern: string;
11754
+ rule_pattern?: string | null;
11755
+ /**
11756
+ * Rule Check Kind
11757
+ */
11758
+ rule_check_kind?: string | null;
11744
11759
  /**
11745
11760
  * Rule Expression
11746
11761
  */
@@ -11775,6 +11790,15 @@ export type TaxonomyBlockRule = {
11775
11790
  * Exactly one of ``target_structure_ref``, ``target_element_qname``, or
11776
11791
  * ``target_taxonomy_self`` must be set (or all null for a global rule).
11777
11792
  * The ``model_validator`` enforces this contract at the Pydantic layer.
11793
+ *
11794
+ * Only **arithmetic** rule patterns are user-creatable via this API
11795
+ * (the ``rule_pattern`` Literal below). The 6 model-structure check
11796
+ * kinds (``NoCycles``, ``NoOrphanArcs``, ``ParentBeforeChild``,
11797
+ * ``LeafHasClassification``, ``LibraryOriginImmutability``,
11798
+ * ``UniqueQNameInTaxonomy``) are system-managed — they're auto-emitted
11799
+ * by :func:`emit_auto_rules` at taxonomy-block creation time and
11800
+ * populate ``rules.rule_check_kind`` instead of ``rule_pattern``. See
11801
+ * information-block.md §5.2.2 for the axis split.
11778
11802
  */
11779
11803
  export type TaxonomyBlockRuleRequest = {
11780
11804
  /**
@@ -11862,9 +11886,9 @@ export type TaxonomyBlockStructure = {
11862
11886
  */
11863
11887
  name: string;
11864
11888
  /**
11865
- * Structure Type
11889
+ * Block Type
11866
11890
  */
11867
- structure_type: string;
11891
+ block_type: string;
11868
11892
  /**
11869
11893
  * Description
11870
11894
  */
@@ -11888,11 +11912,11 @@ export type TaxonomyBlockStructureRequest = {
11888
11912
  */
11889
11913
  name: string;
11890
11914
  /**
11891
- * Structure Type
11915
+ * Block Type
11892
11916
  *
11893
- * DB ``structures.structure_type`` enum. CoA blocks use ``chart_of_accounts``; reporting extensions use the statement family or ``custom``; custom ontology uses ``custom``.
11917
+ * DB ``structures.block_type`` enum. CoA blocks use ``chart_of_accounts``; reporting extensions use the statement family or ``custom``; custom ontology uses ``custom``.
11894
11918
  */
11895
- structure_type: 'chart_of_accounts' | 'custom' | 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'coa_mapping' | 'schedule' | 'rollforward' | 'reconciliation' | 'policy' | 'metric';
11919
+ block_type: 'chart_of_accounts' | 'custom' | 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'coa_mapping' | 'schedule' | 'rollforward' | 'reconciliation' | 'policy' | 'metric';
11896
11920
  /**
11897
11921
  * Description
11898
11922
  */
package/types.gen.d.ts CHANGED
@@ -448,11 +448,11 @@ export type ArtifactResponse = {
448
448
  */
449
449
  topic?: string | null;
450
450
  /**
451
- * Parenthetical Note
451
+ * Renderer Note
452
452
  *
453
453
  * e.g. 'in thousands', 'except per share'.
454
454
  */
455
- parenthetical_note?: string | null;
455
+ renderer_note?: string | null;
456
456
  /**
457
457
  * Template
458
458
  *
@@ -1028,7 +1028,7 @@ export type CancelSubscriptionRequest = {
1028
1028
  *
1029
1029
  * Switches the graph to a different Reporting Style. The target Style
1030
1030
  * must be a library- or customer-authored Structure with
1031
- * ``structure_type='reporting_style'`` and a complete composition
1031
+ * ``block_type='reporting_style'`` and a complete composition
1032
1032
  * (one Network per required statement type — BS / IS / CF / SE). Filed
1033
1033
  * Reports are unaffected because each ``Report`` already pins its own
1034
1034
  * ``structure_id`` per FactSet at create-time; new reports use the new
@@ -1038,7 +1038,7 @@ export type ChangeReportingStyleOp = {
1038
1038
  /**
1039
1039
  * Reporting Style Id
1040
1040
  *
1041
- * 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.
1041
+ * 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.
1042
1042
  */
1043
1043
  reporting_style_id: string;
1044
1044
  };
@@ -1160,7 +1160,7 @@ export type ClassificationLite = {
1160
1160
  /**
1161
1161
  * Identifier
1162
1162
  *
1163
- * Vocabulary identifier within the category — e.g. 'RollUp', 'aggregation', 'AssetsRollUp'.
1163
+ * Vocabulary identifier within the category — e.g. 'RollUp', 'whole_part', 'AssetsRollUp'.
1164
1164
  */
1165
1165
  identifier: string;
1166
1166
  /**
@@ -5654,7 +5654,7 @@ export type InformationModelResponse = {
5654
5654
  /**
5655
5655
  * Member Arrangement
5656
5656
  *
5657
- * aggregation | nonaggregation, or null if non-hypercube.
5657
+ * is_a | whole_part | nested_whole_part | two_dimension_aggregation | complex_aggregating_whole_part, or null if non-hypercube.
5658
5658
  */
5659
5659
  member_arrangement?: string | null;
5660
5660
  };
@@ -9708,9 +9708,15 @@ export type RuleLite = {
9708
9708
  /**
9709
9709
  * Rule Pattern
9710
9710
  *
9711
- * One of 10 cm:BusinessRulePattern mechanisms — Adjustment, CoExists, EqualTo, Exists, GreaterThan, GreaterThanOrEqualToZero, LessThan, RollForward, RollUp, Variance.
9711
+ * 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).
9712
9712
  */
9713
- rule_pattern: string;
9713
+ rule_pattern?: string | null;
9714
+ /**
9715
+ * Rule Check Kind
9716
+ *
9717
+ * 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.
9718
+ */
9719
+ rule_check_kind?: string | null;
9714
9720
  /**
9715
9721
  * Rule Expression
9716
9722
  */
@@ -10717,11 +10723,11 @@ export type StructureSummary = {
10717
10723
  */
10718
10724
  name: string;
10719
10725
  /**
10720
- * Structure Type
10726
+ * Block Type
10721
10727
  *
10722
10728
  * Structure category: `balance_sheet`, `income_statement`, `cash_flow_statement`, `equity_statement`, `schedule`.
10723
10729
  */
10724
- structure_type: string;
10730
+ block_type: string;
10725
10731
  };
10726
10732
  /**
10727
10733
  * StructureUpdatePatch
@@ -11437,6 +11443,11 @@ export type TaxonomyBlockEnvelope = {
11437
11443
  * TaxonomyBlockRule
11438
11444
  *
11439
11445
  * Rule projection for the Taxonomy Block envelope.
11446
+ *
11447
+ * Exactly one of ``rule_pattern`` (arithmetic) or ``rule_check_kind``
11448
+ * (model-structure) is non-null per row, enforced by the
11449
+ * ``check_rule_pattern_kind_xor`` DB constraint. See
11450
+ * information-block.md §5.2.2.
11440
11451
  */
11441
11452
  export type TaxonomyBlockRule = {
11442
11453
  /**
@@ -11454,7 +11465,11 @@ export type TaxonomyBlockRule = {
11454
11465
  /**
11455
11466
  * Rule Pattern
11456
11467
  */
11457
- rule_pattern: string;
11468
+ rule_pattern?: string | null;
11469
+ /**
11470
+ * Rule Check Kind
11471
+ */
11472
+ rule_check_kind?: string | null;
11458
11473
  /**
11459
11474
  * Rule Expression
11460
11475
  */
@@ -11488,6 +11503,15 @@ export type TaxonomyBlockRule = {
11488
11503
  * Exactly one of ``target_structure_ref``, ``target_element_qname``, or
11489
11504
  * ``target_taxonomy_self`` must be set (or all null for a global rule).
11490
11505
  * The ``model_validator`` enforces this contract at the Pydantic layer.
11506
+ *
11507
+ * Only **arithmetic** rule patterns are user-creatable via this API
11508
+ * (the ``rule_pattern`` Literal below). The 6 model-structure check
11509
+ * kinds (``NoCycles``, ``NoOrphanArcs``, ``ParentBeforeChild``,
11510
+ * ``LeafHasClassification``, ``LibraryOriginImmutability``,
11511
+ * ``UniqueQNameInTaxonomy``) are system-managed — they're auto-emitted
11512
+ * by :func:`emit_auto_rules` at taxonomy-block creation time and
11513
+ * populate ``rules.rule_check_kind`` instead of ``rule_pattern``. See
11514
+ * information-block.md §5.2.2 for the axis split.
11491
11515
  */
11492
11516
  export type TaxonomyBlockRuleRequest = {
11493
11517
  /**
@@ -11574,9 +11598,9 @@ export type TaxonomyBlockStructure = {
11574
11598
  */
11575
11599
  name: string;
11576
11600
  /**
11577
- * Structure Type
11601
+ * Block Type
11578
11602
  */
11579
- structure_type: string;
11603
+ block_type: string;
11580
11604
  /**
11581
11605
  * Description
11582
11606
  */
@@ -11599,11 +11623,11 @@ export type TaxonomyBlockStructureRequest = {
11599
11623
  */
11600
11624
  name: string;
11601
11625
  /**
11602
- * Structure Type
11626
+ * Block Type
11603
11627
  *
11604
- * DB ``structures.structure_type`` enum. CoA blocks use ``chart_of_accounts``; reporting extensions use the statement family or ``custom``; custom ontology uses ``custom``.
11628
+ * DB ``structures.block_type`` enum. CoA blocks use ``chart_of_accounts``; reporting extensions use the statement family or ``custom``; custom ontology uses ``custom``.
11605
11629
  */
11606
- structure_type: 'chart_of_accounts' | 'custom' | 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'coa_mapping' | 'schedule' | 'rollforward' | 'reconciliation' | 'policy' | 'metric';
11630
+ block_type: 'chart_of_accounts' | 'custom' | 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'coa_mapping' | 'schedule' | 'rollforward' | 'reconciliation' | 'policy' | 'metric';
11607
11631
  /**
11608
11632
  * Description
11609
11633
  */