@robosystems/client 0.5.9 → 0.5.11

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/types.gen.ts CHANGED
@@ -449,6 +449,12 @@ export type BackfillPlanHistoryOperation = {
449
449
  * Override the sync-currency gate on each reclose. Historical months predate the last sync in the normal case, so this is rarely needed.
450
450
  */
451
451
  allow_stale_sync?: boolean;
452
+ /**
453
+ * Restamp
454
+ *
455
+ * Also re-derive months that ALREADY have canonical statement sets (default: skip them). Use after an engine improvement changes what a stamp produces — each month reruns the full reopen → reclose cycle and replaces its sets. A restamp run is not self-resuming (every month in range stays a candidate); advance `start_period` between chunks.
456
+ */
457
+ restamp?: boolean;
452
458
  /**
453
459
  * Note
454
460
  *
@@ -2356,6 +2362,12 @@ export type CreateForecastRequest = {
2356
2362
  * Direct statement-line assertions (manual overrides). Each names a calc-DAG leaf and wins over driver rules and carry-forward for the months it asserts.
2357
2363
  */
2358
2364
  line_assertions?: Array<LineAssertionRequest>;
2365
+ /**
2366
+ * Line Growth
2367
+ *
2368
+ * Per-line growth trajectories. Each names an income-statement leaf and grows it month-over-month at the asserted rate — the generic form of the revenue growth lever, for lines the catalog doesn't drive (opex trajectories, cost-cut ramps).
2369
+ */
2370
+ line_growth?: Array<LineGrowthRequest>;
2359
2371
  /**
2360
2372
  * Entity Id
2361
2373
  *
@@ -3232,9 +3244,27 @@ export type DatabaseHealthResponse = {
3232
3244
  /**
3233
3245
  * Memory Usage Mb
3234
3246
  *
3235
- * Memory usage in MB
3247
+ * Instance memory in use, MB. Only populated for dedicated single-tenant instances; null on shared repositories and packed tiers.
3236
3248
  */
3237
3249
  memory_usage_mb?: number | null;
3250
+ /**
3251
+ * Memory Usage Percent
3252
+ *
3253
+ * Instance memory in use, percent. Expect high values during materialization — the engine deliberately boosts to near the whole instance while rebuilding. Read `resource_status` rather than this number alone. Dedicated instances only.
3254
+ */
3255
+ memory_usage_percent?: number | null;
3256
+ /**
3257
+ * Cpu Usage Percent
3258
+ *
3259
+ * Instance CPU in use, percent. Dedicated single-tenant instances only.
3260
+ */
3261
+ cpu_usage_percent?: number | null;
3262
+ /**
3263
+ * Resource Status
3264
+ *
3265
+ * Interpreted instance load: 'idle' (headroom), 'busy' (working normally — typical while materializing), 'constrained' (sustained pressure worth acting on). Null when resource metrics are not exposed.
3266
+ */
3267
+ resource_status?: string | null;
3238
3268
  /**
3239
3269
  * Storage Usage Mb
3240
3270
  *
@@ -5299,6 +5329,12 @@ export type ForecastMechanics = {
5299
5329
  * Direct statement-line assertions (authoring order) — manual overrides that win over driver rules and carry-forward for the months they name.
5300
5330
  */
5301
5331
  line_assertions?: Array<LineAssertionLite>;
5332
+ /**
5333
+ * Line Growth
5334
+ *
5335
+ * Per-line growth trajectories (authoring order) — each grows an income-statement leaf month-over-month at the asserted rate, compounding from the base month.
5336
+ */
5337
+ line_growth?: Array<LineGrowthLite>;
5302
5338
  /**
5303
5339
  * Computed Months
5304
5340
  *
@@ -5730,11 +5766,11 @@ export type GraphMetricsResponse = {
5730
5766
  [key: string]: number;
5731
5767
  };
5732
5768
  /**
5733
- * Estimated Size
5769
+ * Storage
5734
5770
  *
5735
- * Database size estimates
5771
+ * Measured on-disk storage: total_bytes/kb/mb/gb plus itemized `items` (graph, memory, subgraph, vectors, staging). Carries `error` instead if the instance could not be reached — the fields are absent rather than estimated.
5736
5772
  */
5737
- estimated_size: {
5773
+ storage: {
5738
5774
  [key: string]: unknown;
5739
5775
  };
5740
5776
  /**
@@ -6641,6 +6677,12 @@ export type InstanceUsage = {
6641
6677
  * Per-database storage breakdown
6642
6678
  */
6643
6679
  databases?: Array<DatabaseStorageEntry>;
6680
+ /**
6681
+ * Items
6682
+ *
6683
+ * Itemized storage by type — graph, memory, subgraph, vectors, staging. Sums to total_storage_gb.
6684
+ */
6685
+ items?: Array<StorageItem>;
6644
6686
  };
6645
6687
 
6646
6688
  /**
@@ -7402,6 +7444,98 @@ export type LineAssertionRequest = {
7402
7444
  } | null;
7403
7445
  };
7404
7446
 
7447
+ /**
7448
+ * LineGrowthLite
7449
+ *
7450
+ * One statement line's persisted growth trajectory inside
7451
+ * ``ForecastMechanics``.
7452
+ *
7453
+ * The generic per-line form of the revenue growth lever: grows an
7454
+ * income-statement leaf month-over-month at the asserted rate
7455
+ * (``line[t] = line[t-1] * (1 + rate[t])``), compounding from the base
7456
+ * month's value. Months without a rate keep the engine's carry-forward.
7457
+ * Duration leaves only; disjoint from ``line_assertions`` and from any
7458
+ * active catalog rule's target (one owner per line).
7459
+ *
7460
+ * Persistence deviates from levers/assertions deliberately: rates are
7461
+ * NOT duplicated as facts in the scenario FactSet — a growth rate on a
7462
+ * monetary statement element would be a unit-lying fact. This mechanics
7463
+ * copy is the single authored store; ``compute-forecast`` binds rates
7464
+ * from here.
7465
+ */
7466
+ export type LineGrowthLite = {
7467
+ /**
7468
+ * Qname
7469
+ *
7470
+ * Grown statement-leaf qname.
7471
+ */
7472
+ qname: string;
7473
+ /**
7474
+ * Element Id
7475
+ *
7476
+ * Resolved tenant element id.
7477
+ */
7478
+ element_id: string;
7479
+ /**
7480
+ * Item Type
7481
+ *
7482
+ * Always 'percent' — the grid row renders rates, not values.
7483
+ */
7484
+ item_type?: string;
7485
+ /**
7486
+ * Values By Period
7487
+ *
7488
+ * Expanded per-month growth rates keyed by ``YYYY-MM``.
7489
+ */
7490
+ values_by_period: {
7491
+ [key: string]: number;
7492
+ };
7493
+ };
7494
+
7495
+ /**
7496
+ * LineGrowthRequest
7497
+ *
7498
+ * One statement line's asserted growth trajectory for the scenario.
7499
+ *
7500
+ * The generic per-line sibling of ``rs-driver:RevenueGrowthRate``: where
7501
+ * the catalog lever grows *revenue* through its seeded rule, a line
7502
+ * growth entry grows **any income-statement leaf** at a month-over-month
7503
+ * rate — ``value`` -0.05 cuts the line 5% per month, compounding from
7504
+ * the base month's value. This is what expense trajectories ("opex +2%/mo
7505
+ * with inflation", "cut costs 5%/mo starting October") use; without it
7506
+ * every unmodeled line just carries flat.
7507
+ *
7508
+ * Semantics per month: ``line[t] = line[t-1] * (1 + rate[t])``. Months
7509
+ * the entry doesn't name keep the engine's carry-forward (grow-then-hold
7510
+ * ramps fall out of ``values_by_period`` naturally). **Duration leaves
7511
+ * only**: balance-sheet lines roll from the IS and the working-capital
7512
+ * levers — grow the driving IS line instead. A line already driven by an
7513
+ * active catalog rule (e.g. Revenues with ``RevenueGrowthRate`` set) or
7514
+ * named by a ``line_assertions`` entry is rejected — one owner per line.
7515
+ */
7516
+ export type LineGrowthRequest = {
7517
+ /**
7518
+ * Qname
7519
+ *
7520
+ * QName of the income-statement leaf to grow (e.g. ``rs-gaap:ResearchAndDevelopmentExpense``). Must be a calc-DAG duration leaf.
7521
+ */
7522
+ qname: string;
7523
+ /**
7524
+ * Value
7525
+ *
7526
+ * Uniform month-over-month growth rate for every month of the horizon (decimal: 0.02 = +2%/mo, -0.05 = -5%/mo).
7527
+ */
7528
+ value?: number | null;
7529
+ /**
7530
+ * Values By Period
7531
+ *
7532
+ * Per-month rate overrides keyed by ``YYYY-MM``. Wins over ``value`` for the months it names; months named by neither carry the line's prior value (rate 0).
7533
+ */
7534
+ values_by_period?: {
7535
+ [key: string]: number;
7536
+ } | null;
7537
+ };
7538
+
7405
7539
  /**
7406
7540
  * LineItemMetadataPredicate
7407
7541
  *
@@ -12990,6 +13124,32 @@ export type StatementMechanics = {
12990
13124
  period_comparisons?: number;
12991
13125
  };
12992
13126
 
13127
+ /**
13128
+ * StorageItem
13129
+ *
13130
+ * One itemized piece of a graph's on-disk footprint.
13131
+ */
13132
+ export type StorageItem = {
13133
+ /**
13134
+ * Type
13135
+ *
13136
+ * One of: graph, memory, subgraph, vectors, staging
13137
+ */
13138
+ type: string;
13139
+ /**
13140
+ * Id
13141
+ *
13142
+ * Database or index identifier
13143
+ */
13144
+ id: string;
13145
+ /**
13146
+ * Bytes
13147
+ *
13148
+ * Size in bytes
13149
+ */
13150
+ bytes: number;
13151
+ };
13152
+
12993
13153
  /**
12994
13154
  * StorageLimits
12995
13155
  *
@@ -14630,6 +14790,12 @@ export type UpdateForecastRequest = {
14630
14790
  * Full replacement of the line-assertion set when provided. Pass an empty list to clear every assertion.
14631
14791
  */
14632
14792
  line_assertions?: Array<LineAssertionRequest> | null;
14793
+ /**
14794
+ * Line Growth
14795
+ *
14796
+ * Full replacement of the line-growth set when provided. Pass an empty list to clear every growth entry.
14797
+ */
14798
+ line_growth?: Array<LineGrowthRequest> | null;
14633
14799
  };
