@uniformdev/canvas 17.7.1-alpha.34 → 18.0.0
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/LICENSE.txt +1 -1
- package/dist/chunk-FIKDTGXG.mjs +1495 -0
- package/dist/cli/cli.d.ts +2 -2
- package/dist/cli/cli.js +19831 -74
- package/dist/cli/cli.mjs +19242 -74
- package/dist/{createEventBus-2f37d8dd.d.ts → createEventBus-bd2e0a92.d.ts} +85 -77
- package/dist/index.d.ts +30 -30
- 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
@@ -850,40 +850,40 @@ interface external$5 {
|
|
850
850
|
};
|
851
851
|
}
|
852
852
|
|
853
|
-
|
854
|
-
|
853
|
+
type SharedComponents$1 = components$2['schemas'];
|
854
|
+
type Api$1 = paths$4['/api/v1/canvas-definitions'];
|
855
855
|
/** Shape of the GET response from /api/v1/canvas-definitions */
|
856
|
-
|
856
|
+
type ComponentDefinitionGetResponse = Api$1['get']['responses']['200']['content']['application/json'];
|
857
857
|
/** Shape of the PUT request body for /api/v1/canvas-definitions */
|
858
|
-
|
858
|
+
type ComponentDefinitionPutParameters = Api$1['put']['requestBody']['content']['application/json'];
|
859
859
|
/** Shape of the DELETE request body for /api/v1/canvas-definitions */
|
860
|
-
|
860
|
+
type ComponentDefinitionDeleteParameters = Api$1['delete']['requestBody']['content']['application/json'];
|
861
861
|
/** Query parameter options for GET /api/v1/canvas-definitions */
|
862
|
-
|
862
|
+
type ComponentDefinitionGetParameters = Api$1['get']['parameters']['query'];
|
863
863
|
/** @deprecated use ComponentDefinitionGetResponse instead */
|
864
|
-
|
864
|
+
type ComponentDefinitionAPIResponse = ComponentDefinitionGetResponse;
|
865
865
|
/** @deprecated use ComponentDefinitionPutParameters */
|
866
|
-
|
866
|
+
type ComponentDefinitionAPIPutRequest = ComponentDefinitionPutParameters;
|
867
867
|
/** @deprecated use ComponentDefinitionDeleteParameters */
|
868
|
-
|
868
|
+
type ComponentDefinitionAPIDeleteRequest = ComponentDefinitionDeleteParameters;
|
869
869
|
/** @deprecated use ComponentDefinitionGetParameters */
|
870
|
-
|
870
|
+
type ComponentDefinitionListAPIOptions = ComponentDefinitionGetParameters;
|
871
871
|
/** The definition of a component parameter */
|
872
|
-
|
872
|
+
type ComponentDefinitionParameter<TConfig = unknown> = Omit<components$2['schemas']['ComponentDefinitionParameter'], 'typeConfig'> & {
|
873
873
|
typeConfig?: TConfig;
|
874
874
|
};
|
875
875
|
/** The definition of a component visual variant */
|
876
|
-
|
876
|
+
type ComponentDefinitionVariant = SharedComponents$1['ComponentDefinitionVariant'];
|
877
877
|
/** The definition of a composition's slug settings */
|
878
|
-
|
878
|
+
type ComponentDefinitionSlugSettings = SharedComponents$1['ComponentDefinitionSlugSettings'];
|
879
879
|
/** The definition of a named component slot that can contain other components */
|
880
|
-
|
880
|
+
type ComponentDefinitionSlot = SharedComponents$1['ComponentDefinitionSlot'];
|
881
881
|
/** Permission set for a component defintion */
|
882
|
-
|
882
|
+
type ComponentDefinitionPermission = SharedComponents$1['ComponentDefinitionPermission'];
|
883
883
|
/** Defines a component type that can live on a Composition */
|
884
|
-
|
884
|
+
type ComponentDefinition = SharedComponents$1['ComponentDefinition'];
|
885
885
|
/** @deprecated use ComponentDefinition instead */
|
886
|
-
|
886
|
+
type CreatingComponentDefinition = Omit<Partial<ComponentDefinition>, 'created' | 'updated'>;
|
887
887
|
|
888
888
|
/**
|
889
889
|
* This file was auto-generated by openapi-typescript.
|
@@ -938,6 +938,8 @@ interface paths$3 {
|
|
938
938
|
* embedded into it, and serialize the pattern data separately.
|
939
939
|
*/
|
940
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"];
|
941
943
|
/** Specify a single composition to fetch by slug. Changes response from list to single. */
|
942
944
|
slug?: components$1["parameters"]["slug"];
|
943
945
|
/** State of compositions to fetch. 0 = draft, 64 = published. */
|
@@ -1134,6 +1136,8 @@ interface components$1 {
|
|
1134
1136
|
* embedded into it, and serialize the pattern data separately.
|
1135
1137
|
*/
|
1136
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;
|
1137
1141
|
/**
|
1138
1142
|
* @description If true the `_id` unique identifier of each non-root component will be part of the response data.
|
1139
1143
|
* If false, the `_id` will not be present in the API response.
|
@@ -2136,6 +2140,8 @@ interface external$3 {
|
|
2136
2140
|
* embedded into it, and serialize the pattern data separately.
|
2137
2141
|
*/
|
2138
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"];
|
2139
2145
|
/** Specify a single composition to fetch by slug. Changes response from list to single. */
|
2140
2146
|
slug?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["slug"];
|
2141
2147
|
/** State of compositions to fetch. 0 = draft, 64 = published. */
|
@@ -2332,6 +2338,8 @@ interface external$3 {
|
|
2332
2338
|
* embedded into it, and serialize the pattern data separately.
|
2333
2339
|
*/
|
2334
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;
|
2335
2343
|
/**
|
2336
2344
|
* @description If true the `_id` unique identifier of each non-root component will be part of the response data.
|
2337
2345
|
* If false, the `_id` will not be present in the API response.
|
@@ -2378,80 +2386,80 @@ interface external$3 {
|
|
2378
2386
|
};
|
2379
2387
|
}
|
2380
2388
|
|
2381
|
-
|
2382
|
-
|
2383
|
-
|
2389
|
+
type Components = components$1['schemas'];
|
2390
|
+
type SharedComponents = components$2['schemas'];
|
2391
|
+
type Api = paths$3['/api/v1/canvas'];
|
2384
2392
|
/** Query parameter options for GET /api/v1/canvas */
|
2385
|
-
|
2393
|
+
type CompositionGetParameters = Omit<Api['get']['parameters']['query'], 'type'> & {
|
2386
2394
|
type?: string | string[];
|
2387
2395
|
};
|
2388
|
-
|
2396
|
+
type CompositionGetOrderBy = NonNullable<Api['get']['parameters']['query']['orderBy']>[0];
|
2389
2397
|
/** The GET response from /api/v1/canvas when `component` or `slug` params are specified */
|
2390
|
-
|
2398
|
+
type CompositionGetResponse = Components['CompositionApiResponse'];
|
2391
2399
|
/** @deprecated - internal use, do not rely on this value */
|
2392
|
-
|
2400
|
+
type CompositionUIStatus = NonNullable<Components['CompositionApiResponse']['uiStatus']>;
|
2393
2401
|
/** The GET response from /api/v1/canvas when `component` or `slug` are not specified */
|
2394
|
-
|
2402
|
+
type CompositionGetListResponse = Components['CompositionListResponse'];
|
2395
2403
|
/** The PUT request body for /api/v1/canvas */
|
2396
|
-
|
2404
|
+
type CompositionPutParameters = Api['put']['requestBody']['content']['application/json'];
|
2397
2405
|
/** Shape of the DELETE request body for /api/v1/canvas */
|
2398
|
-
|
2406
|
+
type CompositionDeleteParameters = Api['delete']['requestBody']['content']['application/json'];
|
2399
2407
|
/** @deprecated use CompositionGetResponse */
|
2400
|
-
|
2408
|
+
type CompositionAPIResponse = CompositionGetResponse;
|
2401
2409
|
/** @deprecated use CompositionDeleteParameters */
|
2402
|
-
|
2410
|
+
type CompositionAPIDeleteRequest = CompositionDeleteParameters;
|
2403
2411
|
/** @deprecated use CompositionGetParameters */
|
2404
|
-
|
2412
|
+
type CompositionListAPIResponse = CompositionGetListResponse;
|
2405
2413
|
/** @deprecated use CompositionGetParameters */
|
2406
|
-
|
2414
|
+
type CompositionAPIOptions = CompositionGetParameters;
|
2407
2415
|
/** Defines an editable parameter on a component. */
|
2408
|
-
|
2416
|
+
type ComponentParameter<TValue = unknown> = Omit<SharedComponents['ComponentParameter'], 'value'> & {
|
2409
2417
|
/** The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
2410
2418
|
value: TValue;
|
2411
2419
|
};
|
2412
2420
|
/** Defines a connection to a data element on a data resource. */
|
2413
|
-
|
2421
|
+
type DataElementConnectionDefinition = SharedComponents['DataElementConnectionDefinition'];
|
2414
2422
|
/** Variable values for a data resource. */
|
2415
|
-
|
2423
|
+
type DataResourceVariables = SharedComponents['DataResourceVariables'];
|
2416
2424
|
/**
|
2417
2425
|
* Data definitions attached to this component. The property name is the key of the data in the data document.
|
2418
2426
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
2419
2427
|
*/
|
2420
|
-
|
2428
|
+
type DataResourceDefinitions = SharedComponents['DataResourceDefinitions'];
|
2421
2429
|
/** Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
2422
|
-
|
2430
|
+
type DataResourceDefinition = SharedComponents['DataResourceDefinition'];
|
2423
2431
|
/** Defines the shape of a component instance served by the composition API. */
|
2424
|
-
|
2432
|
+
type ComponentInstance = SharedComponents['ComponentInstance'] & {
|
2425
2433
|
/** Data for the component instance, provided by a component enhancer. Never set in unenhanced data. */
|
2426
2434
|
data?: Record<string, unknown>;
|
2427
2435
|
};
|
2428
2436
|
/** Defines the shape of the root component in a composition */
|
2429
|
-
|
2437
|
+
type RootComponentInstance = SharedComponents['RootComponentInstance'];
|
2430
2438
|
/** Defines single structure to keep all canvas models (used in CLI commands and Starter content generations) */
|
2431
|
-
|
2439
|
+
type CanvasDefinitions = {
|
2432
2440
|
components?: Array<ComponentDefinition>;
|
2433
2441
|
compositions?: Array<CompositionGetResponse>;
|
2434
2442
|
dataTypes?: Array<DataType>;
|
2435
2443
|
};
|
2436
2444
|
/** Defines shared parameters for requests getting a single composition */
|
2437
|
-
|
2438
|
-
|
2445
|
+
type CompositionGetOneSharedParameters = Pick<CompositionGetParameters, 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus' | 'withTotalCount'>;
|
2446
|
+
type CompositionGetBy<RequiredParameters extends keyof CompositionGetParameters> = CompositionGetOneSharedParameters & Required<Pick<CompositionGetParameters, RequiredParameters>>;
|
2439
2447
|
/** Defines exact parameters for specific requests getting a single composition */
|
2440
|
-
|
2441
|
-
|
2442
|
-
|
2443
|
-
|
2448
|
+
type CompositionGetByNodePathParameters = CompositionGetBy<'projectMapNodePath' | 'projectMapId'>;
|
2449
|
+
type CompositionGetByNodeIdParameters = CompositionGetBy<'projectMapNodeId' | 'projectMapId'>;
|
2450
|
+
type CompositionGetBySlugParameters = CompositionGetBy<'slug'>;
|
2451
|
+
type CompositionGetByIdParameters = CompositionGetBy<'compositionId'>;
|
2444
2452
|
/** Switches for data resolution */
|
2445
|
-
|
2453
|
+
type DataResolutionOption = {
|
2446
2454
|
unstable_resolveData?: boolean;
|
2447
2455
|
};
|
2448
|
-
|
2456
|
+
type DataResolutionOptionNegative = {
|
2449
2457
|
unstable_resolveData?: false;
|
2450
2458
|
};
|
2451
|
-
|
2459
|
+
type DataResolutionOptionPositive = {
|
2452
2460
|
unstable_resolveData: true;
|
2453
2461
|
};
|
2454
|
-
|
2462
|
+
type DataResolutionParameters = {
|
2455
2463
|
/**
|
2456
2464
|
* Adds additional diagnostics (`dataDiagnostics`) to the response containing timings and resolved datas for the composition.
|
2457
2465
|
* Because this adds a lot of data to the response, we do not recommend using this unless diagnosing performance issues.
|
@@ -2464,37 +2472,37 @@ declare type DataResolutionParameters = {
|
|
2464
2472
|
unstable_dynamicVariables?: Record<string, string>;
|
2465
2473
|
};
|
2466
2474
|
/** Types of issue that can occur when fetching composition data */
|
2467
|
-
|
2468
|
-
|
2475
|
+
type CompositionIssue = CompositionPatternIssue | DataResourceIssue | DataElementBindingIssue | DataResourceVariableIssue | DataResolutionConfigIssue;
|
2476
|
+
type CompositionIssueCore = components['schemas']['CompositionIssue'];
|
2469
2477
|
/** An error that occured resolving a pattern that is referenced on the composition */
|
2470
|
-
|
2478
|
+
type CompositionPatternIssue = CompositionIssueCore & {
|
2471
2479
|
type: 'pattern';
|
2472
2480
|
code: NonNullable<ComponentInstance['_patternError']>;
|
2473
2481
|
};
|
2474
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) */
|
2475
|
-
|
2483
|
+
type DataElementBindingIssue = CompositionIssueCore & {
|
2476
2484
|
type: 'binding';
|
2477
2485
|
parameterName: string;
|
2478
2486
|
};
|
2479
2487
|
/** An error that occurred fetching a data defined on the composition or a pattern within */
|
2480
|
-
|
2488
|
+
type DataResourceIssue = CompositionIssueCore & {
|
2481
2489
|
type: 'data';
|
2482
2490
|
dataName: string;
|
2483
2491
|
dataType: string;
|
2484
2492
|
};
|
2485
2493
|
/** An issue that occurred while binding dynamic variables to composition data resources */
|
2486
|
-
|
2494
|
+
type DataResourceVariableIssue = CompositionIssueCore & {
|
2487
2495
|
type: 'variable';
|
2488
2496
|
variableName: string;
|
2489
2497
|
};
|
2490
|
-
|
2498
|
+
type DataResolutionConfigIssue = {
|
2491
2499
|
message: string;
|
2492
2500
|
type: 'config';
|
2493
2501
|
};
|
2494
2502
|
/** Diagnostic data about the load performance of attached composition datas */
|
2495
|
-
|
2503
|
+
type CompositionDataDiagnostic = components['schemas']['DataDiagnostic'];
|
2496
2504
|
/** Response as it comes from the data resolution endpoint */
|
2497
|
-
|
2505
|
+
type CompositionResolvedGetResponse = CompositionGetResponse & {
|
2498
2506
|
/**
|
2499
2507
|
* Copies of resolved data and how long it took to resolve each data.
|
2500
2508
|
* Only set when dataDiagnostics=true is passed to the options.
|
@@ -2513,7 +2521,7 @@ declare type CompositionResolvedGetResponse = CompositionGetResponse & {
|
|
2513
2521
|
warnings?: Array<CompositionIssue>;
|
2514
2522
|
};
|
2515
2523
|
/** All valid response types */
|
2516
|
-
|
2524
|
+
type CompositionGetValidResponses = CompositionGetResponse | CompositionResolvedGetResponse;
|
2517
2525
|
|
2518
2526
|
/**
|
2519
2527
|
* This file was auto-generated by openapi-typescript.
|
@@ -3896,43 +3904,43 @@ interface external {
|
|
3896
3904
|
};
|
3897
3905
|
}
|
3898
3906
|
|
3899
|
-
|
3900
|
-
|
3901
|
-
|
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'];
|
3902
3910
|
/** Query parameter options for GET /api/v1/data-types */
|
3903
|
-
|
3911
|
+
type DataTypeGetParameters = DataTypeApi['get']['parameters']['query'];
|
3904
3912
|
/** The GET response from /api/v1/data-types */
|
3905
|
-
|
3913
|
+
type DataTypeGetResponse = DataTypeApi['get']['responses']['200']['content']['application/json'];
|
3906
3914
|
/** The PUT request body for /api/v1/data-types */
|
3907
|
-
|
3915
|
+
type DataTypePutParameters = DataTypeApi['put']['requestBody']['content']['application/json'];
|
3908
3916
|
/** Shape of the DELETE request body for /api/v1/data-types */
|
3909
|
-
|
3917
|
+
type DataTypeDeleteParameters = DataTypeApi['delete']['requestBody']['content']['application/json'];
|
3910
3918
|
/** Query parameter options for GET /api/v1/data-source */
|
3911
|
-
|
3919
|
+
type DataSourceGetParameters = DataSourceApi['get']['parameters']['query'];
|
3912
3920
|
/** Query parameter options for GET /api/v1/data-sources */
|
3913
|
-
|
3921
|
+
type DataSourcesGetParameters = DataSourcesApi['get']['parameters']['query'];
|
3914
3922
|
/** The GET response from /api/v1/data-sources */
|
3915
|
-
|
3923
|
+
type DataSourceGetResponse = DataSourceApi['get']['responses']['200']['content']['application/json'];
|
3916
3924
|
/** The GET response from /api/v1/data-sources */
|
3917
|
-
|
3925
|
+
type DataSourcesGetResponse = DataSourcesApi['get']['responses']['200']['content']['application/json'];
|
3918
3926
|
/** The PUT request body for /api/v1/data-source */
|
3919
|
-
|
3927
|
+
type DataSourcePutParameters = DataSourceApi['put']['requestBody']['content']['application/json'];
|
3920
3928
|
/** Shape of the DELETE request body for /api/v1/data-source */
|
3921
|
-
|
3922
|
-
|
3923
|
-
|
3924
|
-
|
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'];
|
3925
3933
|
|
3926
3934
|
/**
|
3927
3935
|
* Pusher-js is large (80k) and not tree shakable so it is always bundled if directly referenced,
|
3928
3936
|
* when it's only needed during preview mode. To avoid bundling it for all, we use an old-school
|
3929
3937
|
* write-a-script-tag hack to load it in a poor man's approximation of a dynamic import ;)
|
3930
3938
|
*/
|
3931
|
-
|
3939
|
+
type ChannelSubscription = {
|
3932
3940
|
addEventHandler: (eventName: string, handler: (data: unknown) => void) => () => void;
|
3933
3941
|
unsubscribe: () => void;
|
3934
3942
|
};
|
3935
|
-
|
3943
|
+
type PreviewEventBus = {
|
3936
3944
|
subscribe: (channel: string) => ChannelSubscription;
|
3937
3945
|
};
|
3938
3946
|
declare global {
|
package/dist/index.d.ts
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
import { ApiClient, ClientOptions, ExceptProject, ApiClientError } from '@uniformdev/context/api';
|
2
2
|
export { ApiClientError } from '@uniformdev/context/api';
|
3
|
-
import { C as CompositionGetParameters, a as CompositionGetByNodePathParameters, D as DataResolutionOptionNegative, b as CompositionGetResponse, c as DataResolutionOptionPositive, d as DataResolutionParameters, e as CompositionResolvedGetResponse, f as CompositionGetValidResponses, g as DataResolutionOption, h as CompositionGetByNodeIdParameters, i as CompositionGetBySlugParameters, j as CompositionGetByIdParameters, k as CompositionPutParameters, l as CompositionDeleteParameters, m as ComponentDefinitionGetParameters, n as ComponentDefinitionPutParameters, o as ComponentDefinitionDeleteParameters, p as ComponentInstance, q as ComponentParameter, r as components, s as DataSourceGetParameters, t as DataSourcesGetParameters, u as DataSourcePutParameters, v as DataSourceDeleteParameters, w as DataTypeGetParameters, x as DataTypeGetResponse, y as DataTypePutParameters, z as DataTypeDeleteParameters, R as RootComponentInstance, P as PreviewEventBus } from './createEventBus-
|
4
|
-
export { a1 as CanvasDefinitions, A as ChannelSubscription, O as ComponentDefinition, H as ComponentDefinitionAPIDeleteRequest, G as ComponentDefinitionAPIPutRequest, F as ComponentDefinitionAPIResponse, o as ComponentDefinitionDeleteParameters, m as ComponentDefinitionGetParameters, E as ComponentDefinitionGetResponse, I as ComponentDefinitionListAPIOptions, J as ComponentDefinitionParameter, N as ComponentDefinitionPermission, n as ComponentDefinitionPutParameters, M as ComponentDefinitionSlot, L as ComponentDefinitionSlugSettings, K as ComponentDefinitionVariant, p as ComponentInstance, q as ComponentParameter, W as CompositionAPIDeleteRequest, Y as CompositionAPIOptions, V as CompositionAPIResponse, a8 as CompositionDataDiagnostic, l as CompositionDeleteParameters, j as CompositionGetByIdParameters, h as CompositionGetByNodeIdParameters, a as CompositionGetByNodePathParameters, i as CompositionGetBySlugParameters, U as CompositionGetListResponse, S as CompositionGetOrderBy, C as CompositionGetParameters, b as CompositionGetResponse, f as CompositionGetValidResponses, a2 as CompositionIssue, X as CompositionListAPIResponse, a3 as CompositionPatternIssue, k as CompositionPutParameters, e as CompositionResolvedGetResponse, T as CompositionUIStatus, Q as CreatingComponentDefinition, a4 as DataElementBindingIssue, Z as DataElementConnectionDefinition, a7 as DataResolutionConfigIssue, g as DataResolutionOption, D as DataResolutionOptionNegative, c as DataResolutionOptionPositive, d as DataResolutionParameters, a0 as DataResourceDefinition, $ as DataResourceDefinitions, a5 as DataResourceIssue, a6 as DataResourceVariableIssue, _ as DataResourceVariables, ac as DataSource, v as DataSourceDeleteParameters, s as DataSourceGetParameters, a9 as DataSourceGetResponse, u as DataSourcePutParameters, t as DataSourcesGetParameters, aa as DataSourcesGetResponse, ab as DataType, z as DataTypeDeleteParameters, w as DataTypeGetParameters, x as DataTypeGetResponse, y as DataTypePutParameters, ad as DataVariableDefinition, P as PreviewEventBus, R as RootComponentInstance, B as createEventBus } from './createEventBus-
|
3
|
+
import { C as CompositionGetParameters, a as CompositionGetByNodePathParameters, D as DataResolutionOptionNegative, b as CompositionGetResponse, c as DataResolutionOptionPositive, d as DataResolutionParameters, e as CompositionResolvedGetResponse, f as CompositionGetValidResponses, g as DataResolutionOption, h as CompositionGetByNodeIdParameters, i as CompositionGetBySlugParameters, j as CompositionGetByIdParameters, k as CompositionPutParameters, l as CompositionDeleteParameters, m as ComponentDefinitionGetParameters, n as ComponentDefinitionPutParameters, o as ComponentDefinitionDeleteParameters, p as ComponentInstance, q as ComponentParameter, r as components, s as DataSourceGetParameters, t as DataSourcesGetParameters, u as DataSourcePutParameters, v as DataSourceDeleteParameters, w as DataTypeGetParameters, x as DataTypeGetResponse, y as DataTypePutParameters, z as DataTypeDeleteParameters, R as RootComponentInstance, P as PreviewEventBus } from './createEventBus-bd2e0a92.js';
|
4
|
+
export { a1 as CanvasDefinitions, A as ChannelSubscription, O as ComponentDefinition, H as ComponentDefinitionAPIDeleteRequest, G as ComponentDefinitionAPIPutRequest, F as ComponentDefinitionAPIResponse, o as ComponentDefinitionDeleteParameters, m as ComponentDefinitionGetParameters, E as ComponentDefinitionGetResponse, I as ComponentDefinitionListAPIOptions, J as ComponentDefinitionParameter, N as ComponentDefinitionPermission, n as ComponentDefinitionPutParameters, M as ComponentDefinitionSlot, L as ComponentDefinitionSlugSettings, K as ComponentDefinitionVariant, p as ComponentInstance, q as ComponentParameter, W as CompositionAPIDeleteRequest, Y as CompositionAPIOptions, V as CompositionAPIResponse, a8 as CompositionDataDiagnostic, l as CompositionDeleteParameters, j as CompositionGetByIdParameters, h as CompositionGetByNodeIdParameters, a as CompositionGetByNodePathParameters, i as CompositionGetBySlugParameters, U as CompositionGetListResponse, S as CompositionGetOrderBy, C as CompositionGetParameters, b as CompositionGetResponse, f as CompositionGetValidResponses, a2 as CompositionIssue, X as CompositionListAPIResponse, a3 as CompositionPatternIssue, k as CompositionPutParameters, e as CompositionResolvedGetResponse, T as CompositionUIStatus, Q as CreatingComponentDefinition, a4 as DataElementBindingIssue, Z as DataElementConnectionDefinition, a7 as DataResolutionConfigIssue, g as DataResolutionOption, D as DataResolutionOptionNegative, c as DataResolutionOptionPositive, d as DataResolutionParameters, a0 as DataResourceDefinition, $ as DataResourceDefinitions, a5 as DataResourceIssue, a6 as DataResourceVariableIssue, _ as DataResourceVariables, ac as DataSource, v as DataSourceDeleteParameters, s as DataSourceGetParameters, a9 as DataSourceGetResponse, u as DataSourcePutParameters, t as DataSourcesGetParameters, aa as DataSourcesGetResponse, ab as DataType, z as DataTypeDeleteParameters, w as DataTypeGetParameters, x as DataTypeGetResponse, y as DataTypePutParameters, ad as DataVariableDefinition, P as PreviewEventBus, R as RootComponentInstance, B as createEventBus } from './createEventBus-bd2e0a92.js';
|
5
5
|
import { Options as Options$1 } from 'p-retry';
|
6
6
|
import { Options } from 'p-throttle';
|
7
7
|
import { PersonalizedVariant, TestVariant } from '@uniformdev/context';
|
@@ -202,11 +202,11 @@ declare class UncachedCanvasClient extends CanvasClient {
|
|
202
202
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
203
203
|
}
|
204
204
|
|
205
|
-
|
205
|
+
type EnhancerContext = {
|
206
206
|
preview?: boolean;
|
207
207
|
};
|
208
208
|
/** Options passed to a ComponentEnhancer function */
|
209
|
-
|
209
|
+
type ComponentEnhancerOptions<TContext extends EnhancerContext = EnhancerContext> = {
|
210
210
|
component: Readonly<ComponentInstance>;
|
211
211
|
context: TContext;
|
212
212
|
};
|
@@ -222,13 +222,13 @@ declare type ComponentEnhancerOptions<TContext extends EnhancerContext = Enhance
|
|
222
222
|
* TValue - sets the configured key in the component's data value to this value
|
223
223
|
* undefined - do not set the component's data key
|
224
224
|
*/
|
225
|
-
|
225
|
+
type ComponentEnhancerFunction<TValue = unknown, TContext extends EnhancerContext = EnhancerContext> = (options: ComponentEnhancerOptions<TContext>) => Promise<TValue | undefined> | TValue | undefined;
|
226
226
|
/**
|
227
227
|
* Defines logic to add arbitrary async data to a component's `data` property.
|
228
228
|
* Used to enhance layout data with information from other platforms, such as private APIs,
|
229
229
|
* where the value is not tied to a parameter and is intrinsic to the component itself.
|
230
230
|
*/
|
231
|
-
|
231
|
+
type ComponentEnhancer<TValue = unknown, TContext extends EnhancerContext = EnhancerContext> = {
|
232
232
|
/** Function called to enhance a single component in a composition. */
|
233
233
|
enhanceOne: ComponentEnhancerFunction<TValue, TContext>;
|
234
234
|
/**
|
@@ -241,7 +241,7 @@ declare type ComponentEnhancer<TValue = unknown, TContext extends EnhancerContex
|
|
241
241
|
completeAll?: () => Promise<void>;
|
242
242
|
};
|
243
243
|
/** Options passed to a ComponentParameterEnhancer function */
|
244
|
-
|
244
|
+
type ComponentParameterEnhancerOptions<TRawValue = unknown, TContext extends EnhancerContext = EnhancerContext> = {
|
245
245
|
parameter: Readonly<ComponentParameter<TRawValue>>;
|
246
246
|
parameterName: string;
|
247
247
|
component: Readonly<ComponentInstance>;
|
@@ -256,13 +256,13 @@ declare type ComponentParameterEnhancerOptions<TRawValue = unknown, TContext ext
|
|
256
256
|
* undefined - do not change the original parameter value
|
257
257
|
* null - sets the parameter value to null, replacing any existing value (i.e. if its value could not be resolved in an external system)
|
258
258
|
*/
|
259
|
-
|
259
|
+
type ComponentParameterEnhancerFunction<TRawValue = unknown, TOutputValue = unknown, TContext extends EnhancerContext = EnhancerContext> = (options: ComponentParameterEnhancerOptions<TRawValue, TContext>) => Promise<TOutputValue | undefined | null> | TOutputValue | undefined | null;
|
260
260
|
/**
|
261
261
|
* Defines logic to replace the value of a component parameter with arbitrary async data.
|
262
262
|
* Used to enhance layout data with information from other platforms, such as CMS, commerce, indexing, etc,
|
263
263
|
* where that data is directly expandable from a parameter value.
|
264
264
|
*/
|
265
|
-
|
265
|
+
type ComponentParameterEnhancer<TRawValue = unknown, TOutputValue = unknown, TContext extends EnhancerContext = EnhancerContext> = {
|
266
266
|
/** Function called to enhance a single parameter to be enhanced. */
|
267
267
|
enhanceOne: ComponentParameterEnhancerFunction<TRawValue, TOutputValue, TContext>;
|
268
268
|
/**
|
@@ -280,10 +280,10 @@ declare type ComponentParameterEnhancer<TRawValue = unknown, TOutputValue = unkn
|
|
280
280
|
completeAll?: () => Promise<number>;
|
281
281
|
};
|
282
282
|
|
283
|
-
|
284
|
-
|
285
|
-
|
286
|
-
|
283
|
+
type schemas = components['schemas'];
|
284
|
+
type InvalidationPayload = schemas['InvalidationPayload'];
|
285
|
+
type InvalidationResult = schemas['InvalidationResult'];
|
286
|
+
type InvalidationInput = InvalidationResult['input'];
|
287
287
|
|
288
288
|
/**
|
289
289
|
* @deprecated
|
@@ -387,7 +387,7 @@ declare class BatchEntry<TArgs, TResult> {
|
|
387
387
|
* and once all enhancements have been queued handles them all in a batch.
|
388
388
|
* Note: this type is adaptable to both ComponentParameterEnhancer and ComponentEnhancer types.
|
389
389
|
*/
|
390
|
-
|
390
|
+
type BatchEnhancer<TArgs, TResult> = {
|
391
391
|
/** Adds a promise to the enhancement queue. */
|
392
392
|
enhanceOne: (args: TArgs) => Promise<TResult | undefined>;
|
393
393
|
/** Calls the batch enhancer function for all queued promises and resolves them. Returns number of processed items. */
|
@@ -413,7 +413,7 @@ declare function createBatchEnhancer<TArgs, TResult>({ handleBatch, shouldQueue,
|
|
413
413
|
*/
|
414
414
|
declare const compose: (input: ComponentParameterEnhancer<any, any> | ComponentParameterEnhancerFunction<any>, ...composers: ReadonlyArray<ComponentParameterEnhancer<any, any> | ComponentParameterEnhancerFunction<any>>) => ComponentParameterEnhancer<any, any>;
|
415
415
|
|
416
|
-
|
416
|
+
type LimitPolicy = <ReturnValue>(func: () => Promise<ReturnValue>) => Promise<ReturnValue>;
|
417
417
|
declare function createLimitPolicy({ throttle, retry, }: {
|
418
418
|
throttle?: Options | false;
|
419
419
|
retry?: Options$1 | false;
|
@@ -485,7 +485,7 @@ declare class EnhancerBuilder {
|
|
485
485
|
resolveComponentEnhancers(component: ComponentInstance): Map<string, ComponentEnhancer<unknown, EnhancerContext>>;
|
486
486
|
}
|
487
487
|
|
488
|
-
|
488
|
+
type EnhancerError = {
|
489
489
|
message: string;
|
490
490
|
error: Error | string;
|
491
491
|
};
|
@@ -529,12 +529,12 @@ declare class UniqueBatchEntries<TArgs, TResult> {
|
|
529
529
|
resolveRemaining(value: TResult): void;
|
530
530
|
}
|
531
531
|
|
532
|
-
|
532
|
+
type ComponentLocationReference = {
|
533
533
|
component: ComponentInstance;
|
534
534
|
parentSlot?: string;
|
535
535
|
parentSlotIndex?: number;
|
536
536
|
};
|
537
|
-
|
537
|
+
type WalkComponentTreeActions<TContext> = {
|
538
538
|
/** Replaces the component being visited with a new object */
|
539
539
|
replaceComponent: (replacementComponent: ComponentInstance) => void;
|
540
540
|
/** Removes the component being visited from the composition */
|
@@ -560,44 +560,44 @@ declare function getComponentJsonPointer(ancestorsAndSelf: Array<ComponentLocati
|
|
560
560
|
withSlots?: boolean | undefined;
|
561
561
|
}): string;
|
562
562
|
|
563
|
-
|
563
|
+
type SelectComponentMessage = {
|
564
564
|
type: 'select-component';
|
565
565
|
id: string;
|
566
566
|
};
|
567
|
-
|
567
|
+
type ReadyMessage = {
|
568
568
|
type: 'ready';
|
569
569
|
};
|
570
|
-
|
570
|
+
type UpdateCompositionMessage = {
|
571
571
|
type: 'update-composition';
|
572
572
|
composition: RootComponentInstance;
|
573
573
|
hash: number | undefined;
|
574
574
|
};
|
575
|
-
|
575
|
+
type AddComponentMessage = {
|
576
576
|
type: 'add-component';
|
577
577
|
parentId: string;
|
578
578
|
slotName: string;
|
579
579
|
index: number;
|
580
580
|
};
|
581
|
-
|
581
|
+
type MoveComponentMessage = {
|
582
582
|
type: 'move-component';
|
583
583
|
componentId: string;
|
584
584
|
slotName: string;
|
585
585
|
index: number;
|
586
586
|
};
|
587
|
-
|
587
|
+
type DismissPlaceholderMessage = {
|
588
588
|
type: 'dismiss-placeholder';
|
589
589
|
parentId: string;
|
590
590
|
slotName: string;
|
591
591
|
};
|
592
|
-
|
592
|
+
type ChannelMessage = SelectComponentMessage | ReadyMessage | UpdateCompositionMessage | AddComponentMessage | MoveComponentMessage | DismissPlaceholderMessage;
|
593
593
|
declare const isSelectComponentMessage: (message: ChannelMessage) => message is SelectComponentMessage;
|
594
594
|
declare const isReadyMessage: (message: ChannelMessage) => message is ReadyMessage;
|
595
595
|
declare const isUpdateCompositionMessage: (message: ChannelMessage) => message is UpdateCompositionMessage;
|
596
596
|
declare const isAddComponentMessage: (message: ChannelMessage) => message is AddComponentMessage;
|
597
597
|
declare const isMovingComponentMessage: (message: ChannelMessage) => message is MoveComponentMessage;
|
598
598
|
declare const isDismissPlaceholderMessage: (message: ChannelMessage) => message is DismissPlaceholderMessage;
|
599
|
-
|
600
|
-
|
599
|
+
type MessageHandler = (message: ChannelMessage, originalEvent: MessageEvent) => void;
|
600
|
+
type Channel = {
|
601
601
|
ready: () => void;
|
602
602
|
destroy: () => void;
|
603
603
|
selectComponent: (id: string) => void;
|
@@ -612,11 +612,11 @@ declare const createCanvasChannel: ({ listenTo, broadcastTo, }: {
|
|
612
612
|
broadcastTo: Window[];
|
613
613
|
}) => Channel;
|
614
614
|
|
615
|
-
|
615
|
+
type EventNames = 'updated';
|
616
616
|
|
617
617
|
declare function getChannelName(projectId: string, compositionId: string, state: number): string;
|
618
618
|
|
619
|
-
|
619
|
+
type SubscribeToCompositionOptions = {
|
620
620
|
projectId: string;
|
621
621
|
compositionId: string;
|
622
622
|
compositionState: number;
|
@@ -624,7 +624,7 @@ declare type SubscribeToCompositionOptions = {
|
|
624
624
|
eventBus: PreviewEventBus;
|
625
625
|
event: EventNames;
|
626
626
|
};
|
627
|
-
|
627
|
+
type UnsubscribeCallback = () => void;
|
628
628
|
/** Subscribes to a composition event */
|
629
629
|
declare function subscribeToComposition({ projectId, compositionId, compositionState, eventBus: { subscribe }, callback, event, }: SubscribeToCompositionOptions): UnsubscribeCallback;
|
630
630
|
|