@uniformdev/canvas 17.7.0 → 17.7.1-alpha.167
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-FIKDTGXG.mjs +1495 -0
- package/dist/cli/cli.d.ts +2 -2
- package/dist/cli/cli.js +19772 -74
- package/dist/cli/cli.mjs +19183 -74
- package/dist/{createEventBus-bb2f5866.d.ts → createEventBus-bd2e0a92.d.ts} +99 -133
- package/dist/index.d.ts +31 -39
- package/dist/index.esm.js +118 -1
- package/dist/index.js +1519 -3
- package/dist/index.mjs +118 -1
- package/package.json +8 -8
- package/dist/chunk-PVRSC7Y6.mjs +0 -4
@@ -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.
|
@@ -950,6 +938,8 @@ interface paths$3 {
|
|
950
938
|
* embedded into it, and serialize the pattern data separately.
|
951
939
|
*/
|
952
940
|
skipPatternResolution?: components$1["parameters"]["skipPatternResolution"];
|
941
|
+
/** If true, any dynamic parameters will be left with their raw data. Project map link path is a dynamic parameter. */
|
942
|
+
skipParameterResolution?: components$1["parameters"]["skipParameterResolution"];
|
953
943
|
/** Specify a single composition to fetch by slug. Changes response from list to single. */
|
954
944
|
slug?: components$1["parameters"]["slug"];
|
955
945
|
/** State of compositions to fetch. 0 = draft, 64 = published. */
|
@@ -1146,6 +1136,8 @@ interface components$1 {
|
|
1146
1136
|
* embedded into it, and serialize the pattern data separately.
|
1147
1137
|
*/
|
1148
1138
|
skipPatternResolution: boolean;
|
1139
|
+
/** @description If true, any dynamic parameters will be left with their raw data. Project map link path is a dynamic parameter. */
|
1140
|
+
skipParameterResolution: boolean;
|
1149
1141
|
/**
|
1150
1142
|
* @description If true the `_id` unique identifier of each non-root component will be part of the response data.
|
1151
1143
|
* If false, the `_id` will not be present in the API response.
|
@@ -1459,15 +1451,13 @@ interface external$4 {
|
|
1459
1451
|
connectorType: string;
|
1460
1452
|
/** @description Base resource URL of the data source. No trailing slash. */
|
1461
1453
|
baseUrl: string;
|
1454
|
+
/** @description HTTP headers to pass with requests to the data source */
|
1462
1455
|
headers?: {
|
1463
|
-
[key: string]: string;
|
1464
|
-
} | {
|
1465
1456
|
key: string;
|
1466
1457
|
value: string;
|
1467
1458
|
}[];
|
1459
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
1468
1460
|
parameters?: {
|
1469
|
-
[key: string]: string;
|
1470
|
-
} | {
|
1471
1461
|
key: string;
|
1472
1462
|
value: string;
|
1473
1463
|
}[];
|
@@ -1515,15 +1505,11 @@ interface external$4 {
|
|
1515
1505
|
badgeIconUrl?: string;
|
1516
1506
|
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
|
1517
1507
|
headers?: {
|
1518
|
-
[key: string]: string;
|
1519
|
-
} | {
|
1520
1508
|
key: string;
|
1521
1509
|
value: string;
|
1522
1510
|
}[];
|
1523
1511
|
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
1524
1512
|
parameters?: {
|
1525
|
-
[key: string]: string;
|
1526
|
-
} | {
|
1527
1513
|
key: string;
|
1528
1514
|
value: string;
|
1529
1515
|
}[];
|
@@ -1976,15 +1962,13 @@ interface external$3 {
|
|
1976
1962
|
connectorType: string;
|
1977
1963
|
/** @description Base resource URL of the data source. No trailing slash. */
|
1978
1964
|
baseUrl: string;
|
1965
|
+
/** @description HTTP headers to pass with requests to the data source */
|
1979
1966
|
headers?: {
|
1980
|
-
[key: string]: string;
|
1981
|
-
} | {
|
1982
1967
|
key: string;
|
1983
1968
|
value: string;
|
1984
1969
|
}[];
|
1970
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
1985
1971
|
parameters?: {
|
1986
|
-
[key: string]: string;
|
1987
|
-
} | {
|
1988
1972
|
key: string;
|
1989
1973
|
value: string;
|
1990
1974
|
}[];
|
@@ -2032,15 +2016,11 @@ interface external$3 {
|
|
2032
2016
|
badgeIconUrl?: string;
|
2033
2017
|
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
|
2034
2018
|
headers?: {
|
2035
|
-
[key: string]: string;
|
2036
|
-
} | {
|
2037
2019
|
key: string;
|
2038
2020
|
value: string;
|
2039
2021
|
}[];
|
2040
2022
|
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
2041
2023
|
parameters?: {
|
2042
|
-
[key: string]: string;
|
2043
|
-
} | {
|
2044
2024
|
key: string;
|
2045
2025
|
value: string;
|
2046
2026
|
}[];
|
@@ -2160,6 +2140,8 @@ interface external$3 {
|
|
2160
2140
|
* embedded into it, and serialize the pattern data separately.
|
2161
2141
|
*/
|
2162
2142
|
skipPatternResolution?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["skipPatternResolution"];
|
2143
|
+
/** If true, any dynamic parameters will be left with their raw data. Project map link path is a dynamic parameter. */
|
2144
|
+
skipParameterResolution?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["skipParameterResolution"];
|
2163
2145
|
/** Specify a single composition to fetch by slug. Changes response from list to single. */
|
2164
2146
|
slug?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["slug"];
|
2165
2147
|
/** State of compositions to fetch. 0 = draft, 64 = published. */
|
@@ -2356,6 +2338,8 @@ interface external$3 {
|
|
2356
2338
|
* embedded into it, and serialize the pattern data separately.
|
2357
2339
|
*/
|
2358
2340
|
skipPatternResolution: boolean;
|
2341
|
+
/** @description If true, any dynamic parameters will be left with their raw data. Project map link path is a dynamic parameter. */
|
2342
|
+
skipParameterResolution: boolean;
|
2359
2343
|
/**
|
2360
2344
|
* @description If true the `_id` unique identifier of each non-root component will be part of the response data.
|
2361
2345
|
* If false, the `_id` will not be present in the API response.
|
@@ -2402,80 +2386,80 @@ interface external$3 {
|
|
2402
2386
|
};
|
2403
2387
|
}
|
2404
2388
|
|
2405
|
-
|
2406
|
-
|
2407
|
-
|
2389
|
+
type Components = components$1['schemas'];
|
2390
|
+
type SharedComponents = components$2['schemas'];
|
2391
|
+
type Api = paths$3['/api/v1/canvas'];
|
2408
2392
|
/** Query parameter options for GET /api/v1/canvas */
|
2409
|
-
|
2393
|
+
type CompositionGetParameters = Omit<Api['get']['parameters']['query'], 'type'> & {
|
2410
2394
|
type?: string | string[];
|
2411
2395
|
};
|
2412
|
-
|
2396
|
+
type CompositionGetOrderBy = NonNullable<Api['get']['parameters']['query']['orderBy']>[0];
|
2413
2397
|
/** The GET response from /api/v1/canvas when `component` or `slug` params are specified */
|
2414
|
-
|
2398
|
+
type CompositionGetResponse = Components['CompositionApiResponse'];
|
2415
2399
|
/** @deprecated - internal use, do not rely on this value */
|
2416
|
-
|
2400
|
+
type CompositionUIStatus = NonNullable<Components['CompositionApiResponse']['uiStatus']>;
|
2417
2401
|
/** The GET response from /api/v1/canvas when `component` or `slug` are not specified */
|
2418
|
-
|
2402
|
+
type CompositionGetListResponse = Components['CompositionListResponse'];
|
2419
2403
|
/** The PUT request body for /api/v1/canvas */
|
2420
|
-
|
2404
|
+
type CompositionPutParameters = Api['put']['requestBody']['content']['application/json'];
|
2421
2405
|
/** Shape of the DELETE request body for /api/v1/canvas */
|
2422
|
-
|
2406
|
+
type CompositionDeleteParameters = Api['delete']['requestBody']['content']['application/json'];
|
2423
2407
|
/** @deprecated use CompositionGetResponse */
|
2424
|
-
|
2408
|
+
type CompositionAPIResponse = CompositionGetResponse;
|
2425
2409
|
/** @deprecated use CompositionDeleteParameters */
|
2426
|
-
|
2410
|
+
type CompositionAPIDeleteRequest = CompositionDeleteParameters;
|
2427
2411
|
/** @deprecated use CompositionGetParameters */
|
2428
|
-
|
2412
|
+
type CompositionListAPIResponse = CompositionGetListResponse;
|
2429
2413
|
/** @deprecated use CompositionGetParameters */
|
2430
|
-
|
2414
|
+
type CompositionAPIOptions = CompositionGetParameters;
|
2431
2415
|
/** Defines an editable parameter on a component. */
|
2432
|
-
|
2416
|
+
type ComponentParameter<TValue = unknown> = Omit<SharedComponents['ComponentParameter'], 'value'> & {
|
2433
2417
|
/** The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
2434
2418
|
value: TValue;
|
2435
2419
|
};
|
2436
2420
|
/** Defines a connection to a data element on a data resource. */
|
2437
|
-
|
2421
|
+
type DataElementConnectionDefinition = SharedComponents['DataElementConnectionDefinition'];
|
2438
2422
|
/** Variable values for a data resource. */
|
2439
|
-
|
2423
|
+
type DataResourceVariables = SharedComponents['DataResourceVariables'];
|
2440
2424
|
/**
|
2441
2425
|
* Data definitions attached to this component. The property name is the key of the data in the data document.
|
2442
2426
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
2443
2427
|
*/
|
2444
|
-
|
2428
|
+
type DataResourceDefinitions = SharedComponents['DataResourceDefinitions'];
|
2445
2429
|
/** Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
2446
|
-
|
2430
|
+
type DataResourceDefinition = SharedComponents['DataResourceDefinition'];
|
2447
2431
|
/** Defines the shape of a component instance served by the composition API. */
|
2448
|
-
|
2432
|
+
type ComponentInstance = SharedComponents['ComponentInstance'] & {
|
2449
2433
|
/** Data for the component instance, provided by a component enhancer. Never set in unenhanced data. */
|
2450
2434
|
data?: Record<string, unknown>;
|
2451
2435
|
};
|
2452
2436
|
/** Defines the shape of the root component in a composition */
|
2453
|
-
|
2437
|
+
type RootComponentInstance = SharedComponents['RootComponentInstance'];
|
2454
2438
|
/** Defines single structure to keep all canvas models (used in CLI commands and Starter content generations) */
|
2455
|
-
|
2439
|
+
type CanvasDefinitions = {
|
2456
2440
|
components?: Array<ComponentDefinition>;
|
2457
2441
|
compositions?: Array<CompositionGetResponse>;
|
2458
2442
|
dataTypes?: Array<DataType>;
|
2459
2443
|
};
|
2460
2444
|
/** Defines shared parameters for requests getting a single composition */
|
2461
|
-
|
2462
|
-
|
2445
|
+
type CompositionGetOneSharedParameters = Pick<CompositionGetParameters, 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus' | 'withTotalCount'>;
|
2446
|
+
type CompositionGetBy<RequiredParameters extends keyof CompositionGetParameters> = CompositionGetOneSharedParameters & Required<Pick<CompositionGetParameters, RequiredParameters>>;
|
2463
2447
|
/** Defines exact parameters for specific requests getting a single composition */
|
2464
|
-
|
2465
|
-
|
2466
|
-
|
2467
|
-
|
2448
|
+
type CompositionGetByNodePathParameters = CompositionGetBy<'projectMapNodePath' | 'projectMapId'>;
|
2449
|
+
type CompositionGetByNodeIdParameters = CompositionGetBy<'projectMapNodeId' | 'projectMapId'>;
|
2450
|
+
type CompositionGetBySlugParameters = CompositionGetBy<'slug'>;
|
2451
|
+
type CompositionGetByIdParameters = CompositionGetBy<'compositionId'>;
|
2468
2452
|
/** Switches for data resolution */
|
2469
|
-
|
2453
|
+
type DataResolutionOption = {
|
2470
2454
|
unstable_resolveData?: boolean;
|
2471
2455
|
};
|
2472
|
-
|
2456
|
+
type DataResolutionOptionNegative = {
|
2473
2457
|
unstable_resolveData?: false;
|
2474
2458
|
};
|
2475
|
-
|
2459
|
+
type DataResolutionOptionPositive = {
|
2476
2460
|
unstable_resolveData: true;
|
2477
2461
|
};
|
2478
|
-
|
2462
|
+
type DataResolutionParameters = {
|
2479
2463
|
/**
|
2480
2464
|
* Adds additional diagnostics (`dataDiagnostics`) to the response containing timings and resolved datas for the composition.
|
2481
2465
|
* Because this adds a lot of data to the response, we do not recommend using this unless diagnosing performance issues.
|
@@ -2488,37 +2472,37 @@ declare type DataResolutionParameters = {
|
|
2488
2472
|
unstable_dynamicVariables?: Record<string, string>;
|
2489
2473
|
};
|
2490
2474
|
/** Types of issue that can occur when fetching composition data */
|
2491
|
-
|
2492
|
-
|
2475
|
+
type CompositionIssue = CompositionPatternIssue | DataResourceIssue | DataElementBindingIssue | DataResourceVariableIssue | DataResolutionConfigIssue;
|
2476
|
+
type CompositionIssueCore = components['schemas']['CompositionIssue'];
|
2493
2477
|
/** An error that occured resolving a pattern that is referenced on the composition */
|
2494
|
-
|
2478
|
+
type CompositionPatternIssue = CompositionIssueCore & {
|
2495
2479
|
type: 'pattern';
|
2496
2480
|
code: NonNullable<ComponentInstance['_patternError']>;
|
2497
2481
|
};
|
2498
2482
|
/** 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
|
-
|
2483
|
+
type DataElementBindingIssue = CompositionIssueCore & {
|
2500
2484
|
type: 'binding';
|
2501
2485
|
parameterName: string;
|
2502
2486
|
};
|
2503
2487
|
/** An error that occurred fetching a data defined on the composition or a pattern within */
|
2504
|
-
|
2488
|
+
type DataResourceIssue = CompositionIssueCore & {
|
2505
2489
|
type: 'data';
|
2506
2490
|
dataName: string;
|
2507
2491
|
dataType: string;
|
2508
2492
|
};
|
2509
2493
|
/** An issue that occurred while binding dynamic variables to composition data resources */
|
2510
|
-
|
2494
|
+
type DataResourceVariableIssue = CompositionIssueCore & {
|
2511
2495
|
type: 'variable';
|
2512
2496
|
variableName: string;
|
2513
2497
|
};
|
2514
|
-
|
2498
|
+
type DataResolutionConfigIssue = {
|
2515
2499
|
message: string;
|
2516
2500
|
type: 'config';
|
2517
2501
|
};
|
2518
2502
|
/** Diagnostic data about the load performance of attached composition datas */
|
2519
|
-
|
2503
|
+
type CompositionDataDiagnostic = components['schemas']['DataDiagnostic'];
|
2520
2504
|
/** Response as it comes from the data resolution endpoint */
|
2521
|
-
|
2505
|
+
type CompositionResolvedGetResponse = CompositionGetResponse & {
|
2522
2506
|
/**
|
2523
2507
|
* Copies of resolved data and how long it took to resolve each data.
|
2524
2508
|
* Only set when dataDiagnostics=true is passed to the options.
|
@@ -2537,7 +2521,7 @@ declare type CompositionResolvedGetResponse = CompositionGetResponse & {
|
|
2537
2521
|
warnings?: Array<CompositionIssue>;
|
2538
2522
|
};
|
2539
2523
|
/** All valid response types */
|
2540
|
-
|
2524
|
+
type CompositionGetValidResponses = CompositionGetResponse | CompositionResolvedGetResponse;
|
2541
2525
|
|
2542
2526
|
/**
|
2543
2527
|
* This file was auto-generated by openapi-typescript.
|
@@ -2883,15 +2867,13 @@ interface external$2 {
|
|
2883
2867
|
connectorType: string;
|
2884
2868
|
/** @description Base resource URL of the data source. No trailing slash. */
|
2885
2869
|
baseUrl: string;
|
2870
|
+
/** @description HTTP headers to pass with requests to the data source */
|
2886
2871
|
headers?: {
|
2887
|
-
[key: string]: string;
|
2888
|
-
} | {
|
2889
2872
|
key: string;
|
2890
2873
|
value: string;
|
2891
2874
|
}[];
|
2875
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
2892
2876
|
parameters?: {
|
2893
|
-
[key: string]: string;
|
2894
|
-
} | {
|
2895
2877
|
key: string;
|
2896
2878
|
value: string;
|
2897
2879
|
}[];
|
@@ -2939,15 +2921,11 @@ interface external$2 {
|
|
2939
2921
|
badgeIconUrl?: string;
|
2940
2922
|
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
|
2941
2923
|
headers?: {
|
2942
|
-
[key: string]: string;
|
2943
|
-
} | {
|
2944
2924
|
key: string;
|
2945
2925
|
value: string;
|
2946
2926
|
}[];
|
2947
2927
|
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
2948
2928
|
parameters?: {
|
2949
|
-
[key: string]: string;
|
2950
|
-
} | {
|
2951
2929
|
key: string;
|
2952
2930
|
value: string;
|
2953
2931
|
}[];
|
@@ -3325,15 +3303,13 @@ interface external$1 {
|
|
3325
3303
|
connectorType: string;
|
3326
3304
|
/** @description Base resource URL of the data source. No trailing slash. */
|
3327
3305
|
baseUrl: string;
|
3306
|
+
/** @description HTTP headers to pass with requests to the data source */
|
3328
3307
|
headers?: {
|
3329
|
-
[key: string]: string;
|
3330
|
-
} | {
|
3331
3308
|
key: string;
|
3332
3309
|
value: string;
|
3333
3310
|
}[];
|
3311
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
3334
3312
|
parameters?: {
|
3335
|
-
[key: string]: string;
|
3336
|
-
} | {
|
3337
3313
|
key: string;
|
3338
3314
|
value: string;
|
3339
3315
|
}[];
|
@@ -3381,15 +3357,11 @@ interface external$1 {
|
|
3381
3357
|
badgeIconUrl?: string;
|
3382
3358
|
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
|
3383
3359
|
headers?: {
|
3384
|
-
[key: string]: string;
|
3385
|
-
} | {
|
3386
3360
|
key: string;
|
3387
3361
|
value: string;
|
3388
3362
|
}[];
|
3389
3363
|
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
3390
3364
|
parameters?: {
|
3391
|
-
[key: string]: string;
|
3392
|
-
} | {
|
3393
3365
|
key: string;
|
3394
3366
|
value: string;
|
3395
3367
|
}[];
|
@@ -3802,15 +3774,13 @@ interface external {
|
|
3802
3774
|
connectorType: string;
|
3803
3775
|
/** @description Base resource URL of the data source. No trailing slash. */
|
3804
3776
|
baseUrl: string;
|
3777
|
+
/** @description HTTP headers to pass with requests to the data source */
|
3805
3778
|
headers?: {
|
3806
|
-
[key: string]: string;
|
3807
|
-
} | {
|
3808
3779
|
key: string;
|
3809
3780
|
value: string;
|
3810
3781
|
}[];
|
3782
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
3811
3783
|
parameters?: {
|
3812
|
-
[key: string]: string;
|
3813
|
-
} | {
|
3814
3784
|
key: string;
|
3815
3785
|
value: string;
|
3816
3786
|
}[];
|
@@ -3858,15 +3828,11 @@ interface external {
|
|
3858
3828
|
badgeIconUrl?: string;
|
3859
3829
|
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
|
3860
3830
|
headers?: {
|
3861
|
-
[key: string]: string;
|
3862
|
-
} | {
|
3863
3831
|
key: string;
|
3864
3832
|
value: string;
|
3865
3833
|
}[];
|
3866
3834
|
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
3867
3835
|
parameters?: {
|
3868
|
-
[key: string]: string;
|
3869
|
-
} | {
|
3870
3836
|
key: string;
|
3871
3837
|
value: string;
|
3872
3838
|
}[];
|
@@ -3938,43 +3904,43 @@ interface external {
|
|
3938
3904
|
};
|
3939
3905
|
}
|
3940
3906
|
|
3941
|
-
|
3942
|
-
|
3943
|
-
|
3907
|
+
type DataTypeApi = paths['/api/v1/data-types'];
|
3908
|
+
type DataSourcesApi = paths$1['/api/v1/data-sources'];
|
3909
|
+
type DataSourceApi = paths$2['/api/v1/data-source'];
|
3944
3910
|
/** Query parameter options for GET /api/v1/data-types */
|
3945
|
-
|
3911
|
+
type DataTypeGetParameters = DataTypeApi['get']['parameters']['query'];
|
3946
3912
|
/** The GET response from /api/v1/data-types */
|
3947
|
-
|
3913
|
+
type DataTypeGetResponse = DataTypeApi['get']['responses']['200']['content']['application/json'];
|
3948
3914
|
/** The PUT request body for /api/v1/data-types */
|
3949
|
-
|
3915
|
+
type DataTypePutParameters = DataTypeApi['put']['requestBody']['content']['application/json'];
|
3950
3916
|
/** Shape of the DELETE request body for /api/v1/data-types */
|
3951
|
-
|
3917
|
+
type DataTypeDeleteParameters = DataTypeApi['delete']['requestBody']['content']['application/json'];
|
3952
3918
|
/** Query parameter options for GET /api/v1/data-source */
|
3953
|
-
|
3919
|
+
type DataSourceGetParameters = DataSourceApi['get']['parameters']['query'];
|
3954
3920
|
/** Query parameter options for GET /api/v1/data-sources */
|
3955
|
-
|
3921
|
+
type DataSourcesGetParameters = DataSourcesApi['get']['parameters']['query'];
|
3956
3922
|
/** The GET response from /api/v1/data-sources */
|
3957
|
-
|
3923
|
+
type DataSourceGetResponse = DataSourceApi['get']['responses']['200']['content']['application/json'];
|
3958
3924
|
/** The GET response from /api/v1/data-sources */
|
3959
|
-
|
3925
|
+
type DataSourcesGetResponse = DataSourcesApi['get']['responses']['200']['content']['application/json'];
|
3960
3926
|
/** The PUT request body for /api/v1/data-source */
|
3961
|
-
|
3927
|
+
type DataSourcePutParameters = DataSourceApi['put']['requestBody']['content']['application/json'];
|
3962
3928
|
/** Shape of the DELETE request body for /api/v1/data-source */
|
3963
|
-
|
3964
|
-
|
3965
|
-
|
3966
|
-
|
3929
|
+
type DataSourceDeleteParameters = DataSourceApi['delete']['requestBody']['content']['application/json'];
|
3930
|
+
type DataType = components$2['schemas']['DataType'];
|
3931
|
+
type DataSource = components$2['schemas']['DataSource'];
|
3932
|
+
type DataVariableDefinition = components$2['schemas']['DataVariableDefinition'];
|
3967
3933
|
|
3968
3934
|
/**
|
3969
3935
|
* Pusher-js is large (80k) and not tree shakable so it is always bundled if directly referenced,
|
3970
3936
|
* when it's only needed during preview mode. To avoid bundling it for all, we use an old-school
|
3971
3937
|
* write-a-script-tag hack to load it in a poor man's approximation of a dynamic import ;)
|
3972
3938
|
*/
|
3973
|
-
|
3939
|
+
type ChannelSubscription = {
|
3974
3940
|
addEventHandler: (eventName: string, handler: (data: unknown) => void) => () => void;
|
3975
3941
|
unsubscribe: () => void;
|
3976
3942
|
};
|
3977
|
-
|
3943
|
+
type PreviewEventBus = {
|
3978
3944
|
subscribe: (channel: string) => ChannelSubscription;
|
3979
3945
|
};
|
3980
3946
|
declare global {
|