@robosystems/client 0.5.6 → 0.5.8
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.
- package/artifacts/LedgerClient.d.ts +18 -1
- package/artifacts/LedgerClient.js +20 -2
- package/artifacts/LedgerClient.ts +25 -2
- package/artifacts/graphql/generated/graphql.d.ts +17 -1
- package/artifacts/graphql/generated/graphql.js +43 -0
- package/artifacts/graphql/generated/graphql.ts +60 -4
- package/artifacts/graphql/queries/ledger/informationBlock.js +20 -4
- package/artifacts/graphql/queries/ledger/informationBlock.ts +20 -4
- package/artifacts/graphql/queries/ledger/reportPackage.js +2 -0
- package/artifacts/graphql/queries/ledger/reportPackage.ts +2 -0
- package/index.ts +2 -2
- package/package.json +1 -1
- package/sdk/index.d.ts +2 -2
- package/sdk/index.js +5 -4
- package/sdk/index.ts +2 -2
- package/sdk/sdk.gen.d.ts +9 -1
- package/sdk/sdk.gen.js +19 -2
- package/sdk/sdk.gen.ts +18 -1
- package/sdk/types.gen.d.ts +601 -2
- package/sdk/types.gen.ts +620 -2
- package/sdk.gen.d.ts +9 -1
- package/sdk.gen.js +19 -2
- package/sdk.gen.ts +18 -1
- package/types.gen.d.ts +601 -2
- package/types.gen.ts +620 -2
|
@@ -368,18 +368,35 @@ export declare class LedgerClient {
|
|
|
368
368
|
* Fetch an Information Block envelope by id — the generic
|
|
369
369
|
* cross-block-type read. Returns `null` when the block doesn't exist
|
|
370
370
|
* (or its type isn't registered). See `information-block.md`.
|
|
371
|
+
*
|
|
372
|
+
* `options.scenarioId` selects the FactSet slice: omitted = actuals;
|
|
373
|
+
* a forecast block's structure id = that scenario's parallel universe
|
|
374
|
+
* (statement envelopes bind its latest computed month, metric
|
|
375
|
+
* envelopes extend the series with "(forecast)"-labeled columns).
|
|
376
|
+
*
|
|
377
|
+
* `options.series` renders a statement block as its whole report-set
|
|
378
|
+
* time series — one column per period; combined with `scenarioId` the
|
|
379
|
+
* columns cross the actuals/forecast seam and forecast columns carry
|
|
380
|
+
* `periods[].forecast === true`. Non-statement block types ignore it
|
|
381
|
+
* (metric envelopes are always the full series).
|
|
371
382
|
*/
|
|
372
|
-
getInformationBlock(graphId: string, id: string
|
|
383
|
+
getInformationBlock(graphId: string, id: string, options?: {
|
|
384
|
+
scenarioId?: string;
|
|
385
|
+
series?: boolean;
|
|
386
|
+
}): Promise<InformationBlock | null>;
|
|
373
387
|
/**
|
|
374
388
|
* List Information Block envelopes with optional block_type + category
|
|
375
389
|
* filters. Replaces the old `listSchedules` method — callers use
|
|
376
390
|
* `{blockType: 'schedule'}` to get the same set of blocks.
|
|
391
|
+
* `options.scenarioId` threads into each envelope's FactSet binding
|
|
392
|
+
* (the block list itself is scenario-independent).
|
|
377
393
|
*/
|
|
378
394
|
listInformationBlocks(graphId: string, options?: {
|
|
379
395
|
blockType?: string;
|
|
380
396
|
category?: string;
|
|
381
397
|
limit?: number;
|
|
382
398
|
offset?: number;
|
|
399
|
+
scenarioId?: string;
|
|
383
400
|
}): Promise<InformationBlockList>;
|
|
384
401
|
/** Create a new schedule with pre-generated monthly facts. */
|
|
385
402
|
/**
|
|
@@ -254,15 +254,32 @@ class LedgerClient {
|
|
|
254
254
|
* Fetch an Information Block envelope by id — the generic
|
|
255
255
|
* cross-block-type read. Returns `null` when the block doesn't exist
|
|
256
256
|
* (or its type isn't registered). See `information-block.md`.
|
|
257
|
+
*
|
|
258
|
+
* `options.scenarioId` selects the FactSet slice: omitted = actuals;
|
|
259
|
+
* a forecast block's structure id = that scenario's parallel universe
|
|
260
|
+
* (statement envelopes bind its latest computed month, metric
|
|
261
|
+
* envelopes extend the series with "(forecast)"-labeled columns).
|
|
262
|
+
*
|
|
263
|
+
* `options.series` renders a statement block as its whole report-set
|
|
264
|
+
* time series — one column per period; combined with `scenarioId` the
|
|
265
|
+
* columns cross the actuals/forecast seam and forecast columns carry
|
|
266
|
+
* `periods[].forecast === true`. Non-statement block types ignore it
|
|
267
|
+
* (metric envelopes are always the full series).
|
|
257
268
|
*/
|
|
258
|
-
async getInformationBlock(graphId, id) {
|
|
259
|
-
const block = await this.gqlQuery(graphId, graphql_1.GetInformationBlockDocument, {
|
|
269
|
+
async getInformationBlock(graphId, id, options) {
|
|
270
|
+
const block = await this.gqlQuery(graphId, graphql_1.GetInformationBlockDocument, {
|
|
271
|
+
id,
|
|
272
|
+
scenarioId: options?.scenarioId ?? null,
|
|
273
|
+
series: options?.series ?? false,
|
|
274
|
+
}, 'Get information block', (data) => data.informationBlock ?? null);
|
|
260
275
|
return block ?? null;
|
|
261
276
|
}
|
|
262
277
|
/**
|
|
263
278
|
* List Information Block envelopes with optional block_type + category
|
|
264
279
|
* filters. Replaces the old `listSchedules` method — callers use
|
|
265
280
|
* `{blockType: 'schedule'}` to get the same set of blocks.
|
|
281
|
+
* `options.scenarioId` threads into each envelope's FactSet binding
|
|
282
|
+
* (the block list itself is scenario-independent).
|
|
266
283
|
*/
|
|
267
284
|
async listInformationBlocks(graphId, options) {
|
|
268
285
|
const blocks = await this.gqlQuery(graphId, graphql_1.ListInformationBlocksDocument, {
|
|
@@ -270,6 +287,7 @@ class LedgerClient {
|
|
|
270
287
|
category: options?.category ?? null,
|
|
271
288
|
limit: options?.limit ?? null,
|
|
272
289
|
offset: options?.offset ?? null,
|
|
290
|
+
scenarioId: options?.scenarioId ?? null,
|
|
273
291
|
}, 'List information blocks', (data) => data.informationBlocks);
|
|
274
292
|
return blocks ?? [];
|
|
275
293
|
}
|
|
@@ -1080,12 +1080,31 @@ export class LedgerClient {
|
|
|
1080
1080
|
* Fetch an Information Block envelope by id — the generic
|
|
1081
1081
|
* cross-block-type read. Returns `null` when the block doesn't exist
|
|
1082
1082
|
* (or its type isn't registered). See `information-block.md`.
|
|
1083
|
+
*
|
|
1084
|
+
* `options.scenarioId` selects the FactSet slice: omitted = actuals;
|
|
1085
|
+
* a forecast block's structure id = that scenario's parallel universe
|
|
1086
|
+
* (statement envelopes bind its latest computed month, metric
|
|
1087
|
+
* envelopes extend the series with "(forecast)"-labeled columns).
|
|
1088
|
+
*
|
|
1089
|
+
* `options.series` renders a statement block as its whole report-set
|
|
1090
|
+
* time series — one column per period; combined with `scenarioId` the
|
|
1091
|
+
* columns cross the actuals/forecast seam and forecast columns carry
|
|
1092
|
+
* `periods[].forecast === true`. Non-statement block types ignore it
|
|
1093
|
+
* (metric envelopes are always the full series).
|
|
1083
1094
|
*/
|
|
1084
|
-
async getInformationBlock(
|
|
1095
|
+
async getInformationBlock(
|
|
1096
|
+
graphId: string,
|
|
1097
|
+
id: string,
|
|
1098
|
+
options?: { scenarioId?: string; series?: boolean }
|
|
1099
|
+
): Promise<InformationBlock | null> {
|
|
1085
1100
|
const block = await this.gqlQuery(
|
|
1086
1101
|
graphId,
|
|
1087
1102
|
GetInformationBlockDocument,
|
|
1088
|
-
{
|
|
1103
|
+
{
|
|
1104
|
+
id,
|
|
1105
|
+
scenarioId: options?.scenarioId ?? null,
|
|
1106
|
+
series: options?.series ?? false,
|
|
1107
|
+
},
|
|
1089
1108
|
'Get information block',
|
|
1090
1109
|
(data) => data.informationBlock ?? null
|
|
1091
1110
|
)
|
|
@@ -1096,6 +1115,8 @@ export class LedgerClient {
|
|
|
1096
1115
|
* List Information Block envelopes with optional block_type + category
|
|
1097
1116
|
* filters. Replaces the old `listSchedules` method — callers use
|
|
1098
1117
|
* `{blockType: 'schedule'}` to get the same set of blocks.
|
|
1118
|
+
* `options.scenarioId` threads into each envelope's FactSet binding
|
|
1119
|
+
* (the block list itself is scenario-independent).
|
|
1099
1120
|
*/
|
|
1100
1121
|
async listInformationBlocks(
|
|
1101
1122
|
graphId: string,
|
|
@@ -1104,6 +1125,7 @@ export class LedgerClient {
|
|
|
1104
1125
|
category?: string
|
|
1105
1126
|
limit?: number
|
|
1106
1127
|
offset?: number
|
|
1128
|
+
scenarioId?: string
|
|
1107
1129
|
}
|
|
1108
1130
|
): Promise<InformationBlockList> {
|
|
1109
1131
|
const blocks = await this.gqlQuery(
|
|
@@ -1114,6 +1136,7 @@ export class LedgerClient {
|
|
|
1114
1136
|
category: options?.category ?? null,
|
|
1115
1137
|
limit: options?.limit ?? null,
|
|
1116
1138
|
offset: options?.offset ?? null,
|
|
1139
|
+
scenarioId: options?.scenarioId ?? null,
|
|
1117
1140
|
},
|
|
1118
1141
|
'List information blocks',
|
|
1119
1142
|
(data) => data.informationBlocks
|
|
@@ -606,7 +606,7 @@ export type InformationBlockFact = {
|
|
|
606
606
|
*/
|
|
607
607
|
export type InformationBlockFactSet = {
|
|
608
608
|
entityId: Scalars['String']['output'];
|
|
609
|
-
/** 'report' | 'schedule' | 'custom' | 'disclosure'. Enum closure enforced by the ``public.fact_sets`` CHECK constraint. */
|
|
609
|
+
/** 'report' | 'schedule' | 'custom' | 'disclosure' | 'metric'. Enum closure enforced by the ``public.fact_sets`` CHECK constraint. */
|
|
610
610
|
factsetType: Scalars['String']['output'];
|
|
611
611
|
id: Scalars['String']['output'];
|
|
612
612
|
periodEnd: Scalars['Date']['output'];
|
|
@@ -615,6 +615,8 @@ export type InformationBlockFactSet = {
|
|
|
615
615
|
provenance: Maybe<Scalars['JSON']['output']>;
|
|
616
616
|
/** Back-pointer to the ``reports`` table while ``report_id`` still lives on facts. Drops out once the retirement migration lands. */
|
|
617
617
|
reportId: Maybe<Scalars['String']['output']>;
|
|
618
|
+
/** Scenario axis (the forecast engine). NULL = actuals; non-NULL names the owning forecast block whose parallel universe this set belongs to. */
|
|
619
|
+
scenarioId: Maybe<Scalars['String']['output']>;
|
|
618
620
|
structureId: Maybe<Scalars['String']['output']>;
|
|
619
621
|
};
|
|
620
622
|
/**
|
|
@@ -635,6 +637,8 @@ export type InformationBlockRendering = {
|
|
|
635
637
|
/** One period column in a rendered statement. */
|
|
636
638
|
export type InformationBlockRenderingPeriod = {
|
|
637
639
|
end: Scalars['Date']['output'];
|
|
640
|
+
/** True when this column comes from a forecast scenario's FactSet — the machine-readable seam marker (labels also carry a '(forecast)' suffix, but consumers should key styling off this flag, not label parsing). None/absent = an actuals column. */
|
|
641
|
+
forecast: Maybe<Scalars['Boolean']['output']>;
|
|
638
642
|
label: Maybe<Scalars['String']['output']>;
|
|
639
643
|
start: Scalars['Date']['output'];
|
|
640
644
|
};
|
|
@@ -1619,12 +1623,15 @@ export type QueryHoldingsArgs = {
|
|
|
1619
1623
|
};
|
|
1620
1624
|
export type QueryInformationBlockArgs = {
|
|
1621
1625
|
id: Scalars['ID']['input'];
|
|
1626
|
+
scenarioId?: InputMaybe<Scalars['String']['input']>;
|
|
1627
|
+
series?: Scalars['Boolean']['input'];
|
|
1622
1628
|
};
|
|
1623
1629
|
export type QueryInformationBlocksArgs = {
|
|
1624
1630
|
blockType?: InputMaybe<Scalars['String']['input']>;
|
|
1625
1631
|
category?: InputMaybe<Scalars['String']['input']>;
|
|
1626
1632
|
limit?: InputMaybe<Scalars['Int']['input']>;
|
|
1627
1633
|
offset?: InputMaybe<Scalars['Int']['input']>;
|
|
1634
|
+
scenarioId?: InputMaybe<Scalars['String']['input']>;
|
|
1628
1635
|
};
|
|
1629
1636
|
export type QueryLibraryElementArgs = {
|
|
1630
1637
|
id?: InputMaybe<Scalars['ID']['input']>;
|
|
@@ -2768,6 +2775,8 @@ export type GetLedgerFiscalCalendarQuery = {
|
|
|
2768
2775
|
};
|
|
2769
2776
|
export type GetInformationBlockQueryVariables = Exact<{
|
|
2770
2777
|
id: Scalars['ID']['input'];
|
|
2778
|
+
scenarioId: InputMaybe<Scalars['String']['input']>;
|
|
2779
|
+
series?: Scalars['Boolean']['input'];
|
|
2771
2780
|
}>;
|
|
2772
2781
|
export type GetInformationBlockQuery = {
|
|
2773
2782
|
informationBlock: {
|
|
@@ -2848,6 +2857,7 @@ export type GetInformationBlockQuery = {
|
|
|
2848
2857
|
factsetType: string;
|
|
2849
2858
|
entityId: string;
|
|
2850
2859
|
reportId: string | null;
|
|
2860
|
+
scenarioId: string | null;
|
|
2851
2861
|
provenance: any | null;
|
|
2852
2862
|
} | null;
|
|
2853
2863
|
verificationResults: Array<{
|
|
@@ -2895,6 +2905,7 @@ export type GetInformationBlockQuery = {
|
|
|
2895
2905
|
start: any;
|
|
2896
2906
|
end: any;
|
|
2897
2907
|
label: string | null;
|
|
2908
|
+
forecast: boolean | null;
|
|
2898
2909
|
}>;
|
|
2899
2910
|
validation: {
|
|
2900
2911
|
passed: boolean;
|
|
@@ -2923,6 +2934,7 @@ export type ListInformationBlocksQueryVariables = Exact<{
|
|
|
2923
2934
|
category: InputMaybe<Scalars['String']['input']>;
|
|
2924
2935
|
limit: InputMaybe<Scalars['Int']['input']>;
|
|
2925
2936
|
offset: InputMaybe<Scalars['Int']['input']>;
|
|
2937
|
+
scenarioId: InputMaybe<Scalars['String']['input']>;
|
|
2926
2938
|
}>;
|
|
2927
2939
|
export type ListInformationBlocksQuery = {
|
|
2928
2940
|
informationBlocks: Array<{
|
|
@@ -3003,6 +3015,7 @@ export type ListInformationBlocksQuery = {
|
|
|
3003
3015
|
factsetType: string;
|
|
3004
3016
|
entityId: string;
|
|
3005
3017
|
reportId: string | null;
|
|
3018
|
+
scenarioId: string | null;
|
|
3006
3019
|
provenance: any | null;
|
|
3007
3020
|
} | null;
|
|
3008
3021
|
verificationResults: Array<{
|
|
@@ -3050,6 +3063,7 @@ export type ListInformationBlocksQuery = {
|
|
|
3050
3063
|
start: any;
|
|
3051
3064
|
end: any;
|
|
3052
3065
|
label: string | null;
|
|
3066
|
+
forecast: boolean | null;
|
|
3053
3067
|
}>;
|
|
3054
3068
|
validation: {
|
|
3055
3069
|
passed: boolean;
|
|
@@ -3424,6 +3438,7 @@ export type GetLedgerReportPackageQuery = {
|
|
|
3424
3438
|
factsetType: string;
|
|
3425
3439
|
entityId: string;
|
|
3426
3440
|
reportId: string | null;
|
|
3441
|
+
scenarioId: string | null;
|
|
3427
3442
|
provenance: any | null;
|
|
3428
3443
|
} | null;
|
|
3429
3444
|
verificationResults: Array<{
|
|
@@ -3471,6 +3486,7 @@ export type GetLedgerReportPackageQuery = {
|
|
|
3471
3486
|
start: any;
|
|
3472
3487
|
end: any;
|
|
3473
3488
|
label: string | null;
|
|
3489
|
+
forecast: boolean | null;
|
|
3474
3490
|
}>;
|
|
3475
3491
|
validation: {
|
|
3476
3492
|
passed: boolean;
|
|
@@ -1662,6 +1662,20 @@ exports.GetInformationBlockDocument = {
|
|
|
1662
1662
|
type: { kind: 'NamedType', name: { kind: 'Name', value: 'ID' } },
|
|
1663
1663
|
},
|
|
1664
1664
|
},
|
|
1665
|
+
{
|
|
1666
|
+
kind: 'VariableDefinition',
|
|
1667
|
+
variable: { kind: 'Variable', name: { kind: 'Name', value: 'scenarioId' } },
|
|
1668
|
+
type: { kind: 'NamedType', name: { kind: 'Name', value: 'String' } },
|
|
1669
|
+
},
|
|
1670
|
+
{
|
|
1671
|
+
kind: 'VariableDefinition',
|
|
1672
|
+
variable: { kind: 'Variable', name: { kind: 'Name', value: 'series' } },
|
|
1673
|
+
type: {
|
|
1674
|
+
kind: 'NonNullType',
|
|
1675
|
+
type: { kind: 'NamedType', name: { kind: 'Name', value: 'Boolean' } },
|
|
1676
|
+
},
|
|
1677
|
+
defaultValue: { kind: 'BooleanValue', value: false },
|
|
1678
|
+
},
|
|
1665
1679
|
],
|
|
1666
1680
|
selectionSet: {
|
|
1667
1681
|
kind: 'SelectionSet',
|
|
@@ -1675,6 +1689,16 @@ exports.GetInformationBlockDocument = {
|
|
|
1675
1689
|
name: { kind: 'Name', value: 'id' },
|
|
1676
1690
|
value: { kind: 'Variable', name: { kind: 'Name', value: 'id' } },
|
|
1677
1691
|
},
|
|
1692
|
+
{
|
|
1693
|
+
kind: 'Argument',
|
|
1694
|
+
name: { kind: 'Name', value: 'scenarioId' },
|
|
1695
|
+
value: { kind: 'Variable', name: { kind: 'Name', value: 'scenarioId' } },
|
|
1696
|
+
},
|
|
1697
|
+
{
|
|
1698
|
+
kind: 'Argument',
|
|
1699
|
+
name: { kind: 'Name', value: 'series' },
|
|
1700
|
+
value: { kind: 'Variable', name: { kind: 'Name', value: 'series' } },
|
|
1701
|
+
},
|
|
1678
1702
|
],
|
|
1679
1703
|
selectionSet: {
|
|
1680
1704
|
kind: 'SelectionSet',
|
|
@@ -1817,6 +1841,7 @@ exports.GetInformationBlockDocument = {
|
|
|
1817
1841
|
{ kind: 'Field', name: { kind: 'Name', value: 'factsetType' } },
|
|
1818
1842
|
{ kind: 'Field', name: { kind: 'Name', value: 'entityId' } },
|
|
1819
1843
|
{ kind: 'Field', name: { kind: 'Name', value: 'reportId' } },
|
|
1844
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'scenarioId' } },
|
|
1820
1845
|
{ kind: 'Field', name: { kind: 'Name', value: 'provenance' } },
|
|
1821
1846
|
],
|
|
1822
1847
|
},
|
|
@@ -1911,6 +1936,7 @@ exports.GetInformationBlockDocument = {
|
|
|
1911
1936
|
{ kind: 'Field', name: { kind: 'Name', value: 'start' } },
|
|
1912
1937
|
{ kind: 'Field', name: { kind: 'Name', value: 'end' } },
|
|
1913
1938
|
{ kind: 'Field', name: { kind: 'Name', value: 'label' } },
|
|
1939
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'forecast' } },
|
|
1914
1940
|
],
|
|
1915
1941
|
},
|
|
1916
1942
|
},
|
|
@@ -2006,6 +2032,11 @@ exports.ListInformationBlocksDocument = {
|
|
|
2006
2032
|
variable: { kind: 'Variable', name: { kind: 'Name', value: 'offset' } },
|
|
2007
2033
|
type: { kind: 'NamedType', name: { kind: 'Name', value: 'Int' } },
|
|
2008
2034
|
},
|
|
2035
|
+
{
|
|
2036
|
+
kind: 'VariableDefinition',
|
|
2037
|
+
variable: { kind: 'Variable', name: { kind: 'Name', value: 'scenarioId' } },
|
|
2038
|
+
type: { kind: 'NamedType', name: { kind: 'Name', value: 'String' } },
|
|
2039
|
+
},
|
|
2009
2040
|
],
|
|
2010
2041
|
selectionSet: {
|
|
2011
2042
|
kind: 'SelectionSet',
|
|
@@ -2034,6 +2065,11 @@ exports.ListInformationBlocksDocument = {
|
|
|
2034
2065
|
name: { kind: 'Name', value: 'offset' },
|
|
2035
2066
|
value: { kind: 'Variable', name: { kind: 'Name', value: 'offset' } },
|
|
2036
2067
|
},
|
|
2068
|
+
{
|
|
2069
|
+
kind: 'Argument',
|
|
2070
|
+
name: { kind: 'Name', value: 'scenarioId' },
|
|
2071
|
+
value: { kind: 'Variable', name: { kind: 'Name', value: 'scenarioId' } },
|
|
2072
|
+
},
|
|
2037
2073
|
],
|
|
2038
2074
|
selectionSet: {
|
|
2039
2075
|
kind: 'SelectionSet',
|
|
@@ -2176,6 +2212,7 @@ exports.ListInformationBlocksDocument = {
|
|
|
2176
2212
|
{ kind: 'Field', name: { kind: 'Name', value: 'factsetType' } },
|
|
2177
2213
|
{ kind: 'Field', name: { kind: 'Name', value: 'entityId' } },
|
|
2178
2214
|
{ kind: 'Field', name: { kind: 'Name', value: 'reportId' } },
|
|
2215
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'scenarioId' } },
|
|
2179
2216
|
{ kind: 'Field', name: { kind: 'Name', value: 'provenance' } },
|
|
2180
2217
|
],
|
|
2181
2218
|
},
|
|
@@ -2270,6 +2307,7 @@ exports.ListInformationBlocksDocument = {
|
|
|
2270
2307
|
{ kind: 'Field', name: { kind: 'Name', value: 'start' } },
|
|
2271
2308
|
{ kind: 'Field', name: { kind: 'Name', value: 'end' } },
|
|
2272
2309
|
{ kind: 'Field', name: { kind: 'Name', value: 'label' } },
|
|
2310
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'forecast' } },
|
|
2273
2311
|
],
|
|
2274
2312
|
},
|
|
2275
2313
|
},
|
|
@@ -3309,6 +3347,7 @@ exports.GetLedgerReportPackageDocument = {
|
|
|
3309
3347
|
{ kind: 'Field', name: { kind: 'Name', value: 'factsetType' } },
|
|
3310
3348
|
{ kind: 'Field', name: { kind: 'Name', value: 'entityId' } },
|
|
3311
3349
|
{ kind: 'Field', name: { kind: 'Name', value: 'reportId' } },
|
|
3350
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'scenarioId' } },
|
|
3312
3351
|
{ kind: 'Field', name: { kind: 'Name', value: 'provenance' } },
|
|
3313
3352
|
],
|
|
3314
3353
|
},
|
|
@@ -3442,6 +3481,10 @@ exports.GetLedgerReportPackageDocument = {
|
|
|
3442
3481
|
kind: 'Field',
|
|
3443
3482
|
name: { kind: 'Name', value: 'label' },
|
|
3444
3483
|
},
|
|
3484
|
+
{
|
|
3485
|
+
kind: 'Field',
|
|
3486
|
+
name: { kind: 'Name', value: 'forecast' },
|
|
3487
|
+
},
|
|
3445
3488
|
],
|
|
3446
3489
|
},
|
|
3447
3490
|
},
|
|
@@ -605,7 +605,7 @@ export type InformationBlockFact = {
|
|
|
605
605
|
*/
|
|
606
606
|
export type InformationBlockFactSet = {
|
|
607
607
|
entityId: Scalars['String']['output']
|
|
608
|
-
/** 'report' | 'schedule' | 'custom' | 'disclosure'. Enum closure enforced by the ``public.fact_sets`` CHECK constraint. */
|
|
608
|
+
/** 'report' | 'schedule' | 'custom' | 'disclosure' | 'metric'. Enum closure enforced by the ``public.fact_sets`` CHECK constraint. */
|
|
609
609
|
factsetType: Scalars['String']['output']
|
|
610
610
|
id: Scalars['String']['output']
|
|
611
611
|
periodEnd: Scalars['Date']['output']
|
|
@@ -614,6 +614,8 @@ export type InformationBlockFactSet = {
|
|
|
614
614
|
provenance: Maybe<Scalars['JSON']['output']>
|
|
615
615
|
/** Back-pointer to the ``reports`` table while ``report_id`` still lives on facts. Drops out once the retirement migration lands. */
|
|
616
616
|
reportId: Maybe<Scalars['String']['output']>
|
|
617
|
+
/** Scenario axis (the forecast engine). NULL = actuals; non-NULL names the owning forecast block whose parallel universe this set belongs to. */
|
|
618
|
+
scenarioId: Maybe<Scalars['String']['output']>
|
|
617
619
|
structureId: Maybe<Scalars['String']['output']>
|
|
618
620
|
}
|
|
619
621
|
|
|
@@ -636,6 +638,8 @@ export type InformationBlockRendering = {
|
|
|
636
638
|
/** One period column in a rendered statement. */
|
|
637
639
|
export type InformationBlockRenderingPeriod = {
|
|
638
640
|
end: Scalars['Date']['output']
|
|
641
|
+
/** True when this column comes from a forecast scenario's FactSet — the machine-readable seam marker (labels also carry a '(forecast)' suffix, but consumers should key styling off this flag, not label parsing). None/absent = an actuals column. */
|
|
642
|
+
forecast: Maybe<Scalars['Boolean']['output']>
|
|
639
643
|
label: Maybe<Scalars['String']['output']>
|
|
640
644
|
start: Scalars['Date']['output']
|
|
641
645
|
}
|
|
@@ -1681,6 +1685,8 @@ export type QueryHoldingsArgs = {
|
|
|
1681
1685
|
|
|
1682
1686
|
export type QueryInformationBlockArgs = {
|
|
1683
1687
|
id: Scalars['ID']['input']
|
|
1688
|
+
scenarioId?: InputMaybe<Scalars['String']['input']>
|
|
1689
|
+
series?: Scalars['Boolean']['input']
|
|
1684
1690
|
}
|
|
1685
1691
|
|
|
1686
1692
|
export type QueryInformationBlocksArgs = {
|
|
@@ -1688,6 +1694,7 @@ export type QueryInformationBlocksArgs = {
|
|
|
1688
1694
|
category?: InputMaybe<Scalars['String']['input']>
|
|
1689
1695
|
limit?: InputMaybe<Scalars['Int']['input']>
|
|
1690
1696
|
offset?: InputMaybe<Scalars['Int']['input']>
|
|
1697
|
+
scenarioId?: InputMaybe<Scalars['String']['input']>
|
|
1691
1698
|
}
|
|
1692
1699
|
|
|
1693
1700
|
export type QueryLibraryElementArgs = {
|
|
@@ -2894,6 +2901,8 @@ export type GetLedgerFiscalCalendarQuery = {
|
|
|
2894
2901
|
|
|
2895
2902
|
export type GetInformationBlockQueryVariables = Exact<{
|
|
2896
2903
|
id: Scalars['ID']['input']
|
|
2904
|
+
scenarioId: InputMaybe<Scalars['String']['input']>
|
|
2905
|
+
series?: Scalars['Boolean']['input']
|
|
2897
2906
|
}>
|
|
2898
2907
|
|
|
2899
2908
|
export type GetInformationBlockQuery = {
|
|
@@ -2966,6 +2975,7 @@ export type GetInformationBlockQuery = {
|
|
|
2966
2975
|
factsetType: string
|
|
2967
2976
|
entityId: string
|
|
2968
2977
|
reportId: string | null
|
|
2978
|
+
scenarioId: string | null
|
|
2969
2979
|
provenance: any | null
|
|
2970
2980
|
} | null
|
|
2971
2981
|
verificationResults: Array<{
|
|
@@ -3009,7 +3019,7 @@ export type GetInformationBlockQuery = {
|
|
|
3009
3019
|
isSubtotal: boolean
|
|
3010
3020
|
depth: number
|
|
3011
3021
|
}>
|
|
3012
|
-
periods: Array<{ start: any; end: any; label: string | null }>
|
|
3022
|
+
periods: Array<{ start: any; end: any; label: string | null; forecast: boolean | null }>
|
|
3013
3023
|
validation: {
|
|
3014
3024
|
passed: boolean
|
|
3015
3025
|
checks: Array<string>
|
|
@@ -3034,6 +3044,7 @@ export type ListInformationBlocksQueryVariables = Exact<{
|
|
|
3034
3044
|
category: InputMaybe<Scalars['String']['input']>
|
|
3035
3045
|
limit: InputMaybe<Scalars['Int']['input']>
|
|
3036
3046
|
offset: InputMaybe<Scalars['Int']['input']>
|
|
3047
|
+
scenarioId: InputMaybe<Scalars['String']['input']>
|
|
3037
3048
|
}>
|
|
3038
3049
|
|
|
3039
3050
|
export type ListInformationBlocksQuery = {
|
|
@@ -3106,6 +3117,7 @@ export type ListInformationBlocksQuery = {
|
|
|
3106
3117
|
factsetType: string
|
|
3107
3118
|
entityId: string
|
|
3108
3119
|
reportId: string | null
|
|
3120
|
+
scenarioId: string | null
|
|
3109
3121
|
provenance: any | null
|
|
3110
3122
|
} | null
|
|
3111
3123
|
verificationResults: Array<{
|
|
@@ -3149,7 +3161,7 @@ export type ListInformationBlocksQuery = {
|
|
|
3149
3161
|
isSubtotal: boolean
|
|
3150
3162
|
depth: number
|
|
3151
3163
|
}>
|
|
3152
|
-
periods: Array<{ start: any; end: any; label: string | null }>
|
|
3164
|
+
periods: Array<{ start: any; end: any; label: string | null; forecast: boolean | null }>
|
|
3153
3165
|
validation: {
|
|
3154
3166
|
passed: boolean
|
|
3155
3167
|
checks: Array<string>
|
|
@@ -3514,6 +3526,7 @@ export type GetLedgerReportPackageQuery = {
|
|
|
3514
3526
|
factsetType: string
|
|
3515
3527
|
entityId: string
|
|
3516
3528
|
reportId: string | null
|
|
3529
|
+
scenarioId: string | null
|
|
3517
3530
|
provenance: any | null
|
|
3518
3531
|
} | null
|
|
3519
3532
|
verificationResults: Array<{
|
|
@@ -3557,7 +3570,7 @@ export type GetLedgerReportPackageQuery = {
|
|
|
3557
3570
|
isSubtotal: boolean
|
|
3558
3571
|
depth: number
|
|
3559
3572
|
}>
|
|
3560
|
-
periods: Array<{ start: any; end: any; label: string | null }>
|
|
3573
|
+
periods: Array<{ start: any; end: any; label: string | null; forecast: boolean | null }>
|
|
3561
3574
|
validation: {
|
|
3562
3575
|
passed: boolean
|
|
3563
3576
|
checks: Array<string>
|
|
@@ -5733,6 +5746,20 @@ export const GetInformationBlockDocument = {
|
|
|
5733
5746
|
type: { kind: 'NamedType', name: { kind: 'Name', value: 'ID' } },
|
|
5734
5747
|
},
|
|
5735
5748
|
},
|
|
5749
|
+
{
|
|
5750
|
+
kind: 'VariableDefinition',
|
|
5751
|
+
variable: { kind: 'Variable', name: { kind: 'Name', value: 'scenarioId' } },
|
|
5752
|
+
type: { kind: 'NamedType', name: { kind: 'Name', value: 'String' } },
|
|
5753
|
+
},
|
|
5754
|
+
{
|
|
5755
|
+
kind: 'VariableDefinition',
|
|
5756
|
+
variable: { kind: 'Variable', name: { kind: 'Name', value: 'series' } },
|
|
5757
|
+
type: {
|
|
5758
|
+
kind: 'NonNullType',
|
|
5759
|
+
type: { kind: 'NamedType', name: { kind: 'Name', value: 'Boolean' } },
|
|
5760
|
+
},
|
|
5761
|
+
defaultValue: { kind: 'BooleanValue', value: false },
|
|
5762
|
+
},
|
|
5736
5763
|
],
|
|
5737
5764
|
selectionSet: {
|
|
5738
5765
|
kind: 'SelectionSet',
|
|
@@ -5746,6 +5773,16 @@ export const GetInformationBlockDocument = {
|
|
|
5746
5773
|
name: { kind: 'Name', value: 'id' },
|
|
5747
5774
|
value: { kind: 'Variable', name: { kind: 'Name', value: 'id' } },
|
|
5748
5775
|
},
|
|
5776
|
+
{
|
|
5777
|
+
kind: 'Argument',
|
|
5778
|
+
name: { kind: 'Name', value: 'scenarioId' },
|
|
5779
|
+
value: { kind: 'Variable', name: { kind: 'Name', value: 'scenarioId' } },
|
|
5780
|
+
},
|
|
5781
|
+
{
|
|
5782
|
+
kind: 'Argument',
|
|
5783
|
+
name: { kind: 'Name', value: 'series' },
|
|
5784
|
+
value: { kind: 'Variable', name: { kind: 'Name', value: 'series' } },
|
|
5785
|
+
},
|
|
5749
5786
|
],
|
|
5750
5787
|
selectionSet: {
|
|
5751
5788
|
kind: 'SelectionSet',
|
|
@@ -5888,6 +5925,7 @@ export const GetInformationBlockDocument = {
|
|
|
5888
5925
|
{ kind: 'Field', name: { kind: 'Name', value: 'factsetType' } },
|
|
5889
5926
|
{ kind: 'Field', name: { kind: 'Name', value: 'entityId' } },
|
|
5890
5927
|
{ kind: 'Field', name: { kind: 'Name', value: 'reportId' } },
|
|
5928
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'scenarioId' } },
|
|
5891
5929
|
{ kind: 'Field', name: { kind: 'Name', value: 'provenance' } },
|
|
5892
5930
|
],
|
|
5893
5931
|
},
|
|
@@ -5982,6 +6020,7 @@ export const GetInformationBlockDocument = {
|
|
|
5982
6020
|
{ kind: 'Field', name: { kind: 'Name', value: 'start' } },
|
|
5983
6021
|
{ kind: 'Field', name: { kind: 'Name', value: 'end' } },
|
|
5984
6022
|
{ kind: 'Field', name: { kind: 'Name', value: 'label' } },
|
|
6023
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'forecast' } },
|
|
5985
6024
|
],
|
|
5986
6025
|
},
|
|
5987
6026
|
},
|
|
@@ -6077,6 +6116,11 @@ export const ListInformationBlocksDocument = {
|
|
|
6077
6116
|
variable: { kind: 'Variable', name: { kind: 'Name', value: 'offset' } },
|
|
6078
6117
|
type: { kind: 'NamedType', name: { kind: 'Name', value: 'Int' } },
|
|
6079
6118
|
},
|
|
6119
|
+
{
|
|
6120
|
+
kind: 'VariableDefinition',
|
|
6121
|
+
variable: { kind: 'Variable', name: { kind: 'Name', value: 'scenarioId' } },
|
|
6122
|
+
type: { kind: 'NamedType', name: { kind: 'Name', value: 'String' } },
|
|
6123
|
+
},
|
|
6080
6124
|
],
|
|
6081
6125
|
selectionSet: {
|
|
6082
6126
|
kind: 'SelectionSet',
|
|
@@ -6105,6 +6149,11 @@ export const ListInformationBlocksDocument = {
|
|
|
6105
6149
|
name: { kind: 'Name', value: 'offset' },
|
|
6106
6150
|
value: { kind: 'Variable', name: { kind: 'Name', value: 'offset' } },
|
|
6107
6151
|
},
|
|
6152
|
+
{
|
|
6153
|
+
kind: 'Argument',
|
|
6154
|
+
name: { kind: 'Name', value: 'scenarioId' },
|
|
6155
|
+
value: { kind: 'Variable', name: { kind: 'Name', value: 'scenarioId' } },
|
|
6156
|
+
},
|
|
6108
6157
|
],
|
|
6109
6158
|
selectionSet: {
|
|
6110
6159
|
kind: 'SelectionSet',
|
|
@@ -6247,6 +6296,7 @@ export const ListInformationBlocksDocument = {
|
|
|
6247
6296
|
{ kind: 'Field', name: { kind: 'Name', value: 'factsetType' } },
|
|
6248
6297
|
{ kind: 'Field', name: { kind: 'Name', value: 'entityId' } },
|
|
6249
6298
|
{ kind: 'Field', name: { kind: 'Name', value: 'reportId' } },
|
|
6299
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'scenarioId' } },
|
|
6250
6300
|
{ kind: 'Field', name: { kind: 'Name', value: 'provenance' } },
|
|
6251
6301
|
],
|
|
6252
6302
|
},
|
|
@@ -6341,6 +6391,7 @@ export const ListInformationBlocksDocument = {
|
|
|
6341
6391
|
{ kind: 'Field', name: { kind: 'Name', value: 'start' } },
|
|
6342
6392
|
{ kind: 'Field', name: { kind: 'Name', value: 'end' } },
|
|
6343
6393
|
{ kind: 'Field', name: { kind: 'Name', value: 'label' } },
|
|
6394
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'forecast' } },
|
|
6344
6395
|
],
|
|
6345
6396
|
},
|
|
6346
6397
|
},
|
|
@@ -7389,6 +7440,7 @@ export const GetLedgerReportPackageDocument = {
|
|
|
7389
7440
|
{ kind: 'Field', name: { kind: 'Name', value: 'factsetType' } },
|
|
7390
7441
|
{ kind: 'Field', name: { kind: 'Name', value: 'entityId' } },
|
|
7391
7442
|
{ kind: 'Field', name: { kind: 'Name', value: 'reportId' } },
|
|
7443
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'scenarioId' } },
|
|
7392
7444
|
{ kind: 'Field', name: { kind: 'Name', value: 'provenance' } },
|
|
7393
7445
|
],
|
|
7394
7446
|
},
|
|
@@ -7522,6 +7574,10 @@ export const GetLedgerReportPackageDocument = {
|
|
|
7522
7574
|
kind: 'Field',
|
|
7523
7575
|
name: { kind: 'Name', value: 'label' },
|
|
7524
7576
|
},
|
|
7577
|
+
{
|
|
7578
|
+
kind: 'Field',
|
|
7579
|
+
name: { kind: 'Name', value: 'forecast' },
|
|
7580
|
+
},
|
|
7525
7581
|
],
|
|
7526
7582
|
},
|
|
7527
7583
|
},
|
|
@@ -10,8 +10,8 @@ const graphql_request_1 = require("graphql-request");
|
|
|
10
10
|
* branch. See `local/docs/specs/information-block.md` §2.
|
|
11
11
|
*/
|
|
12
12
|
exports.GET_INFORMATION_BLOCK = (0, graphql_request_1.gql) `
|
|
13
|
-
query GetInformationBlock($id: ID!) {
|
|
14
|
-
informationBlock(id: $id) {
|
|
13
|
+
query GetInformationBlock($id: ID!, $scenarioId: String, $series: Boolean! = false) {
|
|
14
|
+
informationBlock(id: $id, scenarioId: $scenarioId, series: $series) {
|
|
15
15
|
id
|
|
16
16
|
blockType
|
|
17
17
|
name
|
|
@@ -89,6 +89,7 @@ exports.GET_INFORMATION_BLOCK = (0, graphql_request_1.gql) `
|
|
|
89
89
|
factsetType
|
|
90
90
|
entityId
|
|
91
91
|
reportId
|
|
92
|
+
scenarioId
|
|
92
93
|
provenance
|
|
93
94
|
}
|
|
94
95
|
verificationResults {
|
|
@@ -135,6 +136,7 @@ exports.GET_INFORMATION_BLOCK = (0, graphql_request_1.gql) `
|
|
|
135
136
|
start
|
|
136
137
|
end
|
|
137
138
|
label
|
|
139
|
+
forecast
|
|
138
140
|
}
|
|
139
141
|
validation {
|
|
140
142
|
passed
|
|
@@ -167,8 +169,20 @@ exports.GET_INFORMATION_BLOCK = (0, graphql_request_1.gql) `
|
|
|
167
169
|
* blocks.
|
|
168
170
|
*/
|
|
169
171
|
exports.LIST_INFORMATION_BLOCKS = (0, graphql_request_1.gql) `
|
|
170
|
-
query ListInformationBlocks(
|
|
171
|
-
|
|
172
|
+
query ListInformationBlocks(
|
|
173
|
+
$blockType: String
|
|
174
|
+
$category: String
|
|
175
|
+
$limit: Int
|
|
176
|
+
$offset: Int
|
|
177
|
+
$scenarioId: String
|
|
178
|
+
) {
|
|
179
|
+
informationBlocks(
|
|
180
|
+
blockType: $blockType
|
|
181
|
+
category: $category
|
|
182
|
+
limit: $limit
|
|
183
|
+
offset: $offset
|
|
184
|
+
scenarioId: $scenarioId
|
|
185
|
+
) {
|
|
172
186
|
id
|
|
173
187
|
blockType
|
|
174
188
|
name
|
|
@@ -246,6 +260,7 @@ exports.LIST_INFORMATION_BLOCKS = (0, graphql_request_1.gql) `
|
|
|
246
260
|
factsetType
|
|
247
261
|
entityId
|
|
248
262
|
reportId
|
|
263
|
+
scenarioId
|
|
249
264
|
provenance
|
|
250
265
|
}
|
|
251
266
|
verificationResults {
|
|
@@ -292,6 +307,7 @@ exports.LIST_INFORMATION_BLOCKS = (0, graphql_request_1.gql) `
|
|
|
292
307
|
start
|
|
293
308
|
end
|
|
294
309
|
label
|
|
310
|
+
forecast
|
|
295
311
|
}
|
|
296
312
|
validation {
|
|
297
313
|
passed
|