14634
14800
 
14635
14801
  /**
@@ -18491,7 +18657,7 @@ export type GetGraphMetricsData = {
18491
18657
  graph_id: string;
18492
18658
  };
18493
18659
  query?: never;
18494
- url: '/v1/graphs/{graph_id}/analytics';
18660
+ url: '/v1/graphs/{graph_id}/metrics';
18495
18661
  };
18496
18662
 
18497
18663
  export type GetGraphMetricsErrors = {
@@ -18536,7 +18702,7 @@ export type GetGraphMetricsResponses = {
18536
18702
 
18537
18703
  export type GetGraphMetricsResponse = GetGraphMetricsResponses[keyof GetGraphMetricsResponses];
18538
18704
 
18539
- export type GetGraphUsageAnalyticsData = {
18705
+ export type GetGraphUsageData = {
18540
18706
  body?: never;
18541
18707
  path: {
18542
18708
  /**
@@ -18576,10 +18742,10 @@ export type GetGraphUsageAnalyticsData = {
18576
18742
  */
18577
18743
  include_events?: boolean;
18578
18744
  };
18579
- url: '/v1/graphs/{graph_id}/analytics/usage';
18745
+ url: '/v1/graphs/{graph_id}/usage';
18580
18746
  };
18581
18747
 
18582
- export type GetGraphUsageAnalyticsErrors = {
18748
+ export type GetGraphUsageErrors = {
18583
18749
  /**
18584
18750
  * Invalid request
18585
18751
  */
@@ -18610,16 +18776,16 @@ export type GetGraphUsageAnalyticsErrors = {
18610
18776
  500: ErrorResponse;
18611
18777
  };
18612
18778
 
18613
- export type GetGraphUsageAnalyticsError = GetGraphUsageAnalyticsErrors[keyof GetGraphUsageAnalyticsErrors];
18779
+ export type GetGraphUsageError = GetGraphUsageErrors[keyof GetGraphUsageErrors];
18614
18780
 
18615
- export type GetGraphUsageAnalyticsResponses = {
18781
+ export type GetGraphUsageResponses = {
18616
18782
  /**
18617
18783
  * Successful Response
18618
18784
  */
18619
18785
  200: GraphUsageResponse;
18620
18786
  };
18621
18787
 
18622
- export type GetGraphUsageAnalyticsResponse = GetGraphUsageAnalyticsResponses[keyof GetGraphUsageAnalyticsResponses];
18788
+ export type GetGraphUsageResponse = GetGraphUsageResponses[keyof GetGraphUsageResponses];
18623
18789
 
18624
18790
  export type ExecuteCypherData = {
18625
18791
  body: CypherStatementRequest;