@uniformdev/canvas 17.7.0 → 17.7.1-alpha.140
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/{chunk-PVRSC7Y6.mjs → chunk-TN3WBMTA.mjs} +1 -1
- package/dist/cli/cli.d.ts +2 -2
- package/dist/cli/cli.js +1 -1
- package/dist/cli/cli.mjs +1 -1
- package/dist/{createEventBus-bb2f5866.d.ts → createEventBus-025f310c.d.ts} +91 -133
- package/dist/index.d.ts +31 -39
- package/dist/index.esm.js +1 -1
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +7 -7
@@ -226,15 +226,13 @@ interface components$2 {
|
|
226
226
|
connectorType: string;
|
227
227
|
/** @description Base resource URL of the data source. No trailing slash. */
|
228
228
|
baseUrl: string;
|
229
|
+
/** @description HTTP headers to pass with requests to the data source */
|
229
230
|
headers?: {
|
230
|
-
[key: string]: string;
|
231
|
-
} | {
|
232
231
|
key: string;
|
233
232
|
value: string;
|
234
233
|
}[];
|
234
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
235
235
|
parameters?: {
|
236
|
-
[key: string]: string;
|
237
|
-
} | {
|
238
236
|
key: string;
|
239
237
|
value: string;
|
240
238
|
}[];
|
@@ -282,15 +280,11 @@ interface components$2 {
|
|
282
280
|
badgeIconUrl?: string;
|
283
281
|
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
|
284
282
|
headers?: {
|
285
|
-
[key: string]: string;
|
286
|
-
} | {
|
287
283
|
key: string;
|
288
284
|
value: string;
|
289
285
|
}[];
|
290
286
|
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
291
287
|
parameters?: {
|
292
|
-
[key: string]: string;
|
293
|
-
} | {
|
294
288
|
key: string;
|
295
289
|
value: string;
|
296
290
|
}[];
|
@@ -726,15 +720,13 @@ interface external$5 {
|
|
726
720
|
connectorType: string;
|
727
721
|
/** @description Base resource URL of the data source. No trailing slash. */
|
728
722
|
baseUrl: string;
|
723
|
+
/** @description HTTP headers to pass with requests to the data source */
|
729
724
|
headers?: {
|
730
|
-
[key: string]: string;
|
731
|
-
} | {
|
732
725
|
key: string;
|
733
726
|
value: string;
|
734
727
|
}[];
|
728
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
735
729
|
parameters?: {
|
736
|
-
[key: string]: string;
|
737
|
-
} | {
|
738
730
|
key: string;
|
739
731
|
value: string;
|
740
732
|
}[];
|
@@ -782,15 +774,11 @@ interface external$5 {
|
|
782
774
|
badgeIconUrl?: string;
|
783
775
|
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
|
784
776
|
headers?: {
|
785
|
-
[key: string]: string;
|
786
|
-
} | {
|
787
777
|
key: string;
|
788
778
|
value: string;
|
789
779
|
}[];
|
790
780
|
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
791
781
|
parameters?: {
|
792
|
-
[key: string]: string;
|
793
|
-
} | {
|
794
782
|
key: string;
|
795
783
|
value: string;
|
796
784
|
}[];
|
@@ -862,40 +850,40 @@ interface external$5 {
|
|
862
850
|
};
|
863
851
|
}
|
864
852
|
|
865
|
-
|
866
|
-
|
853
|
+
type SharedComponents$1 = components$2['schemas'];
|
854
|
+
type Api$1 = paths$4['/api/v1/canvas-definitions'];
|
867
855
|
/** Shape of the GET response from /api/v1/canvas-definitions */
|
868
|
-
|
856
|
+
type ComponentDefinitionGetResponse = Api$1['get']['responses']['200']['content']['application/json'];
|
869
857
|
/** Shape of the PUT request body for /api/v1/canvas-definitions */
|
870
|
-
|
858
|
+
type ComponentDefinitionPutParameters = Api$1['put']['requestBody']['content']['application/json'];
|
871
859
|
/** Shape of the DELETE request body for /api/v1/canvas-definitions */
|
872
|
-
|
860
|
+
type ComponentDefinitionDeleteParameters = Api$1['delete']['requestBody']['content']['application/json'];
|
873
861
|
/** Query parameter options for GET /api/v1/canvas-definitions */
|
874
|
-
|
862
|
+
type ComponentDefinitionGetParameters = Api$1['get']['parameters']['query'];
|
875
863
|
/** @deprecated use ComponentDefinitionGetResponse instead */
|
876
|
-
|
864
|
+
type ComponentDefinitionAPIResponse = ComponentDefinitionGetResponse;
|
877
865
|
/** @deprecated use ComponentDefinitionPutParameters */
|
878
|
-
|
866
|
+
type ComponentDefinitionAPIPutRequest = ComponentDefinitionPutParameters;
|
879
867
|
/** @deprecated use ComponentDefinitionDeleteParameters */
|
880
|
-
|
868
|
+
type ComponentDefinitionAPIDeleteRequest = ComponentDefinitionDeleteParameters;
|
881
869
|
/** @deprecated use ComponentDefinitionGetParameters */
|
882
|
-
|
870
|
+
type ComponentDefinitionListAPIOptions = ComponentDefinitionGetParameters;
|
883
871
|
/** The definition of a component parameter */
|
884
|
-
|
872
|
+
type ComponentDefinitionParameter<TConfig = unknown> = Omit<components$2['schemas']['ComponentDefinitionParameter'], 'typeConfig'> & {
|
885
873
|
typeConfig?: TConfig;
|
886
874
|
};
|
887
875
|
/** The definition of a component visual variant */
|
888
|
-
|
876
|
+
type ComponentDefinitionVariant = SharedComponents$1['ComponentDefinitionVariant'];
|
889
877
|
/** The definition of a composition's slug settings */
|
890
|
-
|
878
|
+
type ComponentDefinitionSlugSettings = SharedComponents$1['ComponentDefinitionSlugSettings'];
|
891
879
|
/** The definition of a named component slot that can contain other components */
|
892
|
-
|
880
|
+
type ComponentDefinitionSlot = SharedComponents$1['ComponentDefinitionSlot'];
|
893
881
|
/** Permission set for a component defintion */
|
894
|
-
|
882
|
+
type ComponentDefinitionPermission = SharedComponents$1['ComponentDefinitionPermission'];
|
895
883
|
/** Defines a component type that can live on a Composition */
|
896
|
-
|
884
|
+
type ComponentDefinition = SharedComponents$1['ComponentDefinition'];
|
897
885
|
/** @deprecated use ComponentDefinition instead */
|
898
|
-
|
886
|
+
type CreatingComponentDefinition = Omit<Partial<ComponentDefinition>, 'created' | 'updated'>;
|
899
887
|
|
900
888
|
/**
|
901
889
|
* This file was auto-generated by openapi-typescript.
|
@@ -1459,15 +1447,13 @@ interface external$4 {
|
|
1459
1447
|
connectorType: string;
|
1460
1448
|
/** @description Base resource URL of the data source. No trailing slash. */
|
1461
1449
|
baseUrl: string;
|
1450
|
+
/** @description HTTP headers to pass with requests to the data source */
|
1462
1451
|
headers?: {
|
1463
|
-
[key: string]: string;
|
1464
|
-
} | {
|
1465
1452
|
key: string;
|
1466
1453
|
value: string;
|
1467
1454
|
}[];
|
1455
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
1468
1456
|
parameters?: {
|
1469
|
-
[key: string]: string;
|
1470
|
-
} | {
|
1471
1457
|
key: string;
|
1472
1458
|
value: string;
|
1473
1459
|
}[];
|
@@ -1515,15 +1501,11 @@ interface external$4 {
|
|
1515
1501
|
badgeIconUrl?: string;
|
1516
1502
|
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
|
1517
1503
|
headers?: {
|
1518
|
-
[key: string]: string;
|
1519
|
-
} | {
|
1520
1504
|
key: string;
|
1521
1505
|
value: string;
|
1522
1506
|
}[];
|
1523
1507
|
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
1524
1508
|
parameters?: {
|
1525
|
-
[key: string]: string;
|
1526
|
-
} | {
|
1527
1509
|
key: string;
|
1528
1510
|
value: string;
|
1529
1511
|
}[];
|
@@ -1976,15 +1958,13 @@ interface external$3 {
|
|
1976
1958
|
connectorType: string;
|
1977
1959
|
/** @description Base resource URL of the data source. No trailing slash. */
|
1978
1960
|
baseUrl: string;
|
1961
|
+
/** @description HTTP headers to pass with requests to the data source */
|
1979
1962
|
headers?: {
|
1980
|
-
[key: string]: string;
|
1981
|
-
} | {
|
1982
1963
|
key: string;
|
1983
1964
|
value: string;
|
1984
1965
|
}[];
|
1966
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
1985
1967
|
parameters?: {
|
1986
|
-
[key: string]: string;
|
1987
|
-
} | {
|
1988
1968
|
key: string;
|
1989
1969
|
value: string;
|
1990
1970
|
}[];
|
@@ -2032,15 +2012,11 @@ interface external$3 {
|
|
2032
2012
|
badgeIconUrl?: string;
|
2033
2013
|
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
|
2034
2014
|
headers?: {
|
2035
|
-
[key: string]: string;
|
2036
|
-
} | {
|
2037
2015
|
key: string;
|
2038
2016
|
value: string;
|
2039
2017
|
}[];
|
2040
2018
|
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
2041
2019
|
parameters?: {
|
2042
|
-
[key: string]: string;
|
2043
|
-
} | {
|
2044
2020
|
key: string;
|
2045
2021
|
value: string;
|
2046
2022
|
}[];
|
@@ -2402,80 +2378,80 @@ interface external$3 {
|
|
2402
2378
|
};
|
2403
2379
|
}
|
2404
2380
|
|
2405
|
-
|
2406
|
-
|
2407
|
-
|
2381
|
+
type Components = components$1['schemas'];
|
2382
|
+
type SharedComponents = components$2['schemas'];
|
2383
|
+
type Api = paths$3['/api/v1/canvas'];
|
2408
2384
|
/** Query parameter options for GET /api/v1/canvas */
|
2409
|
-
|
2385
|
+
type CompositionGetParameters = Omit<Api['get']['parameters']['query'], 'type'> & {
|
2410
2386
|
type?: string | string[];
|
2411
2387
|
};
|
2412
|
-
|
2388
|
+
type CompositionGetOrderBy = NonNullable<Api['get']['parameters']['query']['orderBy']>[0];
|
2413
2389
|
/** The GET response from /api/v1/canvas when `component` or `slug` params are specified */
|
2414
|
-
|
2390
|
+
type CompositionGetResponse = Components['CompositionApiResponse'];
|
2415
2391
|
/** @deprecated - internal use, do not rely on this value */
|
2416
|
-
|
2392
|
+
type CompositionUIStatus = NonNullable<Components['CompositionApiResponse']['uiStatus']>;
|
2417
2393
|
/** The GET response from /api/v1/canvas when `component` or `slug` are not specified */
|
2418
|
-
|
2394
|
+
type CompositionGetListResponse = Components['CompositionListResponse'];
|
2419
2395
|
/** The PUT request body for /api/v1/canvas */
|
2420
|
-
|
2396
|
+
type CompositionPutParameters = Api['put']['requestBody']['content']['application/json'];
|
2421
2397
|
/** Shape of the DELETE request body for /api/v1/canvas */
|
2422
|
-
|
2398
|
+
type CompositionDeleteParameters = Api['delete']['requestBody']['content']['application/json'];
|
2423
2399
|
/** @deprecated use CompositionGetResponse */
|
2424
|
-
|
2400
|
+
type CompositionAPIResponse = CompositionGetResponse;
|
2425
2401
|
/** @deprecated use CompositionDeleteParameters */
|
2426
|
-
|
2402
|
+
type CompositionAPIDeleteRequest = CompositionDeleteParameters;
|
2427
2403
|
/** @deprecated use CompositionGetParameters */
|
2428
|
-
|
2404
|
+
type CompositionListAPIResponse = CompositionGetListResponse;
|
2429
2405
|
/** @deprecated use CompositionGetParameters */
|
2430
|
-
|
2406
|
+
type CompositionAPIOptions = CompositionGetParameters;
|
2431
2407
|
/** Defines an editable parameter on a component. */
|
2432
|
-
|
2408
|
+
type ComponentParameter<TValue = unknown> = Omit<SharedComponents['ComponentParameter'], 'value'> & {
|
2433
2409
|
/** The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
2434
2410
|
value: TValue;
|
2435
2411
|
};
|
2436
2412
|
/** Defines a connection to a data element on a data resource. */
|
2437
|
-
|
2413
|
+
type DataElementConnectionDefinition = SharedComponents['DataElementConnectionDefinition'];
|
2438
2414
|
/** Variable values for a data resource. */
|
2439
|
-
|
2415
|
+
type DataResourceVariables = SharedComponents['DataResourceVariables'];
|
2440
2416
|
/**
|
2441
2417
|
* Data definitions attached to this component. The property name is the key of the data in the data document.
|
2442
2418
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
2443
2419
|
*/
|
2444
|
-
|
2420
|
+
type DataResourceDefinitions = SharedComponents['DataResourceDefinitions'];
|
2445
2421
|
/** Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
2446
|
-
|
2422
|
+
type DataResourceDefinition = SharedComponents['DataResourceDefinition'];
|
2447
2423
|
/** Defines the shape of a component instance served by the composition API. */
|
2448
|
-
|
2424
|
+
type ComponentInstance = SharedComponents['ComponentInstance'] & {
|
2449
2425
|
/** Data for the component instance, provided by a component enhancer. Never set in unenhanced data. */
|
2450
2426
|
data?: Record<string, unknown>;
|
2451
2427
|
};
|
2452
2428
|
/** Defines the shape of the root component in a composition */
|
2453
|
-
|
2429
|
+
type RootComponentInstance = SharedComponents['RootComponentInstance'];
|
2454
2430
|
/** Defines single structure to keep all canvas models (used in CLI commands and Starter content generations) */
|
2455
|
-
|
2431
|
+
type CanvasDefinitions = {
|
2456
2432
|
components?: Array<ComponentDefinition>;
|
2457
2433
|
compositions?: Array<CompositionGetResponse>;
|
2458
2434
|
dataTypes?: Array<DataType>;
|
2459
2435
|
};
|
2460
2436
|
/** Defines shared parameters for requests getting a single composition */
|
2461
|
-
|
2462
|
-
|
2437
|
+
type CompositionGetOneSharedParameters = Pick<CompositionGetParameters, 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus' | 'withTotalCount'>;
|
2438
|
+
type CompositionGetBy<RequiredParameters extends keyof CompositionGetParameters> = CompositionGetOneSharedParameters & Required<Pick<CompositionGetParameters, RequiredParameters>>;
|
2463
2439
|
/** Defines exact parameters for specific requests getting a single composition */
|
2464
|
-
|
2465
|
-
|
2466
|
-
|
2467
|
-
|
2440
|
+
type CompositionGetByNodePathParameters = CompositionGetBy<'projectMapNodePath' | 'projectMapId'>;
|
2441
|
+
type CompositionGetByNodeIdParameters = CompositionGetBy<'projectMapNodeId' | 'projectMapId'>;
|
2442
|
+
type CompositionGetBySlugParameters = CompositionGetBy<'slug'>;
|
2443
|
+
type CompositionGetByIdParameters = CompositionGetBy<'compositionId'>;
|
2468
2444
|
/** Switches for data resolution */
|
2469
|
-
|
2445
|
+
type DataResolutionOption = {
|
2470
2446
|
unstable_resolveData?: boolean;
|
2471
2447
|
};
|
2472
|
-
|
2448
|
+
type DataResolutionOptionNegative = {
|
2473
2449
|
unstable_resolveData?: false;
|
2474
2450
|
};
|
2475
|
-
|
2451
|
+
type DataResolutionOptionPositive = {
|
2476
2452
|
unstable_resolveData: true;
|
2477
2453
|
};
|
2478
|
-
|
2454
|
+
type DataResolutionParameters = {
|
2479
2455
|
/**
|
2480
2456
|
* Adds additional diagnostics (`dataDiagnostics`) to the response containing timings and resolved datas for the composition.
|
2481
2457
|
* Because this adds a lot of data to the response, we do not recommend using this unless diagnosing performance issues.
|
@@ -2488,37 +2464,37 @@ declare type DataResolutionParameters = {
|
|
2488
2464
|
unstable_dynamicVariables?: Record<string, string>;
|
2489
2465
|
};
|
2490
2466
|
/** Types of issue that can occur when fetching composition data */
|
2491
|
-
|
2492
|
-
|
2467
|
+
type CompositionIssue = CompositionPatternIssue | DataResourceIssue | DataElementBindingIssue | DataResourceVariableIssue | DataResolutionConfigIssue;
|
2468
|
+
type CompositionIssueCore = components['schemas']['CompositionIssue'];
|
2493
2469
|
/** An error that occured resolving a pattern that is referenced on the composition */
|
2494
|
-
|
2470
|
+
type CompositionPatternIssue = CompositionIssueCore & {
|
2495
2471
|
type: 'pattern';
|
2496
2472
|
code: NonNullable<ComponentInstance['_patternError']>;
|
2497
2473
|
};
|
2498
2474
|
/** An error while binding a data element from a data resource to a component parameter (i.e. a missing property in the data resource) */
|
2499
|
-
|
2475
|
+
type DataElementBindingIssue = CompositionIssueCore & {
|
2500
2476
|
type: 'binding';
|
2501
2477
|
parameterName: string;
|
2502
2478
|
};
|
2503
2479
|
/** An error that occurred fetching a data defined on the composition or a pattern within */
|
2504
|
-
|
2480
|
+
type DataResourceIssue = CompositionIssueCore & {
|
2505
2481
|
type: 'data';
|
2506
2482
|
dataName: string;
|
2507
2483
|
dataType: string;
|
2508
2484
|
};
|
2509
2485
|
/** An issue that occurred while binding dynamic variables to composition data resources */
|
2510
|
-
|
2486
|
+
type DataResourceVariableIssue = CompositionIssueCore & {
|
2511
2487
|
type: 'variable';
|
2512
2488
|
variableName: string;
|
2513
2489
|
};
|
2514
|
-
|
2490
|
+
type DataResolutionConfigIssue = {
|
2515
2491
|
message: string;
|
2516
2492
|
type: 'config';
|
2517
2493
|
};
|
2518
2494
|
/** Diagnostic data about the load performance of attached composition datas */
|
2519
|
-
|
2495
|
+
type CompositionDataDiagnostic = components['schemas']['DataDiagnostic'];
|
2520
2496
|
/** Response as it comes from the data resolution endpoint */
|
2521
|
-
|
2497
|
+
type CompositionResolvedGetResponse = CompositionGetResponse & {
|
2522
2498
|
/**
|
2523
2499
|
* Copies of resolved data and how long it took to resolve each data.
|
2524
2500
|
* Only set when dataDiagnostics=true is passed to the options.
|
@@ -2537,7 +2513,7 @@ declare type CompositionResolvedGetResponse = CompositionGetResponse & {
|
|
2537
2513
|
warnings?: Array<CompositionIssue>;
|
2538
2514
|
};
|
2539
2515
|
/** All valid response types */
|
2540
|
-
|
2516
|
+
type CompositionGetValidResponses = CompositionGetResponse | CompositionResolvedGetResponse;
|
2541
2517
|
|
2542
2518
|
/**
|
2543
2519
|
* This file was auto-generated by openapi-typescript.
|
@@ -2883,15 +2859,13 @@ interface external$2 {
|
|
2883
2859
|
connectorType: string;
|
2884
2860
|
/** @description Base resource URL of the data source. No trailing slash. */
|
2885
2861
|
baseUrl: string;
|
2862
|
+
/** @description HTTP headers to pass with requests to the data source */
|
2886
2863
|
headers?: {
|
2887
|
-
[key: string]: string;
|
2888
|
-
} | {
|
2889
2864
|
key: string;
|
2890
2865
|
value: string;
|
2891
2866
|
}[];
|
2867
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
2892
2868
|
parameters?: {
|
2893
|
-
[key: string]: string;
|
2894
|
-
} | {
|
2895
2869
|
key: string;
|
2896
2870
|
value: string;
|
2897
2871
|
}[];
|
@@ -2939,15 +2913,11 @@ interface external$2 {
|
|
2939
2913
|
badgeIconUrl?: string;
|
2940
2914
|
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
|
2941
2915
|
headers?: {
|
2942
|
-
[key: string]: string;
|
2943
|
-
} | {
|
2944
2916
|
key: string;
|
2945
2917
|
value: string;
|
2946
2918
|
}[];
|
2947
2919
|
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
2948
2920
|
parameters?: {
|
2949
|
-
[key: string]: string;
|
2950
|
-
} | {
|
2951
2921
|
key: string;
|
2952
2922
|
value: string;
|
2953
2923
|
}[];
|
@@ -3325,15 +3295,13 @@ interface external$1 {
|
|
3325
3295
|
connectorType: string;
|
3326
3296
|
/** @description Base resource URL of the data source. No trailing slash. */
|
3327
3297
|
baseUrl: string;
|
3298
|
+
/** @description HTTP headers to pass with requests to the data source */
|
3328
3299
|
headers?: {
|
3329
|
-
[key: string]: string;
|
3330
|
-
} | {
|
3331
3300
|
key: string;
|
3332
3301
|
value: string;
|
3333
3302
|
}[];
|
3303
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
3334
3304
|
parameters?: {
|
3335
|
-
[key: string]: string;
|
3336
|
-
} | {
|
3337
3305
|
key: string;
|
3338
3306
|
value: string;
|
3339
3307
|
}[];
|
@@ -3381,15 +3349,11 @@ interface external$1 {
|
|
3381
3349
|
badgeIconUrl?: string;
|
3382
3350
|
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
|
3383
3351
|
headers?: {
|
3384
|
-
[key: string]: string;
|
3385
|
-
} | {
|
3386
3352
|
key: string;
|
3387
3353
|
value: string;
|
3388
3354
|
}[];
|
3389
3355
|
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
3390
3356
|
parameters?: {
|
3391
|
-
[key: string]: string;
|
3392
|
-
} | {
|
3393
3357
|
key: string;
|
3394
3358
|
value: string;
|
3395
3359
|
}[];
|
@@ -3802,15 +3766,13 @@ interface external {
|
|
3802
3766
|
connectorType: string;
|
3803
3767
|
/** @description Base resource URL of the data source. No trailing slash. */
|
3804
3768
|
baseUrl: string;
|
3769
|
+
/** @description HTTP headers to pass with requests to the data source */
|
3805
3770
|
headers?: {
|
3806
|
-
[key: string]: string;
|
3807
|
-
} | {
|
3808
3771
|
key: string;
|
3809
3772
|
value: string;
|
3810
3773
|
}[];
|
3774
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
3811
3775
|
parameters?: {
|
3812
|
-
[key: string]: string;
|
3813
|
-
} | {
|
3814
3776
|
key: string;
|
3815
3777
|
value: string;
|
3816
3778
|
}[];
|
@@ -3858,15 +3820,11 @@ interface external {
|
|
3858
3820
|
badgeIconUrl?: string;
|
3859
3821
|
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
|
3860
3822
|
headers?: {
|
3861
|
-
[key: string]: string;
|
3862
|
-
} | {
|
3863
3823
|
key: string;
|
3864
3824
|
value: string;
|
3865
3825
|
}[];
|
3866
3826
|
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
3867
3827
|
parameters?: {
|
3868
|
-
[key: string]: string;
|
3869
|
-
} | {
|
3870
3828
|
key: string;
|
3871
3829
|
value: string;
|
3872
3830
|
}[];
|
@@ -3938,43 +3896,43 @@ interface external {
|
|
3938
3896
|
};
|
3939
3897
|
}
|
3940
3898
|
|
3941
|
-
|
3942
|
-
|
3943
|
-
|
3899
|
+
type DataTypeApi = paths['/api/v1/data-types'];
|
3900
|
+
type DataSourcesApi = paths$1['/api/v1/data-sources'];
|
3901
|
+
type DataSourceApi = paths$2['/api/v1/data-source'];
|
3944
3902
|
/** Query parameter options for GET /api/v1/data-types */
|
3945
|
-
|
3903
|
+
type DataTypeGetParameters = DataTypeApi['get']['parameters']['query'];
|
3946
3904
|
/** The GET response from /api/v1/data-types */
|
3947
|
-
|
3905
|
+
type DataTypeGetResponse = DataTypeApi['get']['responses']['200']['content']['application/json'];
|
3948
3906
|
/** The PUT request body for /api/v1/data-types */
|
3949
|
-
|
3907
|
+
type DataTypePutParameters = DataTypeApi['put']['requestBody']['content']['application/json'];
|
3950
3908
|
/** Shape of the DELETE request body for /api/v1/data-types */
|
3951
|
-
|
3909
|
+
type DataTypeDeleteParameters = DataTypeApi['delete']['requestBody']['content']['application/json'];
|
3952
3910
|
/** Query parameter options for GET /api/v1/data-source */
|
3953
|
-
|
3911
|
+
type DataSourceGetParameters = DataSourceApi['get']['parameters']['query'];
|
3954
3912
|
/** Query parameter options for GET /api/v1/data-sources */
|
3955
|
-
|
3913
|
+
type DataSourcesGetParameters = DataSourcesApi['get']['parameters']['query'];
|
3956
3914
|
/** The GET response from /api/v1/data-sources */
|
3957
|
-
|
3915
|
+
type DataSourceGetResponse = DataSourceApi['get']['responses']['200']['content']['application/json'];
|
3958
3916
|
/** The GET response from /api/v1/data-sources */
|
3959
|
-
|
3917
|
+
type DataSourcesGetResponse = DataSourcesApi['get']['responses']['200']['content']['application/json'];
|
3960
3918
|
/** The PUT request body for /api/v1/data-source */
|
3961
|
-
|
3919
|
+
type DataSourcePutParameters = DataSourceApi['put']['requestBody']['content']['application/json'];
|
3962
3920
|
/** Shape of the DELETE request body for /api/v1/data-source */
|
3963
|
-
|
3964
|
-
|
3965
|
-
|
3966
|
-
|
3921
|
+
type DataSourceDeleteParameters = DataSourceApi['delete']['requestBody']['content']['application/json'];
|
3922
|
+
type DataType = components$2['schemas']['DataType'];
|
3923
|
+
type DataSource = components$2['schemas']['DataSource'];
|
3924
|
+
type DataVariableDefinition = components$2['schemas']['DataVariableDefinition'];
|
3967
3925
|
|
3968
3926
|
/**
|
3969
3927
|
* Pusher-js is large (80k) and not tree shakable so it is always bundled if directly referenced,
|
3970
3928
|
* when it's only needed during preview mode. To avoid bundling it for all, we use an old-school
|
3971
3929
|
* write-a-script-tag hack to load it in a poor man's approximation of a dynamic import ;)
|
3972
3930
|
*/
|
3973
|
-
|
3931
|
+
type ChannelSubscription = {
|
3974
3932
|
addEventHandler: (eventName: string, handler: (data: unknown) => void) => () => void;
|
3975
3933
|
unsubscribe: () => void;
|
3976
3934
|
};
|
3977
|
-
|
3935
|
+
type PreviewEventBus = {
|
3978
3936
|
subscribe: (channel: string) => ChannelSubscription;
|
3979
3937
|
};
|
3980
3938
|
declare global {
|