@magemetrics/core 0.5.3 → 0.5.4

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/dist/index.d.ts CHANGED
@@ -107,6 +107,13 @@ declare interface components {
107
107
  flow_data_id: number;
108
108
  created_at: string;
109
109
  bookmarked: boolean;
110
+ flow_data?: {
111
+ is_materialized: boolean | null;
112
+ last_materialized_at: string | null;
113
+ materialized_error_message: string | null;
114
+ /** @enum {string|null} */
115
+ materialized_status: "completed" | "running" | "failed" | null;
116
+ };
110
117
  configuration: {
111
118
  /** @enum {string} */
112
119
  type: "bar";
@@ -168,6 +175,13 @@ declare interface components {
168
175
  flow_data_id: number;
169
176
  created_at: string;
170
177
  bookmarked: boolean;
178
+ flow_data?: {
179
+ is_materialized: boolean | null;
180
+ last_materialized_at: string | null;
181
+ materialized_error_message: string | null;
182
+ /** @enum {string|null} */
183
+ materialized_status: "completed" | "running" | "failed" | null;
184
+ };
171
185
  configuration: {
172
186
  /** @enum {string} */
173
187
  type: "bar";
@@ -254,8 +268,8 @@ export declare type CreateFlowParam = {
254
268
  };
255
269
 
256
270
  declare type CustomDataParts = {
257
- "quick-actions": z.infer<typeof QuickActionsSchema>;
258
- signal: z.infer<typeof SignalWithReportIdSchema>;
271
+ "quick-actions": QuickActions;
272
+ signal: SignalWithReportId;
259
273
  "node-added": {
260
274
  node: NodeBase;
261
275
  };
@@ -405,6 +419,12 @@ export declare class MageMetricsClient {
405
419
  flow_data_id: number;
406
420
  created_at: string;
407
421
  bookmarked: boolean;
422
+ flow_data?: {
423
+ is_materialized: boolean | null;
424
+ last_materialized_at: string | null;
425
+ materialized_error_message: string | null;
426
+ materialized_status: "completed" | "running" | "failed" | null;
427
+ };
408
428
  configuration: {
409
429
  type: "bar";
410
430
  title: string;
@@ -470,6 +490,10 @@ export declare class MageMetricsClient {
470
490
  bookmarked: boolean;
471
491
  status: string | null;
472
492
  is_removed: boolean;
493
+ is_materialized: boolean | null;
494
+ last_materialized_at: string | null;
495
+ materialized_error_message: string | null;
496
+ materialized_status: "completed" | "running" | "failed" | null;
473
497
  }[]>;
474
498
  getFlow: (flowId: string) => Promise<{
475
499
  created_at: string;
@@ -997,49 +1021,6 @@ declare interface operations {
997
1021
  };
998
1022
  };
999
1023
  };
1000
- runEnd2EndFlow: {
1001
- parameters: {
1002
- query?: never;
1003
- header: {
1004
- "sp-access-token": string;
1005
- };
1006
- path?: never;
1007
- cookie?: never;
1008
- };
1009
- requestBody: {
1010
- content: {
1011
- "application/json": {
1012
- userQuery: string;
1013
- /** @default true */
1014
- isNewAnalysisGoal?: boolean;
1015
- /**
1016
- * @default complex
1017
- * @enum {string}
1018
- */
1019
- difficultyLevel?: "simple" | "moderate" | "complex";
1020
- };
1021
- };
1022
- };
1023
- responses: {
1024
- /** @description Run the end2end flow */
1025
- 200: {
1026
- headers: {
1027
- [name: string]: unknown;
1028
- };
1029
- content: {
1030
- "application/json": {
1031
- /** @enum {string} */
1032
- status: "error";
1033
- error: string;
1034
- } | {
1035
- /** @enum {string} */
1036
- status: "success";
1037
- flowId: string;
1038
- };
1039
- };
1040
- };
1041
- };
1042
- };
1043
1024
  retrieveFlow: {
1044
1025
  parameters: {
1045
1026
  query?: never;
@@ -1178,6 +1159,11 @@ declare interface operations {
1178
1159
  bookmarked: boolean;
1179
1160
  status: string | null;
1180
1161
  is_removed: boolean;
1162
+ is_materialized: boolean | null;
1163
+ last_materialized_at: string | null;
1164
+ materialized_error_message: string | null;
1165
+ /** @enum {string|null} */
1166
+ materialized_status: "completed" | "running" | "failed" | null;
1181
1167
  }[];
1182
1168
  };
1183
1169
  };
@@ -1823,6 +1809,11 @@ declare interface operations {
1823
1809
  bookmarked: boolean;
1824
1810
  status: string | null;
1825
1811
  is_removed: boolean;
1812
+ is_materialized: boolean | null;
1813
+ last_materialized_at: string | null;
1814
+ materialized_error_message: string | null;
1815
+ /** @enum {string|null} */
1816
+ materialized_status: "completed" | "running" | "failed" | null;
1826
1817
  };
1827
1818
  };
1828
1819
  };
@@ -1905,6 +1896,102 @@ declare interface operations {
1905
1896
  };
1906
1897
  };
1907
1898
  };
1899
+ refreshMaterializedViews: {
1900
+ parameters: {
1901
+ query?: never;
1902
+ header: {
1903
+ "sp-access-token": string;
1904
+ };
1905
+ path?: never;
1906
+ cookie?: never;
1907
+ };
1908
+ requestBody: {
1909
+ content: {
1910
+ "application/json": {
1911
+ /** @description List of flow_data IDs to refresh */
1912
+ flow_data_ids: number[];
1913
+ };
1914
+ };
1915
+ };
1916
+ responses: {
1917
+ /** @description Successfully triggered refresh for materialized views */
1918
+ 200: {
1919
+ headers: {
1920
+ [name: string]: unknown;
1921
+ };
1922
+ content: {
1923
+ "application/json": {
1924
+ /** @enum {string} */
1925
+ status: "success";
1926
+ triggered_at: string;
1927
+ };
1928
+ };
1929
+ };
1930
+ /** @description Invalid request */
1931
+ 400: {
1932
+ headers: {
1933
+ [name: string]: unknown;
1934
+ };
1935
+ content: {
1936
+ "application/json": {
1937
+ error: string;
1938
+ };
1939
+ };
1940
+ };
1941
+ /** @description Something wrong happened */
1942
+ 500: {
1943
+ headers: {
1944
+ [name: string]: unknown;
1945
+ };
1946
+ content: {
1947
+ "application/json": {
1948
+ error: string;
1949
+ };
1950
+ };
1951
+ };
1952
+ };
1953
+ };
1954
+ getMaterializationStatus: {
1955
+ parameters: {
1956
+ query: {
1957
+ /** @description Comma-separated list of flow_data IDs */
1958
+ ids: string;
1959
+ };
1960
+ header: {
1961
+ "sp-access-token": string;
1962
+ };
1963
+ path?: never;
1964
+ cookie?: never;
1965
+ };
1966
+ requestBody?: never;
1967
+ responses: {
1968
+ /** @description Materialization status for the requested flow_data IDs */
1969
+ 200: {
1970
+ headers: {
1971
+ [name: string]: unknown;
1972
+ };
1973
+ content: {
1974
+ "application/json": {
1975
+ id: number;
1976
+ /** @enum {string|null} */
1977
+ materialized_status: "completed" | "running" | "failed" | null;
1978
+ last_materialized_at: string | null;
1979
+ }[];
1980
+ };
1981
+ };
1982
+ /** @description Something wrong happened */
1983
+ 500: {
1984
+ headers: {
1985
+ [name: string]: unknown;
1986
+ };
1987
+ content: {
1988
+ "application/json": {
1989
+ error: string;
1990
+ };
1991
+ };
1992
+ };
1993
+ };
1994
+ };
1908
1995
  getPromptStarters: {
1909
1996
  parameters: {
1910
1997
  query?: {
@@ -2153,6 +2240,13 @@ declare interface operations {
2153
2240
  flow_data_id: number;
2154
2241
  created_at: string;
2155
2242
  bookmarked: boolean;
2243
+ flow_data?: {
2244
+ is_materialized: boolean | null;
2245
+ last_materialized_at: string | null;
2246
+ materialized_error_message: string | null;
2247
+ /** @enum {string|null} */
2248
+ materialized_status: "completed" | "running" | "failed" | null;
2249
+ };
2156
2250
  configuration: {
2157
2251
  /** @enum {string} */
2158
2252
  type: "bar";
@@ -2270,10 +2364,6 @@ declare interface operations {
2270
2364
  };
2271
2365
  content: {
2272
2366
  "application/json": {
2273
- /** @enum {string} */
2274
- status: "error";
2275
- error: string;
2276
- } | {
2277
2367
  /** @enum {string} */
2278
2368
  status: "success";
2279
2369
  flowId: string;
@@ -3242,6 +3332,209 @@ declare interface operations {
3242
3332
  };
3243
3333
  };
3244
3334
  };
3335
+ getCompanySettings: {
3336
+ parameters: {
3337
+ query?: never;
3338
+ header?: never;
3339
+ path?: never;
3340
+ cookie?: never;
3341
+ };
3342
+ requestBody?: never;
3343
+ responses: {
3344
+ /** @description Company settings retrieved successfully */
3345
+ 200: {
3346
+ headers: {
3347
+ [name: string]: unknown;
3348
+ };
3349
+ content: {
3350
+ "application/json": {
3351
+ name: string | null;
3352
+ website: string | null;
3353
+ context_profile: {
3354
+ company: {
3355
+ description: string;
3356
+ industries: string[];
3357
+ revenue_streams: string[];
3358
+ customers: {
3359
+ label: string;
3360
+ description: string;
3361
+ typical_users: {
3362
+ role: string;
3363
+ typical_goals: string[];
3364
+ }[];
3365
+ }[];
3366
+ };
3367
+ domain: {
3368
+ overview: string;
3369
+ concepts: {
3370
+ name: string;
3371
+ definition: string;
3372
+ synonyms: string[];
3373
+ }[];
3374
+ };
3375
+ analytics: {
3376
+ examples_key_metrics: {
3377
+ name: string;
3378
+ why: string;
3379
+ }[];
3380
+ };
3381
+ } | null;
3382
+ };
3383
+ };
3384
+ };
3385
+ /** @description Failed to retrieve company settings */
3386
+ 500: {
3387
+ headers: {
3388
+ [name: string]: unknown;
3389
+ };
3390
+ content: {
3391
+ "application/json": {
3392
+ error: string;
3393
+ };
3394
+ };
3395
+ };
3396
+ };
3397
+ };
3398
+ updateCompanySettings: {
3399
+ parameters: {
3400
+ query?: never;
3401
+ header?: never;
3402
+ path?: never;
3403
+ cookie?: never;
3404
+ };
3405
+ requestBody?: {
3406
+ content: {
3407
+ "application/json": {
3408
+ name: string;
3409
+ website: string;
3410
+ };
3411
+ };
3412
+ };
3413
+ responses: {
3414
+ /** @description Company settings updated successfully */
3415
+ 200: {
3416
+ headers: {
3417
+ [name: string]: unknown;
3418
+ };
3419
+ content: {
3420
+ "application/json": {
3421
+ name: string | null;
3422
+ website: string | null;
3423
+ context_profile: {
3424
+ company: {
3425
+ description: string;
3426
+ industries: string[];
3427
+ revenue_streams: string[];
3428
+ customers: {
3429
+ label: string;
3430
+ description: string;
3431
+ typical_users: {
3432
+ role: string;
3433
+ typical_goals: string[];
3434
+ }[];
3435
+ }[];
3436
+ };
3437
+ domain: {
3438
+ overview: string;
3439
+ concepts: {
3440
+ name: string;
3441
+ definition: string;
3442
+ synonyms: string[];
3443
+ }[];
3444
+ };
3445
+ analytics: {
3446
+ examples_key_metrics: {
3447
+ name: string;
3448
+ why: string;
3449
+ }[];
3450
+ };
3451
+ } | null;
3452
+ };
3453
+ };
3454
+ };
3455
+ /** @description Failed to update company settings */
3456
+ 500: {
3457
+ headers: {
3458
+ [name: string]: unknown;
3459
+ };
3460
+ content: {
3461
+ "application/json": {
3462
+ error: string;
3463
+ };
3464
+ };
3465
+ };
3466
+ };
3467
+ };
3468
+ runCompanyResearchAgent: {
3469
+ parameters: {
3470
+ query?: never;
3471
+ header?: never;
3472
+ path?: never;
3473
+ cookie?: never;
3474
+ };
3475
+ requestBody?: never;
3476
+ responses: {
3477
+ /** @description Company research agent executed successfully */
3478
+ 200: {
3479
+ headers: {
3480
+ [name: string]: unknown;
3481
+ };
3482
+ content: {
3483
+ "application/json": {
3484
+ company: {
3485
+ description: string;
3486
+ industries: string[];
3487
+ revenue_streams: string[];
3488
+ customers: {
3489
+ label: string;
3490
+ description: string;
3491
+ typical_users: {
3492
+ role: string;
3493
+ typical_goals: string[];
3494
+ }[];
3495
+ }[];
3496
+ };
3497
+ domain: {
3498
+ overview: string;
3499
+ concepts: {
3500
+ name: string;
3501
+ definition: string;
3502
+ synonyms: string[];
3503
+ }[];
3504
+ };
3505
+ analytics: {
3506
+ examples_key_metrics: {
3507
+ name: string;
3508
+ why: string;
3509
+ }[];
3510
+ };
3511
+ };
3512
+ };
3513
+ };
3514
+ /** @description Company name or website not configured */
3515
+ 400: {
3516
+ headers: {
3517
+ [name: string]: unknown;
3518
+ };
3519
+ content: {
3520
+ "application/json": {
3521
+ error: string;
3522
+ };
3523
+ };
3524
+ };
3525
+ /** @description Company research agent failed */
3526
+ 500: {
3527
+ headers: {
3528
+ [name: string]: unknown;
3529
+ };
3530
+ content: {
3531
+ "application/json": {
3532
+ error: string;
3533
+ };
3534
+ };
3535
+ };
3536
+ };
3537
+ };
3245
3538
  }
3246
3539
 
3247
3540
  declare type PatchParam<T, Config extends RemoveParamsConfig, P extends keyof Config> = Simplify<T extends {
@@ -3366,22 +3659,6 @@ declare interface paths {
3366
3659
  patch?: never;
3367
3660
  trace?: never;
3368
3661
  };
3369
- "/api/v1/end2end": {
3370
- parameters: {
3371
- query?: never;
3372
- header?: never;
3373
- path?: never;
3374
- cookie?: never;
3375
- };
3376
- get?: never;
3377
- put?: never;
3378
- post: operations["runEnd2EndFlow"];
3379
- delete?: never;
3380
- options?: never;
3381
- head?: never;
3382
- patch?: never;
3383
- trace?: never;
3384
- };
3385
3662
  "/api/v1/flows/{flowId}": {
3386
3663
  parameters: {
3387
3664
  query?: never;
@@ -3606,6 +3883,38 @@ declare interface paths {
3606
3883
  patch?: never;
3607
3884
  trace?: never;
3608
3885
  };
3886
+ "/api/v1/flow_data/v1/materialized_views/refresh": {
3887
+ parameters: {
3888
+ query?: never;
3889
+ header?: never;
3890
+ path?: never;
3891
+ cookie?: never;
3892
+ };
3893
+ get?: never;
3894
+ put?: never;
3895
+ post: operations["refreshMaterializedViews"];
3896
+ delete?: never;
3897
+ options?: never;
3898
+ head?: never;
3899
+ patch?: never;
3900
+ trace?: never;
3901
+ };
3902
+ "/api/v1/flow_data/materialization-status": {
3903
+ parameters: {
3904
+ query?: never;
3905
+ header?: never;
3906
+ path?: never;
3907
+ cookie?: never;
3908
+ };
3909
+ get: operations["getMaterializationStatus"];
3910
+ put?: never;
3911
+ post?: never;
3912
+ delete?: never;
3913
+ options?: never;
3914
+ head?: never;
3915
+ patch?: never;
3916
+ trace?: never;
3917
+ };
3609
3918
  "/api/v1/prompt-starters": {
3610
3919
  parameters: {
3611
3920
  query?: never;
@@ -3702,7 +4011,7 @@ declare interface paths {
3702
4011
  patch?: never;
3703
4012
  trace?: never;
3704
4013
  };
3705
- "/api/v1/trigger-flow/": {
4014
+ "/api/v1/trigger-flow": {
3706
4015
  parameters: {
3707
4016
  query?: never;
3708
4017
  header?: never;
@@ -3958,8 +4267,42 @@ declare interface paths {
3958
4267
  patch?: never;
3959
4268
  trace?: never;
3960
4269
  };
4270
+ "/api/v1/admin-console/company-settings": {
4271
+ parameters: {
4272
+ query?: never;
4273
+ header?: never;
4274
+ path?: never;
4275
+ cookie?: never;
4276
+ };
4277
+ get: operations["getCompanySettings"];
4278
+ put?: never;
4279
+ post?: never;
4280
+ delete?: never;
4281
+ options?: never;
4282
+ head?: never;
4283
+ patch: operations["updateCompanySettings"];
4284
+ trace?: never;
4285
+ };
4286
+ "/api/v1/admin-console/company-research-agent": {
4287
+ parameters: {
4288
+ query?: never;
4289
+ header?: never;
4290
+ path?: never;
4291
+ cookie?: never;
4292
+ };
4293
+ get?: never;
4294
+ put?: never;
4295
+ post: operations["runCompanyResearchAgent"];
4296
+ delete?: never;
4297
+ options?: never;
4298
+ head?: never;
4299
+ patch?: never;
4300
+ trace?: never;
4301
+ };
3961
4302
  }
3962
4303
 
4304
+ declare type QuickActions = z.infer<typeof QuickActionsSchema>;
4305
+
3963
4306
  declare const QuickActionsSchema: z.ZodArray<z.ZodObject<{
3964
4307
  label: z.ZodString;
3965
4308
  explanation: z.ZodString;
@@ -4085,6 +4428,8 @@ declare type ReportDataFilters = {
4085
4428
  cursor?: number;
4086
4429
  };
4087
4430
 
4431
+ declare type SignalWithReportId = z.infer<typeof SignalWithReportIdSchema>;
4432
+
4088
4433
  declare const SignalWithReportIdSchema: z.ZodObject<{
4089
4434
  rule: z.ZodString;
4090
4435
  metric: z.ZodString;
@@ -4121,7 +4466,7 @@ declare type UiTool_6 = InferUITool<Tool<z.infer<typeof inputSchema_6>, z.infer<
4121
4466
  declare type UiTool_7 = InferUITool<Tool<z.infer<typeof inputSchema_7>, z.infer<typeof redactedOutputSchema_6>>>;
4122
4467
 
4123
4468
  declare const UpdateCanvasSchema: z.ZodObject<{
4124
- id: z.ZodString;
4469
+ id: z.ZodUUID;
4125
4470
  title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
4126
4471
  nodes: z.ZodOptional<z.ZodArray<z.ZodAny>>;
4127
4472
  edges: z.ZodOptional<z.ZodArray<z.ZodAny>>;