@uniformdev/canvas 19.157.0 → 19.158.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/dist/index.d.mts CHANGED
@@ -1205,22 +1205,11 @@ interface external$i {
1205
1205
  * Do not make direct changes to the file.
1206
1206
  */
1207
1207
  interface paths$g {
1208
- "/api/v1/canvas-definitions": {
1208
+ "/api/v1/categories": {
1209
1209
  get: {
1210
1210
  parameters: {
1211
1211
  query: {
1212
- /** The project ID to get component definitions for. */
1213
1212
  projectId: string;
1214
- /** Limit list to one result by ID (response remains an array). */
1215
- componentId?: string;
1216
- /** Number of records to skip */
1217
- offset?: number;
1218
- /** Max number of records to return */
1219
- limit?: number;
1220
- /** Whether to fetch system meta-component definitions (personalize, test, etc) */
1221
- includeSystem?: boolean;
1222
- /** Filtration by category ID */
1223
- categories?: string[];
1224
1213
  };
1225
1214
  };
1226
1215
  responses: {
@@ -1228,8 +1217,7 @@ interface paths$g {
1228
1217
  200: {
1229
1218
  content: {
1230
1219
  "application/json": {
1231
- /** @description Component definitions that match the query */
1232
- componentDefinitions: external$h["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"][];
1220
+ categories: external$h["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["Category"][];
1233
1221
  };
1234
1222
  };
1235
1223
  };
@@ -1240,7 +1228,6 @@ interface paths$g {
1240
1228
  500: external$h["swagger.yml"]["components"]["responses"]["InternalServerError"];
1241
1229
  };
1242
1230
  };
1243
- /** Upserts a component definition */
1244
1231
  put: {
1245
1232
  responses: {
1246
1233
  /** OK */
@@ -1254,17 +1241,13 @@ interface paths$g {
1254
1241
  requestBody: {
1255
1242
  content: {
1256
1243
  "application/json": {
1257
- /**
1258
- * Format: uuid
1259
- * @description The project ID to upsert the component definition to
1260
- */
1244
+ /** Format: uuid */
1261
1245
  projectId: string;
1262
- componentDefinition: external$h["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"];
1246
+ categories: external$h["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["Category"][];
1263
1247
  };
1264
1248
  };
1265
1249
  };
1266
1250
  };
1267
- /** Deletes a component definition */
1268
1251
  delete: {
1269
1252
  responses: {
1270
1253
  /** OK */
@@ -1278,24 +1261,14 @@ interface paths$g {
1278
1261
  requestBody: {
1279
1262
  content: {
1280
1263
  "application/json": {
1281
- /** @description The public ID of the component definition to delete */
1282
- componentId: string;
1283
- /**
1284
- * Format: uuid
1285
- * @description The ID of the project the composition to delete belongs to
1286
- */
1264
+ /** Format: uuid */
1265
+ categoryId: string;
1266
+ /** Format: uuid */
1287
1267
  projectId: string;
1288
1268
  };
1289
1269
  };
1290
1270
  };
1291
1271
  };
1292
- /** Handles preflight requests. This endpoint allows CORS. */
1293
- options: {
1294
- responses: {
1295
- /** OK */
1296
- 204: never;
1297
- };
1298
- };
1299
1272
  };
1300
1273
  }
1301
1274
  interface external$h {
@@ -2496,121 +2469,39 @@ interface external$h {
2496
2469
  }
2497
2470
 
2498
2471
  type SharedComponents$3 = components$7['schemas'];
2499
- type Api$2 = paths$g['/api/v1/canvas-definitions'];
2500
- /** Shape of the GET response from /api/v1/canvas-definitions */
2501
- type ComponentDefinitionGetResponse = Api$2['get']['responses']['200']['content']['application/json'];
2502
- /** Shape of the PUT request body for /api/v1/canvas-definitions */
2503
- type ComponentDefinitionPutParameters = Api$2['put']['requestBody']['content']['application/json'];
2504
- /** Shape of the DELETE request body for /api/v1/canvas-definitions */
2505
- type ComponentDefinitionDeleteParameters = Api$2['delete']['requestBody']['content']['application/json'];
2506
- /** Query parameter options for GET /api/v1/canvas-definitions */
2507
- type ComponentDefinitionGetParameters = Api$2['get']['parameters']['query'];
2508
- /** The definition of a component parameter */
2509
- type ComponentDefinitionParameter<TConfig = unknown> = Omit<components$7['schemas']['ComponentDefinitionParameter'], 'typeConfig'> & {
2510
- typeConfig?: TConfig;
2511
- };
2512
- /** The definition of a component visual variant */
2513
- type ComponentDefinitionVariant = SharedComponents$3['ComponentDefinitionVariant'];
2514
- /** The definition of a composition's slug settings */
2515
- type ComponentDefinitionSlugSettings = SharedComponents$3['ComponentDefinitionSlugSettings'];
2516
- /** The definition of a named component slot that can contain other components */
2517
- type ComponentDefinitionSlot = SharedComponents$3['ComponentDefinitionSlot'];
2518
- /** Permission set for a component defintion */
2519
- type ComponentDefinitionPermission = SharedComponents$3['ComponentDefinitionPermission'];
2472
+ type Api$2 = paths$g['/api/v1/categories'];
2473
+ /** Shape of the GET response from /api/v1/category */
2474
+ type CategoriesGetResponse = Api$2['get']['responses']['200']['content']['application/json'];
2475
+ /** Shape of the PUT request body for /api/v1/category */
2476
+ type CategoriesPutParameters = Api$2['put']['requestBody']['content']['application/json'];
2477
+ /** Shape of the DELETE request body for /api/v1/category */
2478
+ type CategoriesDeleteParameters = Api$2['delete']['requestBody']['content']['application/json'];
2479
+ /** Query parameter options for GET /api/v1/category */
2480
+ type CategoriesGetParameters = Api$2['get']['parameters']['query'];
2520
2481
  /** Defines a component type that can live on a Composition */
2521
- type ComponentDefinition = SharedComponents$3['ComponentDefinition'];
2522
-
2523
- /** Public ID of Canvas personalization component type */
2524
- declare const CANVAS_PERSONALIZE_TYPE = "$personalization";
2525
- /** Public ID of Canvas A/B test component type */
2526
- declare const CANVAS_TEST_TYPE = "$test";
2527
- /** Public ID of Canvas localization component type */
2528
- declare const CANVAS_LOCALIZATION_TYPE = "$localization";
2529
- /** Public ID of Canvas slot section component type */
2530
- declare const CANVAS_SLOT_SECTION_TYPE = "$slotSection";
2531
- /** Public ID of the intent tag parameter on the Canvas personalization component type */
2532
- declare const CANVAS_INTENT_TAG_PARAM = "intentTag";
2533
- /** Public ID of the locale parameter on Canvas components */
2534
- declare const CANVAS_LOCALE_TAG_PARAM = "locale";
2535
- /** Parameter type for a block parameter */
2536
- declare const CANVAS_BLOCK_PARAM_TYPE = "$block";
2537
- /** Name of the slot on CANVAS_PERSONALIZE_TYPE */
2538
- declare const CANVAS_PERSONALIZE_SLOT = "pz";
2539
- /** Name of the slot on CANVAS_TEST_TYPE */
2540
- declare const CANVAS_TEST_SLOT = "test";
2541
- /** Name of the slot on CANVAS_TEST_TYPE */
2542
- declare const CANVAS_LOCALIZATION_SLOT = "localized";
2543
- /** Name of the slot on CANVAS_SLOT_SECTION_TYPE */
2544
- declare const CANVAS_SLOT_SECTION_SLOT = "$slotSectionItems";
2545
- /** Constant for a draft composition state. Subject to change. */
2546
- declare const CANVAS_DRAFT_STATE = 0;
2547
- /** Constant for a published composition state. Subject to change. */
2548
- declare const CANVAS_PUBLISHED_STATE = 64;
2549
- /** Constant for editor composition state. */
2550
- declare const CANVAS_EDITOR_STATE = 63;
2551
- /** Public ID of the Uniform Context personalization parameter on Canvas components */
2552
- declare const CANVAS_PERSONALIZATION_PARAM = "$pzCrit";
2553
- /** Public ID of the Uniform Context test variant parameter on Canvas components */
2554
- declare const CANVAS_TEST_VARIANT_PARAM = "$tstVrnt";
2555
- /** Public ID of the Uniform Context enrichment tag parameter on Canvas components */
2556
- declare const CANVAS_ENRICHMENT_TAG_PARAM = "$enr";
2557
- /**
2558
- * The name of the query string used to set a secret to protect for the preview mode.
2559
- * This is not configurable at the moment.
2560
- */
2561
- declare const SECRET_QUERY_STRING_PARAM = "secret";
2562
- /** The name of the query string used to detect if we are in contextual editing mode */
2563
- declare const IN_CONTEXT_EDITOR_QUERY_STRING_PARAM = "is_incontext_editing_mode";
2564
- /** The name of the query string used to indicate that we want to use the playground for preview */
2565
- declare const IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM = "is_incontext_editing_playground";
2566
- /** The name of the query string used to detect if we are in contextual editing mode */
2567
- declare const IN_CONTEXT_EDITOR_FORCED_SETTINGS_QUERY_STRING_PARAM = "is_incontext_editing_forced_settings";
2568
- /** The name of the query string used to get the config from the preview url */
2569
- declare const IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM = "is_config_check";
2570
- /** The value of "data-role" in the component start `<script>` tag */
2571
- declare const IN_CONTEXT_EDITOR_COMPONENT_START_ROLE = "uniform-component-start";
2572
- /** The value of "data-role" in the component end `<script>` tag */
2573
- declare const IN_CONTEXT_EDITOR_COMPONENT_END_ROLE = "uniform-component-end";
2574
- /** The ID of the Contextual Editing script that gets embedded in frontend apps */
2575
- declare const IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID = "uniform-canvas-preview-script";
2576
- /**
2577
- * The name of the attribute added to the elements rendered by Uniform.
2578
- * Use to allow interacting with them by default in the preview panel
2579
- */
2580
- declare const IS_RENDERED_BY_UNIFORM_ATTRIBUTE = "data-is-rendered-by-uniform";
2581
- /** The ID we give to placeholder components */
2582
- declare const PLACEHOLDER_ID = "placeholder";
2583
- /** Contextual editing empty composition, used as a placeholder while waiting for the composition to be send by the editor. */
2584
- declare const EMPTY_COMPOSITION: {
2585
- _id: string;
2586
- _name: string;
2587
- type: string;
2588
- };
2589
- /** Minimal value for Edgehancers Cache TTL (in seconds) */
2590
- declare const EDGE_MIN_CACHE_TTL = 10;
2591
- /** Maximal value for Edgehancers Cache TTL (in seconds) */
2592
- declare const EDGE_MAX_CACHE_TTL: number;
2593
- /** Default value for Edgehancers Cache TTL (in seconds) */
2594
- declare const EDGE_DEFAULT_CACHE_TTL = 30;
2595
- /** A value that indicates that Edgehancers caching is disabled */
2596
- declare const EDGE_CACHE_DISABLED = -1;
2597
- /** This is the type value for the asset parameter or field */
2598
- declare const ASSET_PARAMETER_TYPE = "asset";
2599
- /** The _source for any assets coming from the Uniform Asset Library */
2600
- declare const ASSETS_SOURCE_UNIFORM = "uniform-assets";
2601
- /** The _source for any assets which have manually set fields */
2602
- declare const ASSETS_SOURCE_CUSTOM_URL = "custom-url";
2482
+ type Category = SharedComponents$3['Category'];
2603
2483
 
2604
2484
  /**
2605
2485
  * This file was auto-generated by openapi-typescript.
2606
2486
  * Do not make direct changes to the file.
2607
2487
  */
2608
2488
  interface paths$f {
2609
- "/api/v1/categories": {
2489
+ "/api/v1/canvas-definitions": {
2610
2490
  get: {
2611
2491
  parameters: {
2612
2492
  query: {
2493
+ /** The project ID to get component definitions for. */
2613
2494
  projectId: string;
2495
+ /** Limit list to one result by ID (response remains an array). */
2496
+ componentId?: string;
2497
+ /** Number of records to skip */
2498
+ offset?: number;
2499
+ /** Max number of records to return */
2500
+ limit?: number;
2501
+ /** Whether to fetch system meta-component definitions (personalize, test, etc) */
2502
+ includeSystem?: boolean;
2503
+ /** Filtration by category ID */
2504
+ categories?: string[];
2614
2505
  };
2615
2506
  };
2616
2507
  responses: {
@@ -2618,7 +2509,8 @@ interface paths$f {
2618
2509
  200: {
2619
2510
  content: {
2620
2511
  "application/json": {
2621
- categories: external$g["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["Category"][];
2512
+ /** @description Component definitions that match the query */
2513
+ componentDefinitions: external$g["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"][];
2622
2514
  };
2623
2515
  };
2624
2516
  };
@@ -2629,6 +2521,7 @@ interface paths$f {
2629
2521
  500: external$g["swagger.yml"]["components"]["responses"]["InternalServerError"];
2630
2522
  };
2631
2523
  };
2524
+ /** Upserts a component definition */
2632
2525
  put: {
2633
2526
  responses: {
2634
2527
  /** OK */
@@ -2642,13 +2535,17 @@ interface paths$f {
2642
2535
  requestBody: {
2643
2536
  content: {
2644
2537
  "application/json": {
2645
- /** Format: uuid */
2538
+ /**
2539
+ * Format: uuid
2540
+ * @description The project ID to upsert the component definition to
2541
+ */
2646
2542
  projectId: string;
2647
- categories: external$g["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["Category"][];
2543
+ componentDefinition: external$g["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"];
2648
2544
  };
2649
2545
  };
2650
2546
  };
2651
2547
  };
2548
+ /** Deletes a component definition */
2652
2549
  delete: {
2653
2550
  responses: {
2654
2551
  /** OK */
@@ -2662,14 +2559,24 @@ interface paths$f {
2662
2559
  requestBody: {
2663
2560
  content: {
2664
2561
  "application/json": {
2665
- /** Format: uuid */
2666
- categoryId: string;
2667
- /** Format: uuid */
2562
+ /** @description The public ID of the component definition to delete */
2563
+ componentId: string;
2564
+ /**
2565
+ * Format: uuid
2566
+ * @description The ID of the project the composition to delete belongs to
2567
+ */
2668
2568
  projectId: string;
2669
2569
  };
2670
2570
  };
2671
2571
  };
2672
2572
  };
2573
+ /** Handles preflight requests. This endpoint allows CORS. */
2574
+ options: {
2575
+ responses: {
2576
+ /** OK */
2577
+ 204: never;
2578
+ };
2579
+ };
2673
2580
  };
2674
2581
  }
2675
2582
  interface external$g {
@@ -3870,53 +3777,146 @@ interface external$g {
3870
3777
  }
3871
3778
 
3872
3779
  type SharedComponents$2 = components$7['schemas'];
3873
- type Api$1 = paths$f['/api/v1/categories'];
3874
- /** Shape of the GET response from /api/v1/category */
3875
- type CategoriesGetResponse = Api$1['get']['responses']['200']['content']['application/json'];
3876
- /** Shape of the PUT request body for /api/v1/category */
3877
- type CategoriesPutParameters = Api$1['put']['requestBody']['content']['application/json'];
3878
- /** Shape of the DELETE request body for /api/v1/category */
3879
- type CategoriesDeleteParameters = Api$1['delete']['requestBody']['content']['application/json'];
3880
- /** Query parameter options for GET /api/v1/category */
3881
- type CategoriesGetParameters = Api$1['get']['parameters']['query'];
3780
+ type Api$1 = paths$f['/api/v1/canvas-definitions'];
3781
+ /** Shape of the GET response from /api/v1/canvas-definitions */
3782
+ type ComponentDefinitionGetResponse = Api$1['get']['responses']['200']['content']['application/json'];
3783
+ /** Shape of the PUT request body for /api/v1/canvas-definitions */
3784
+ type ComponentDefinitionPutParameters = Api$1['put']['requestBody']['content']['application/json'];
3785
+ /** Shape of the DELETE request body for /api/v1/canvas-definitions */
3786
+ type ComponentDefinitionDeleteParameters = Api$1['delete']['requestBody']['content']['application/json'];
3787
+ /** Query parameter options for GET /api/v1/canvas-definitions */
3788
+ type ComponentDefinitionGetParameters = Api$1['get']['parameters']['query'];
3789
+ /** The definition of a component parameter */
3790
+ type ComponentDefinitionParameter<TConfig = unknown> = Omit<components$7['schemas']['ComponentDefinitionParameter'], 'typeConfig'> & {
3791
+ typeConfig?: TConfig;
3792
+ };
3793
+ /** The definition of a component visual variant */
3794
+ type ComponentDefinitionVariant = SharedComponents$2['ComponentDefinitionVariant'];
3795
+ /** The definition of a composition's slug settings */
3796
+ type ComponentDefinitionSlugSettings = SharedComponents$2['ComponentDefinitionSlugSettings'];
3797
+ /** The definition of a named component slot that can contain other components */
3798
+ type ComponentDefinitionSlot = SharedComponents$2['ComponentDefinitionSlot'];
3799
+ /** Permission set for a component defintion */
3800
+ type ComponentDefinitionPermission = SharedComponents$2['ComponentDefinitionPermission'];
3882
3801
  /** Defines a component type that can live on a Composition */
3883
- type Category = SharedComponents$2['Category'];
3802
+ type ComponentDefinition = SharedComponents$2['ComponentDefinition'];
3884
3803
 
3804
+ /** Public ID of Canvas personalization component type */
3805
+ declare const CANVAS_PERSONALIZE_TYPE = "$personalization";
3806
+ /** Public ID of Canvas A/B test component type */
3807
+ declare const CANVAS_TEST_TYPE = "$test";
3808
+ /** Public ID of Canvas localization component type */
3809
+ declare const CANVAS_LOCALIZATION_TYPE = "$localization";
3810
+ /** Public ID of Canvas slot section component type */
3811
+ declare const CANVAS_SLOT_SECTION_TYPE = "$slotSection";
3812
+ /** Public ID of the intent tag parameter on the Canvas personalization component type */
3813
+ declare const CANVAS_INTENT_TAG_PARAM = "intentTag";
3814
+ /** Public ID of the locale parameter on Canvas components */
3815
+ declare const CANVAS_LOCALE_TAG_PARAM = "locale";
3816
+ /** Parameter type for a block parameter */
3817
+ declare const CANVAS_BLOCK_PARAM_TYPE = "$block";
3818
+ /** Name of the slot on CANVAS_PERSONALIZE_TYPE */
3819
+ declare const CANVAS_PERSONALIZE_SLOT = "pz";
3820
+ /** Name of the slot on CANVAS_TEST_TYPE */
3821
+ declare const CANVAS_TEST_SLOT = "test";
3822
+ /** Name of the slot on CANVAS_TEST_TYPE */
3823
+ declare const CANVAS_LOCALIZATION_SLOT = "localized";
3824
+ /** Name of the slot on CANVAS_SLOT_SECTION_TYPE */
3825
+ declare const CANVAS_SLOT_SECTION_SLOT = "$slotSectionItems";
3826
+ /** Constant for a draft composition state. Subject to change. */
3827
+ declare const CANVAS_DRAFT_STATE = 0;
3828
+ /** Constant for a published composition state. Subject to change. */
3829
+ declare const CANVAS_PUBLISHED_STATE = 64;
3830
+ /** Constant for editor composition state. */
3831
+ declare const CANVAS_EDITOR_STATE = 63;
3832
+ /** Public ID of the Uniform Context personalization parameter on Canvas components */
3833
+ declare const CANVAS_PERSONALIZATION_PARAM = "$pzCrit";
3834
+ /** Public ID of the Uniform Context test variant parameter on Canvas components */
3835
+ declare const CANVAS_TEST_VARIANT_PARAM = "$tstVrnt";
3836
+ /** Public ID of the Uniform Context enrichment tag parameter on Canvas components */
3837
+ declare const CANVAS_ENRICHMENT_TAG_PARAM = "$enr";
3885
3838
  /**
3886
- * This file was auto-generated by openapi-typescript.
3887
- * Do not make direct changes to the file.
3839
+ * The name of the query string used to set a secret to protect for the preview mode.
3840
+ * This is not configurable at the moment.
3888
3841
  */
3889
- interface paths$e {
3890
- "/api/v1/content-types": {
3891
- get: {
3892
- parameters: {
3893
- query: {
3894
- /** The project ID to get content type for. */
3895
- projectId: string;
3896
- /** Number of records to skip */
3897
- offset?: number;
3898
- /** Max number of records to return */
3899
- limit?: number;
3900
- /** Limit the types of content type to return. If not specified, both block types and content types are returned. */
3901
- type?: "block" | "contentType";
3902
- };
3903
- };
3904
- responses: {
3905
- /** OK */
3906
- 200: {
3907
- content: {
3908
- "application/json": {
3909
- /** @description Content types that match the query */
3910
- contentTypes: external$f["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ContentType"][];
3911
- };
3912
- };
3913
- };
3914
- 400: external$f["swagger.yml"]["components"]["responses"]["BadRequestError"];
3915
- 401: external$f["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
3916
- 403: external$f["swagger.yml"]["components"]["responses"]["ForbiddenError"];
3917
- 429: external$f["swagger.yml"]["components"]["responses"]["RateLimitError"];
3918
- 500: external$f["swagger.yml"]["components"]["responses"]["InternalServerError"];
3919
- };
3842
+ declare const SECRET_QUERY_STRING_PARAM = "secret";
3843
+ /** The name of the query string used to detect if we are in contextual editing mode */
3844
+ declare const IN_CONTEXT_EDITOR_QUERY_STRING_PARAM = "is_incontext_editing_mode";
3845
+ /** The name of the query string used to indicate that we want to use the playground for preview */
3846
+ declare const IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM = "is_incontext_editing_playground";
3847
+ /** The name of the query string used to detect if we are in contextual editing mode */
3848
+ declare const IN_CONTEXT_EDITOR_FORCED_SETTINGS_QUERY_STRING_PARAM = "is_incontext_editing_forced_settings";
3849
+ /** The name of the query string used to get the config from the preview url */
3850
+ declare const IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM = "is_config_check";
3851
+ /** The value of "data-role" in the component start `<script>` tag */
3852
+ declare const IN_CONTEXT_EDITOR_COMPONENT_START_ROLE = "uniform-component-start";
3853
+ /** The value of "data-role" in the component end `<script>` tag */
3854
+ declare const IN_CONTEXT_EDITOR_COMPONENT_END_ROLE = "uniform-component-end";
3855
+ /** The ID of the Contextual Editing script that gets embedded in frontend apps */
3856
+ declare const IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID = "uniform-canvas-preview-script";
3857
+ /**
3858
+ * The name of the attribute added to the elements rendered by Uniform.
3859
+ * Use to allow interacting with them by default in the preview panel
3860
+ */
3861
+ declare const IS_RENDERED_BY_UNIFORM_ATTRIBUTE = "data-is-rendered-by-uniform";
3862
+ /** The ID we give to placeholder components */
3863
+ declare const PLACEHOLDER_ID = "placeholder";
3864
+ /** Contextual editing empty composition, used as a placeholder while waiting for the composition to be send by the editor. */
3865
+ declare const EMPTY_COMPOSITION: {
3866
+ _id: string;
3867
+ _name: string;
3868
+ type: string;
3869
+ };
3870
+ /** Minimal value for Edgehancers Cache TTL (in seconds) */
3871
+ declare const EDGE_MIN_CACHE_TTL = 10;
3872
+ /** Maximal value for Edgehancers Cache TTL (in seconds) */
3873
+ declare const EDGE_MAX_CACHE_TTL: number;
3874
+ /** Default value for Edgehancers Cache TTL (in seconds) */
3875
+ declare const EDGE_DEFAULT_CACHE_TTL = 30;
3876
+ /** A value that indicates that Edgehancers caching is disabled */
3877
+ declare const EDGE_CACHE_DISABLED = -1;
3878
+ /** This is the type value for the asset parameter or field */
3879
+ declare const ASSET_PARAMETER_TYPE = "asset";
3880
+ /** The _source for any assets coming from the Uniform Asset Library */
3881
+ declare const ASSETS_SOURCE_UNIFORM = "uniform-assets";
3882
+ /** The _source for any assets which have manually set fields */
3883
+ declare const ASSETS_SOURCE_CUSTOM_URL = "custom-url";
3884
+
3885
+ /**
3886
+ * This file was auto-generated by openapi-typescript.
3887
+ * Do not make direct changes to the file.
3888
+ */
3889
+ interface paths$e {
3890
+ "/api/v1/content-types": {
3891
+ get: {
3892
+ parameters: {
3893
+ query: {
3894
+ /** The project ID to get content type for. */
3895
+ projectId: string;
3896
+ /** Number of records to skip */
3897
+ offset?: number;
3898
+ /** Max number of records to return */
3899
+ limit?: number;
3900
+ /** Limit the types of content type to return. If not specified, both block types and content types are returned. */
3901
+ type?: "block" | "contentType";
3902
+ };
3903
+ };
3904
+ responses: {
3905
+ /** OK */
3906
+ 200: {
3907
+ content: {
3908
+ "application/json": {
3909
+ /** @description Content types that match the query */
3910
+ contentTypes: external$f["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ContentType"][];
3911
+ };
3912
+ };
3913
+ };
3914
+ 400: external$f["swagger.yml"]["components"]["responses"]["BadRequestError"];
3915
+ 401: external$f["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
3916
+ 403: external$f["swagger.yml"]["components"]["responses"]["ForbiddenError"];
3917
+ 429: external$f["swagger.yml"]["components"]["responses"]["RateLimitError"];
3918
+ 500: external$f["swagger.yml"]["components"]["responses"]["InternalServerError"];
3919
+ };
3920
3920
  };
3921
3921
  /** Upserts a content type */
3922
3922
  put: {
@@ -21672,26 +21672,158 @@ type RouteGetResponseEdgehancedNotFound = RouteGetResponseNotFound & {
21672
21672
  compositionApiResponse?: Pick<CompositionResolvedGetResponse, 'errors' | 'warnings' | 'infos' | 'diagnostics' | 'wholeResponseCacheDiagnostics'>;
21673
21673
  };
21674
21674
 
21675
- type CanvasClientOptions = ClientOptions & {
21676
- edgeApiHost?: string;
21677
- disableSWR?: boolean;
21675
+ type PreviewPanelSettings = {
21676
+ /**
21677
+ * @deprecated To be deleted with the cleanup of the `canvas-preview-mode` feature flag.
21678
+ * use `isVisualEditingDisabled` instead.
21679
+ */
21680
+ isInteractive?: boolean;
21681
+ isVisualEditingDisabled?: boolean;
21682
+ };
21683
+ type ContextualEditingComponentReference = {
21684
+ id: string;
21685
+ icon?: string;
21686
+ type?: string;
21687
+ title?: string;
21688
+ name?: string;
21689
+ /**
21690
+ * Whether this component is localized to be shown at all only in a specific locale
21691
+ * (e.g. inside a localization container)
21692
+ */
21693
+ shownInLocale?: Locale;
21694
+ parameters?: Record<string, {
21695
+ id: string;
21696
+ type: string;
21697
+ name?: string;
21698
+ isReadOnly?: boolean;
21699
+ localizable?: boolean;
21700
+ targetLocale?: Locale;
21701
+ }>;
21702
+ /** The ID of the pattern if the component is actually a pattern node. */
21703
+ patternId?: string;
21704
+ parentId?: string;
21705
+ parentType?: string;
21706
+ parentSlot?: {
21707
+ id?: string;
21708
+ componentIndex?: number;
21709
+ totalComponents?: number;
21710
+ isReadOnly?: boolean;
21711
+ };
21712
+ slotsById?: Record<string, {
21713
+ id: string;
21714
+ name: string;
21715
+ children: string[];
21716
+ }>;
21717
+ canBePersonalized?: boolean;
21718
+ canBeTested?: boolean;
21719
+ canBeLocalized?: boolean;
21720
+ isPersonalized?: boolean;
21721
+ isTested?: boolean;
21722
+ isLocalized?: boolean;
21723
+ isReadOnly?: boolean | undefined;
21724
+ };
21725
+
21726
+ type EnhancerContext = {
21727
+ preview?: boolean;
21728
+ };
21729
+ /** Options passed to a ComponentEnhancer function */
21730
+ type ComponentEnhancerOptions<TContext extends EnhancerContext = EnhancerContext> = {
21731
+ component: Readonly<ComponentInstance>;
21732
+ context: TContext;
21733
+ };
21734
+ /**
21735
+ * A function which is called for each matching component in a composition, which can manipulate the value of a specific key in the component's `data` property.
21736
+ * Used to enhance layout data with information from other platforms, such as private APIs, where the value is not tied to a parameter
21737
+ * and is intrinsic to the component itself.
21738
+ *
21739
+ * Note: the configuration of enhancers namespaces component enhancers into a named property on the data object to avoid collisions,
21740
+ * thus an enhancer need not worry about merging values with other enhancers, nor which key it has been registered under.
21741
+ *
21742
+ * Return values:
21743
+ * TValue - sets the configured key in the component's data value to this value
21744
+ * undefined - do not set the component's data key
21745
+ */
21746
+ type ComponentEnhancerFunction<TValue = unknown, TContext extends EnhancerContext = EnhancerContext> = (options: ComponentEnhancerOptions<TContext>) => Promise<TValue | undefined> | TValue | undefined;
21747
+ /**
21748
+ * Defines logic to add arbitrary async data to a component's `data` property.
21749
+ * Used to enhance layout data with information from other platforms, such as private APIs,
21750
+ * where the value is not tied to a parameter and is intrinsic to the component itself.
21751
+ */
21752
+ type ComponentEnhancer<TValue = unknown, TContext extends EnhancerContext = EnhancerContext> = {
21753
+ /** Function called to enhance a single component in a composition. */
21754
+ enhanceOne: ComponentEnhancerFunction<TValue, TContext>;
21755
+ /**
21756
+ * The limit policy that defines how much concurrency and retry is allowed for this enhancer.
21757
+ * If the enhancer does not define completeAll(), this limit policy is applied to enhanceOne() calls.
21758
+ * If the enhancer does define completeAll(), this limit policy is applied to the completeAll() calls.
21759
+ * If the limit policy is undefined, unbounded concurrency is allowed and no error retrying will occur.
21760
+ */
21761
+ limitPolicy?: LimitPolicy;
21762
+ completeAll?: () => Promise<void>;
21763
+ };
21764
+ /** Options passed to a ComponentParameterEnhancer function */
21765
+ type ComponentParameterEnhancerOptions<TRawValue = unknown, TContext extends EnhancerContext = EnhancerContext> = {
21766
+ parameter: Readonly<ComponentParameter<TRawValue>>;
21767
+ parameterName: string;
21768
+ component: Readonly<ComponentInstance>;
21769
+ context: TContext;
21770
+ };
21771
+ /**
21772
+ * A function which is called for each component parameter in a component tree, which can manipulate the value of the parameter.
21773
+ * Used to enhance layout data with information from other platforms, such as CMS, commerce, indexing, etc.
21774
+ *
21775
+ * Return values:
21776
+ * TValue - replaces the original parameter value with this value
21777
+ * undefined - do not change the original parameter value
21778
+ * null - sets the parameter value to null, replacing any existing value (i.e. if its value could not be resolved in an external system)
21779
+ */
21780
+ type ComponentParameterEnhancerFunction<TRawValue = unknown, TOutputValue = unknown, TContext extends EnhancerContext = EnhancerContext> = (options: ComponentParameterEnhancerOptions<TRawValue, TContext>) => Promise<TOutputValue | undefined | null> | TOutputValue | undefined | null;
21781
+ /**
21782
+ * Defines logic to replace the value of a component parameter with arbitrary async data.
21783
+ * Used to enhance layout data with information from other platforms, such as CMS, commerce, indexing, etc,
21784
+ * where that data is directly expandable from a parameter value.
21785
+ */
21786
+ type ComponentParameterEnhancer<TRawValue = unknown, TOutputValue = unknown, TContext extends EnhancerContext = EnhancerContext> = {
21787
+ /** Function called to enhance a single parameter to be enhanced. */
21788
+ enhanceOne: ComponentParameterEnhancerFunction<TRawValue, TOutputValue, TContext>;
21789
+ /**
21790
+ * The limit policy that defines how much concurrency and retry is allowed for this enhancer.
21791
+ * If the enhancer does not define completeAll(), this limit policy is applied to enhanceOne() calls.
21792
+ * If the enhancer does define completeAll(), this limit policy is applied to the completeAll() calls.
21793
+ * If the limit policy is undefined, unbounded concurrency is allowed and no error retrying will occur.
21794
+ */
21795
+ limitPolicy?: LimitPolicy;
21796
+ /**
21797
+ * Function called, if defined, after all enhanceOne() calls have completed for the composition being enhanced.
21798
+ * Used to enable batching.
21799
+ * Return the number of batched items processed (or zero if that does not apply).
21800
+ */
21801
+ completeAll?: () => Promise<number>;
21678
21802
  };
21679
- type CompositionFilters = Partial<Record<'entityId' | 'type' | 'uiStatus', {
21803
+
21804
+ type StringAlwaysPresentExactField = 'entityId' | 'type' | 'uiStatus';
21805
+ type DateAlwaysPresentField = 'created' | 'modified';
21806
+ type StringOptionalField = 'locale' | 'patternId' | 'workflowId' | 'workflowStageId';
21807
+ type StringAlwaysPresentField = 'name' | 'slug' | 'creator' | 'author';
21808
+ type ProjectMapField = 'projectMapId' | 'projectMapNodeId';
21809
+ type InNinFilter<T> = T & T[];
21810
+ type DefFilter = boolean | 'true' | 'false';
21811
+ type Filters<CustomFieldPrefix extends string = 'fields'> = Partial<Record<StringAlwaysPresentExactField, {
21680
21812
  eq: string;
21681
21813
  } | {
21682
21814
  neq: string;
21683
21815
  } | {
21684
- in: string[];
21816
+ in: InNinFilter<string>;
21685
21817
  } | {
21686
- nin: string[];
21687
- }> | Record<`${'entityId' | 'type' | 'uiStatus'}[${'eq' | 'neq'}]`, string> | Record<`${'entityId' | 'type' | 'uiStatus'}[${'in' | 'nin'}]`, string[]> | Record<'created' | 'modified', {
21818
+ nin: InNinFilter<string>;
21819
+ }> | Record<`${StringAlwaysPresentExactField}[${'eq' | 'neq'}]`, string> | Record<`${StringAlwaysPresentExactField}[${'in' | 'nin'}]`, InNinFilter<string>> | Record<DateAlwaysPresentField, {
21688
21820
  eq: string;
21689
21821
  } | {
21690
21822
  neq: string;
21691
21823
  } | {
21692
- in: string[];
21824
+ in: InNinFilter<string>;
21693
21825
  } | {
21694
- nin: string[];
21826
+ nin: InNinFilter<string>;
21695
21827
  } | {
21696
21828
  gt: string;
21697
21829
  } | {
@@ -21700,31 +21832,17 @@ type CompositionFilters = Partial<Record<'entityId' | 'type' | 'uiStatus', {
21700
21832
  lt: string;
21701
21833
  } | {
21702
21834
  lte: string;
21703
- }> | Record<`${'created' | 'modified'}[${'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte'}]`, string> | Record<`${'created' | 'modified'}[${'in' | 'nin'}]`, string[]> | Record<'locale' | 'releaseId' | 'patternId' | 'projectMapId' | 'projectMapNodeId' | 'workflowId' | 'workflowStageId', {
21704
- eq: string;
21705
- } | {
21706
- neq: string;
21707
- } | {
21708
- in: string[];
21709
- } | {
21710
- nin: string[];
21711
- } | {
21712
- def: boolean | 'true' | 'false';
21713
- }> | Record<`${'locale' | 'releaseId' | 'patternId' | 'projectMapId' | 'projectMapNodeId' | 'workflowId' | 'workflowStageId'}[${'eq' | 'neq'}]`, string> | Record<`${'locale' | 'releaseId' | 'patternId' | 'projectMapId' | 'projectMapNodeId' | 'workflowId' | 'workflowStageId'}[${'in' | 'nin'}]`, string[]> | Record<`${'locale' | 'releaseId' | 'patternId' | 'projectMapId' | 'projectMapNodeId' | 'workflowId' | 'workflowStageId'}[def]`, boolean | 'true' | 'false'> | Record<'name' | 'slug', {
21714
- match: string;
21715
- } | {
21716
- starts: string;
21717
- } | {
21835
+ }> | Record<`${DateAlwaysPresentField}[${'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte'}]`, string> | Record<`${DateAlwaysPresentField}[${'in' | 'nin'}]`, InNinFilter<string>> | Record<StringOptionalField, {
21718
21836
  eq: string;
21719
21837
  } | {
21720
21838
  neq: string;
21721
21839
  } | {
21722
- in: string[];
21840
+ in: InNinFilter<string>;
21723
21841
  } | {
21724
- nin: string[];
21842
+ nin: InNinFilter<string>;
21725
21843
  } | {
21726
- def: boolean | 'true' | 'false';
21727
- }> | Record<`${'name' | 'slug'}[${'match' | 'starts' | 'eq' | 'neq'}]`, string> | Record<`${'name' | 'slug'}[${'in' | 'nin'}]`, string[]> | Record<`${'name' | 'slug'}[def]`, boolean | 'true' | 'false'> | Record<'creator' | 'author', {
21844
+ def: DefFilter;
21845
+ }> | Record<`${StringOptionalField}[${'eq' | 'neq'}]`, string> | Record<`${StringOptionalField}[${'in' | 'nin'}]`, InNinFilter<string>> | Record<`${StringOptionalField}[def]`, DefFilter> | Record<StringAlwaysPresentField, {
21728
21846
  match: string;
21729
21847
  } | {
21730
21848
  starts: string;
@@ -21733,14 +21851,10 @@ type CompositionFilters = Partial<Record<'entityId' | 'type' | 'uiStatus', {
21733
21851
  } | {
21734
21852
  neq: string;
21735
21853
  } | {
21736
- in: string[];
21737
- } | {
21738
- nin: string[];
21739
- }> | Record<`${'creator' | 'author'}[${'match' | 'starts' | 'eq' | 'neq'}]`, string> | Record<`${'creator' | 'author'}[${'in' | 'nin'}]`, string[]> | Record<'isPattern', {
21740
- eq: boolean | 'true' | 'false';
21854
+ in: InNinFilter<string>;
21741
21855
  } | {
21742
- neq: boolean | 'true' | 'false';
21743
- }> | Record<`isPattern[${'eq' | 'neq'}]`, boolean | 'true' | 'false'> | Record<`parameters.${string}`, {
21856
+ nin: InNinFilter<string>;
21857
+ }> | Record<`${StringAlwaysPresentField}[${'match' | 'starts' | 'eq' | 'neq'}]`, string> | Record<`${StringAlwaysPresentField}[${'in' | 'nin'}]`, InNinFilter<string>> | Record<`${CustomFieldPrefix}.${string}`, {
21744
21858
  match: string;
21745
21859
  } | {
21746
21860
  starts: string;
@@ -21749,9 +21863,9 @@ type CompositionFilters = Partial<Record<'entityId' | 'type' | 'uiStatus', {
21749
21863
  } | {
21750
21864
  neq: string | number | boolean;
21751
21865
  } | {
21752
- in: (string | number | boolean)[];
21866
+ in: InNinFilter<string | number | boolean>;
21753
21867
  } | {
21754
- nin: (string | number | boolean)[];
21868
+ nin: InNinFilter<string | number | boolean>;
21755
21869
  } | {
21756
21870
  gt: string | number;
21757
21871
  } | {
@@ -21761,345 +21875,20 @@ type CompositionFilters = Partial<Record<'entityId' | 'type' | 'uiStatus', {
21761
21875
  } | {
21762
21876
  lte: string | number;
21763
21877
  } | {
21764
- def: boolean | 'true' | 'false';
21765
- }> | Record<`parameters.${string}[${'match' | 'starts'}]`, string> | Record<`parameters.${string}[${'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte'}]`, string | number> | Record<`parameters.${string}[${'in' | 'nin'}]`, (string | number)[]> | Record<`parameters.${string}[def]`, boolean | 'true' | 'false'>>;
21766
- declare class CanvasClient extends ApiClient<CanvasClientOptions> {
21767
- private edgeApiHost;
21768
- private edgeApiRequestInit?;
21769
- constructor(options: CanvasClientOptions);
21770
- /** Fetches lists of Canvas compositions, optionally by type */
21771
- getCompositionList(params?: Omit<CompositionGetParameters, 'projectId' | 'componentId' | 'compositionId' | 'slug'> & {
21772
- filters?: CompositionFilters;
21773
- } & ({
21774
- resolveData: true;
21775
- diagnostics?: boolean;
21776
- } | {
21777
- resolveData?: false;
21778
- })): Promise<CompositionGetListResponse | CompositionResolvedListResponse>;
21779
- /** Fetches one composition by its project map node path */
21780
- getCompositionByNodePath(options: CompositionGetByNodePathParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
21781
- getCompositionByNodePath(options: CompositionGetByNodePathParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
21782
- getCompositionByNodePath<T extends CompositionGetResponse = CompositionGetValidResponses>(options: CompositionGetByNodePathParameters & DataResolutionOption & DataResolutionParameters): Promise<T>;
21783
- /** Fetches one composition by its project map node ID */
21784
- getCompositionByNodeId(options: CompositionGetByNodeIdParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
21785
- getCompositionByNodeId(options: CompositionGetByNodeIdParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
21786
- getCompositionByNodeId<T extends CompositionGetResponse = CompositionGetValidResponses>(options: CompositionGetByNodeIdParameters & DataResolutionOption & DataResolutionParameters): Promise<T>;
21787
- /** Fetches one composition by its slug */
21788
- getCompositionBySlug(options: CompositionGetBySlugParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
21789
- getCompositionBySlug(options: CompositionGetBySlugParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
21790
- getCompositionBySlug<T extends CompositionGetResponse = CompositionGetValidResponses>(options: CompositionGetBySlugParameters & DataResolutionOption & DataResolutionParameters): Promise<T>;
21791
- /** Fetches one composition by its ID */
21792
- getCompositionById(options: CompositionGetByIdParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
21793
- getCompositionById(options: CompositionGetByIdParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
21794
- getCompositionById<T extends CompositionGetResponse = CompositionGetValidResponses>(options: CompositionGetByIdParameters & DataResolutionOption & DataResolutionParameters): Promise<T>;
21795
- /** Fetches a component definition's composition defaults */
21796
- getCompositionDefaults(options: CompositionGetByComponentIdParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
21797
- getCompositionDefaults(options: CompositionGetByComponentIdParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
21798
- getCompositionDefaults<T extends CompositionGetResponse = CompositionGetValidResponses>(options: CompositionGetByComponentIdParameters & DataResolutionOption & DataResolutionParameters): Promise<T>;
21799
- /** Fetches historical versions of a composition or pattern */
21800
- getCompositionHistory(options: ExceptProject<ComponentInstanceHistoryGetParameters>): Promise<{
21801
- cursor?: string | undefined;
21802
- truncated?: boolean | undefined;
21803
- results?: {
21804
- versionId: string;
21805
- timestamp: number;
21806
- authorName: string;
21807
- authorIsApiKey: boolean;
21808
- state: number;
21809
- }[] | undefined;
21810
- }>;
21811
- private getOneComposition;
21812
- /** Updates or creates a Canvas component definition */
21813
- updateComposition(body: Omit<CompositionPutParameters, 'projectId'>): Promise<void>;
21814
- /** Deletes a Canvas component definition */
21815
- removeComposition(body: Omit<CompositionDeleteParameters, 'projectId'>): Promise<void>;
21816
- /** Fetches all Canvas component definitions */
21817
- getComponentDefinitions(options?: Omit<ComponentDefinitionGetParameters, 'projectId'>): Promise<{
21818
- componentDefinitions: {
21819
- id: string;
21820
- name: string;
21821
- icon?: string | undefined;
21822
- titleParameter?: string | null | undefined;
21823
- thumbnailParameter?: string | null | undefined;
21824
- canBeComposition?: boolean | undefined;
21825
- parameters?: {
21826
- id: string;
21827
- name: string;
21828
- helpText?: string | undefined;
21829
- type: string;
21830
- localizable?: boolean | undefined;
21831
- typeConfig?: unknown;
21832
- }[] | undefined;
21833
- categoryId?: string | null | undefined;
21834
- description?: string | undefined;
21835
- previewImageUrl?: string | undefined;
21836
- useTeamPermissions?: boolean | undefined;
21837
- permissions?: {
21838
- roleId: string;
21839
- permission: "read" | "write" | "create" | "delete";
21840
- state: number;
21841
- }[] | undefined;
21842
- slots?: {
21843
- id: string;
21844
- name: string;
21845
- allowedComponents: string[];
21846
- inheritAllowedComponents: boolean;
21847
- allowAllComponents?: boolean | undefined;
21848
- patternsInAllowedComponents?: boolean | undefined;
21849
- minComponents?: number | undefined;
21850
- maxComponents?: number | undefined;
21851
- }[] | undefined;
21852
- slugSettings?: {
21853
- required?: "no" | "yes" | "disabled" | undefined;
21854
- unique?: "no" | "local" | "global" | undefined;
21855
- regularExpression?: string | undefined;
21856
- regularExpressionMessage?: string | undefined;
21857
- } | undefined;
21858
- defaults?: {
21859
- type: string;
21860
- parameters?: {
21861
- [key: string]: {
21862
- value?: unknown;
21863
- type: string;
21864
- connectedData?: {
21865
- pointer: string;
21866
- syntax: "jptr";
21867
- failureAction?: "t" | "p" | "c" | "a" | undefined;
21868
- failureLogLevel?: "e" | "w" | "i" | undefined;
21869
- failureDefault?: string | undefined;
21870
- } | undefined;
21871
- locales?: {
21872
- [key: string]: unknown;
21873
- } | undefined;
21874
- };
21875
- } | undefined;
21876
- variant?: string | undefined;
21877
- slots?: {
21878
- [key: string]: any[];
21879
- } | undefined;
21880
- _id?: string | undefined;
21881
- _pattern?: string | undefined;
21882
- _dataResources?: {
21883
- [key: string]: {
21884
- type: string;
21885
- isPatternParameter?: boolean | undefined;
21886
- ignorePatternParameterDefault?: boolean | undefined;
21887
- optionalPatternParameter?: boolean | undefined;
21888
- variables?: {
21889
- [key: string]: string;
21890
- } | undefined;
21891
- };
21892
- } | undefined;
21893
- _patternDataResources?: {
21894
- [key: string]: {
21895
- type: string;
21896
- isPatternParameter?: boolean | undefined;
21897
- ignorePatternParameterDefault?: boolean | undefined;
21898
- optionalPatternParameter?: boolean | undefined;
21899
- variables?: {
21900
- [key: string]: string;
21901
- } | undefined;
21902
- };
21903
- } | undefined;
21904
- _patternError?: "NOTFOUND" | "CYCLIC" | undefined;
21905
- _overrides?: {
21906
- [key: string]: {
21907
- parameters?: {
21908
- [key: string]: {
21909
- value?: unknown;
21910
- type: string;
21911
- connectedData?: {
21912
- pointer: string;
21913
- syntax: "jptr";
21914
- failureAction?: "t" | "p" | "c" | "a" | undefined;
21915
- failureLogLevel?: "e" | "w" | "i" | undefined;
21916
- failureDefault?: string | undefined;
21917
- } | undefined;
21918
- locales?: {
21919
- [key: string]: unknown;
21920
- } | undefined;
21921
- };
21922
- } | undefined;
21923
- slots?: {
21924
- [key: string]: any[];
21925
- } | undefined;
21926
- variant?: string | undefined;
21927
- };
21928
- } | undefined;
21929
- _overridability?: {
21930
- parameters?: {
21931
- [key: string]: "no" | "yes";
21932
- } | undefined;
21933
- variants?: boolean | undefined;
21934
- hideLockedParameters?: boolean | undefined;
21935
- } | undefined;
21936
- _locales?: string[] | undefined;
21937
- } | null | undefined;
21938
- variants?: {
21939
- id: string;
21940
- name: string;
21941
- }[] | undefined;
21942
- created?: string | undefined;
21943
- updated?: string | undefined;
21944
- workflowId?: string | undefined;
21945
- }[];
21946
- }>;
21947
- /** Updates or creates a Canvas component definition */
21948
- updateComponentDefinition(body: Omit<ComponentDefinitionPutParameters, 'projectId'>): Promise<void>;
21949
- /** Deletes a Canvas component definition */
21950
- removeComponentDefinition(body: Omit<ComponentDefinitionDeleteParameters, 'projectId'>): Promise<void>;
21951
- }
21952
- declare class UncachedCanvasClient extends CanvasClient {
21953
- constructor(options: Omit<CanvasClientOptions, 'bypassCache'>);
21954
- }
21955
-
21956
- declare class CategoryClient extends ApiClient {
21957
- constructor(options: ClientOptions);
21958
- /** Fetches all categories created in given project */
21959
- getCategories(options?: Omit<CategoriesGetParameters, 'projectId'>): Promise<{
21960
- categories: {
21961
- id: string;
21962
- name: string;
21963
- order?: number | undefined;
21964
- }[];
21965
- }>;
21966
- /** Updates or creates a category, also used to re-order them */
21967
- upsertCategories(categories: CategoriesPutParameters['categories']): Promise<unknown>;
21968
- /** Deletes a category */
21969
- removeCategory(options: Omit<CategoriesDeleteParameters, 'projectId'>): Promise<unknown>;
21970
- }
21971
- declare class UncachedCategoryClient extends CategoryClient {
21972
- constructor(options: Omit<ClientOptions, 'bypassCache'>);
21973
- }
21974
-
21975
- type PreviewPanelSettings = {
21976
- /**
21977
- * @deprecated To be deleted with the cleanup of the `canvas-preview-mode` feature flag.
21978
- * use `isVisualEditingDisabled` instead.
21979
- */
21980
- isInteractive?: boolean;
21981
- isVisualEditingDisabled?: boolean;
21982
- };
21983
- type ContextualEditingComponentReference = {
21984
- id: string;
21985
- icon?: string;
21986
- type?: string;
21987
- title?: string;
21988
- name?: string;
21989
- /**
21990
- * Whether this component is localized to be shown at all only in a specific locale
21991
- * (e.g. inside a localization container)
21992
- */
21993
- shownInLocale?: Locale;
21994
- parameters?: Record<string, {
21995
- id: string;
21996
- type: string;
21997
- name?: string;
21998
- isReadOnly?: boolean;
21999
- localizable?: boolean;
22000
- targetLocale?: Locale;
22001
- }>;
22002
- /** The ID of the pattern if the component is actually a pattern node. */
22003
- patternId?: string;
22004
- parentId?: string;
22005
- parentType?: string;
22006
- parentSlot?: {
22007
- id?: string;
22008
- componentIndex?: number;
22009
- totalComponents?: number;
22010
- isReadOnly?: boolean;
22011
- };
22012
- slotsById?: Record<string, {
22013
- id: string;
22014
- name: string;
22015
- children: string[];
22016
- }>;
22017
- canBePersonalized?: boolean;
22018
- canBeTested?: boolean;
22019
- canBeLocalized?: boolean;
22020
- isPersonalized?: boolean;
22021
- isTested?: boolean;
22022
- isLocalized?: boolean;
22023
- isReadOnly?: boolean | undefined;
22024
- };
22025
-
22026
- type EnhancerContext = {
22027
- preview?: boolean;
22028
- };
22029
- /** Options passed to a ComponentEnhancer function */
22030
- type ComponentEnhancerOptions<TContext extends EnhancerContext = EnhancerContext> = {
22031
- component: Readonly<ComponentInstance>;
22032
- context: TContext;
22033
- };
22034
- /**
22035
- * A function which is called for each matching component in a composition, which can manipulate the value of a specific key in the component's `data` property.
22036
- * Used to enhance layout data with information from other platforms, such as private APIs, where the value is not tied to a parameter
22037
- * and is intrinsic to the component itself.
22038
- *
22039
- * Note: the configuration of enhancers namespaces component enhancers into a named property on the data object to avoid collisions,
22040
- * thus an enhancer need not worry about merging values with other enhancers, nor which key it has been registered under.
22041
- *
22042
- * Return values:
22043
- * TValue - sets the configured key in the component's data value to this value
22044
- * undefined - do not set the component's data key
22045
- */
22046
- type ComponentEnhancerFunction<TValue = unknown, TContext extends EnhancerContext = EnhancerContext> = (options: ComponentEnhancerOptions<TContext>) => Promise<TValue | undefined> | TValue | undefined;
22047
- /**
22048
- * Defines logic to add arbitrary async data to a component's `data` property.
22049
- * Used to enhance layout data with information from other platforms, such as private APIs,
22050
- * where the value is not tied to a parameter and is intrinsic to the component itself.
22051
- */
22052
- type ComponentEnhancer<TValue = unknown, TContext extends EnhancerContext = EnhancerContext> = {
22053
- /** Function called to enhance a single component in a composition. */
22054
- enhanceOne: ComponentEnhancerFunction<TValue, TContext>;
22055
- /**
22056
- * The limit policy that defines how much concurrency and retry is allowed for this enhancer.
22057
- * If the enhancer does not define completeAll(), this limit policy is applied to enhanceOne() calls.
22058
- * If the enhancer does define completeAll(), this limit policy is applied to the completeAll() calls.
22059
- * If the limit policy is undefined, unbounded concurrency is allowed and no error retrying will occur.
22060
- */
22061
- limitPolicy?: LimitPolicy;
22062
- completeAll?: () => Promise<void>;
22063
- };
22064
- /** Options passed to a ComponentParameterEnhancer function */
22065
- type ComponentParameterEnhancerOptions<TRawValue = unknown, TContext extends EnhancerContext = EnhancerContext> = {
22066
- parameter: Readonly<ComponentParameter<TRawValue>>;
22067
- parameterName: string;
22068
- component: Readonly<ComponentInstance>;
22069
- context: TContext;
22070
- };
22071
- /**
22072
- * A function which is called for each component parameter in a component tree, which can manipulate the value of the parameter.
22073
- * Used to enhance layout data with information from other platforms, such as CMS, commerce, indexing, etc.
22074
- *
22075
- * Return values:
22076
- * TValue - replaces the original parameter value with this value
22077
- * undefined - do not change the original parameter value
22078
- * null - sets the parameter value to null, replacing any existing value (i.e. if its value could not be resolved in an external system)
22079
- */
22080
- type ComponentParameterEnhancerFunction<TRawValue = unknown, TOutputValue = unknown, TContext extends EnhancerContext = EnhancerContext> = (options: ComponentParameterEnhancerOptions<TRawValue, TContext>) => Promise<TOutputValue | undefined | null> | TOutputValue | undefined | null;
22081
- /**
22082
- * Defines logic to replace the value of a component parameter with arbitrary async data.
22083
- * Used to enhance layout data with information from other platforms, such as CMS, commerce, indexing, etc,
22084
- * where that data is directly expandable from a parameter value.
22085
- */
22086
- type ComponentParameterEnhancer<TRawValue = unknown, TOutputValue = unknown, TContext extends EnhancerContext = EnhancerContext> = {
22087
- /** Function called to enhance a single parameter to be enhanced. */
22088
- enhanceOne: ComponentParameterEnhancerFunction<TRawValue, TOutputValue, TContext>;
22089
- /**
22090
- * The limit policy that defines how much concurrency and retry is allowed for this enhancer.
22091
- * If the enhancer does not define completeAll(), this limit policy is applied to enhanceOne() calls.
22092
- * If the enhancer does define completeAll(), this limit policy is applied to the completeAll() calls.
22093
- * If the limit policy is undefined, unbounded concurrency is allowed and no error retrying will occur.
22094
- */
22095
- limitPolicy?: LimitPolicy;
22096
- /**
22097
- * Function called, if defined, after all enhanceOne() calls have completed for the composition being enhanced.
22098
- * Used to enable batching.
22099
- * Return the number of batched items processed (or zero if that does not apply).
22100
- */
22101
- completeAll?: () => Promise<number>;
22102
- };
21878
+ def: DefFilter;
21879
+ }> | Record<`${CustomFieldPrefix}.${string}[${'match' | 'starts'}]`, string> | Record<`${CustomFieldPrefix}.${string}[${'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte'}]`, string | number> | Record<`${CustomFieldPrefix}.${string}[${'in' | 'nin'}]`, InNinFilter<string | number | boolean>> | Record<`${CustomFieldPrefix}.${string}[def]`, DefFilter>>;
21880
+ type EntryFilters = Filters<'fields'>;
21881
+ type CompositionFilters = Filters<'parameters'> & Partial<Record<ProjectMapField, {
21882
+ eq: string;
21883
+ } | {
21884
+ neq: string;
21885
+ } | {
21886
+ in: InNinFilter<string>;
21887
+ } | {
21888
+ nin: InNinFilter<string>;
21889
+ } | {
21890
+ def: DefFilter;
21891
+ }> | Record<`${ProjectMapField}[${'eq' | 'neq'}]`, string> | Record<`${ProjectMapField}[${'in' | 'nin'}]`, InNinFilter<string>> | Record<`${ProjectMapField}[def]`, DefFilter>>;
22103
21892
 
22104
21893
  type schemas = components$3['schemas'];
22105
21894
  type InvalidationPayload = schemas['InvalidationPayload'];
@@ -25008,167 +24797,293 @@ interface external$1 {
25008
24797
  locales?: {
25009
24798
  [key: string]: external$1["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeLocaleUpdate"];
25010
24799
  };
25011
- };
25012
- ProjectMapNodeLocaleUpdate: {
25013
- /** @description Name of node in the locale */
25014
- name?: string;
25015
- /** @description Locale specific path segment for this node (not a full path) */
25016
- pathSegment: string;
25017
- };
25018
- ProjectMapNodeData: {
25019
- /** @description While performing a search if a node is a hit, this property will return true. If it's supporting structure, like a parent of a search hit, it will return false */
25020
- isSearchHit?: boolean;
25021
- /** @description Query strings that are allowed to be passed to the node */
25022
- queryStrings?: external$1["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeAllowedQueryString"][];
25023
- /**
25024
- * @description For dynamic nodes, this is the preview value for the dynamic value.
25025
- * The preview value is used when editing a connected composition, and is the default
25026
- * dynamic node value unless the author has explicitly chosen a different value.
25027
- */
25028
- previewValue?: string;
25029
- };
25030
- ProjectMapNodeAllowedQueryString: {
25031
- /** @description The name of the query string parameter */
25032
- name: string;
25033
- /** @description The default value of the query string if it is not provided by an incoming route path */
25034
- value?: string;
25035
- /** @description Help text for authors who might be setting up a preview value for this query string */
25036
- helpText?: string;
25037
- };
25038
- };
25039
- };
25040
- operations: {};
25041
- };
25042
- "v1-project-map-tree.swagger.yml": {
25043
- paths: {};
25044
- components: {
25045
- schemas: {
25046
- ProjectMapTreeNodeDefinition: external$1["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeDefinition"] & {
25047
- /** @description Children of the node */
25048
- children?: external$1["v1-project-map-tree.swagger.yml"]["components"]["schemas"]["ProjectMapTreeNodeDefinition"][];
25049
- } & {
25050
- name: unknown;
25051
- };
25052
- };
25053
- };
25054
- operations: {};
25055
- };
24800
+ };
24801
+ ProjectMapNodeLocaleUpdate: {
24802
+ /** @description Name of node in the locale */
24803
+ name?: string;
24804
+ /** @description Locale specific path segment for this node (not a full path) */
24805
+ pathSegment: string;
24806
+ };
24807
+ ProjectMapNodeData: {
24808
+ /** @description While performing a search if a node is a hit, this property will return true. If it's supporting structure, like a parent of a search hit, it will return false */
24809
+ isSearchHit?: boolean;
24810
+ /** @description Query strings that are allowed to be passed to the node */
24811
+ queryStrings?: external$1["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeAllowedQueryString"][];
24812
+ /**
24813
+ * @description For dynamic nodes, this is the preview value for the dynamic value.
24814
+ * The preview value is used when editing a connected composition, and is the default
24815
+ * dynamic node value unless the author has explicitly chosen a different value.
24816
+ */
24817
+ previewValue?: string;
24818
+ };
24819
+ ProjectMapNodeAllowedQueryString: {
24820
+ /** @description The name of the query string parameter */
24821
+ name: string;
24822
+ /** @description The default value of the query string if it is not provided by an incoming route path */
24823
+ value?: string;
24824
+ /** @description Help text for authors who might be setting up a preview value for this query string */
24825
+ helpText?: string;
24826
+ };
24827
+ };
24828
+ };
24829
+ operations: {};
24830
+ };
24831
+ "v1-project-map-tree.swagger.yml": {
24832
+ paths: {};
24833
+ components: {
24834
+ schemas: {
24835
+ ProjectMapTreeNodeDefinition: external$1["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeDefinition"] & {
24836
+ /** @description Children of the node */
24837
+ children?: external$1["v1-project-map-tree.swagger.yml"]["components"]["schemas"]["ProjectMapTreeNodeDefinition"][];
24838
+ } & {
24839
+ name: unknown;
24840
+ };
24841
+ };
24842
+ };
24843
+ operations: {};
24844
+ };
24845
+ }
24846
+
24847
+ type WorkflowsApi = paths$1['/api/v1/workflows'];
24848
+ type SharedComponents = components$7['schemas'];
24849
+ type WorkflowDefinition = SharedComponents['WorkflowDefinition'];
24850
+ type WorkflowStage = SharedComponents['WorkflowStage'];
24851
+ type WorkflowStagePermission = SharedComponents['WorkflowStagePermission'];
24852
+ type WorkflowStageTransition = SharedComponents['WorkflowStageTransition'];
24853
+ type WorkflowStageTransitionPermission = SharedComponents['WorkflowStageTransitionPermission'];
24854
+ /** Query parameter options for GET /api/v1/workflows */
24855
+ type WorkflowsGetParameters = WorkflowsApi['get']['parameters']['query'];
24856
+ /** The GET response from /api/v1/workflows */
24857
+ type WorkflowsGetResponse = WorkflowsApi['get']['responses']['200']['content']['application/json'];
24858
+ /** The PUT request body for /api/v1/workflows */
24859
+ type WorkflowsPutParameters = WorkflowsApi['put']['requestBody']['content']['application/json'];
24860
+ /** Shape of the DELETE request body for /api/v1/workflows */
24861
+ type WorkflowsDeleteParameters = WorkflowsApi['delete']['requestBody']['content']['application/json'];
24862
+
24863
+ type CanvasClientOptions = ClientOptions & {
24864
+ edgeApiHost?: string;
24865
+ disableSWR?: boolean;
24866
+ };
24867
+ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
24868
+ private edgeApiHost;
24869
+ private edgeApiRequestInit?;
24870
+ constructor(options: CanvasClientOptions);
24871
+ /** Fetches lists of Canvas compositions, optionally by type */
24872
+ getCompositionList(params?: Omit<CompositionGetParameters, 'projectId' | 'componentId' | 'compositionId' | 'slug'> & {
24873
+ filters?: CompositionFilters;
24874
+ } & ({
24875
+ resolveData: true;
24876
+ diagnostics?: boolean;
24877
+ } | {
24878
+ resolveData?: false;
24879
+ })): Promise<CompositionGetListResponse | CompositionResolvedListResponse>;
24880
+ /** Fetches one composition by its project map node path */
24881
+ getCompositionByNodePath(options: CompositionGetByNodePathParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
24882
+ getCompositionByNodePath(options: CompositionGetByNodePathParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
24883
+ getCompositionByNodePath<T extends CompositionGetResponse = CompositionGetValidResponses>(options: CompositionGetByNodePathParameters & DataResolutionOption & DataResolutionParameters): Promise<T>;
24884
+ /** Fetches one composition by its project map node ID */
24885
+ getCompositionByNodeId(options: CompositionGetByNodeIdParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
24886
+ getCompositionByNodeId(options: CompositionGetByNodeIdParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
24887
+ getCompositionByNodeId<T extends CompositionGetResponse = CompositionGetValidResponses>(options: CompositionGetByNodeIdParameters & DataResolutionOption & DataResolutionParameters): Promise<T>;
24888
+ /** Fetches one composition by its slug */
24889
+ getCompositionBySlug(options: CompositionGetBySlugParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
24890
+ getCompositionBySlug(options: CompositionGetBySlugParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
24891
+ getCompositionBySlug<T extends CompositionGetResponse = CompositionGetValidResponses>(options: CompositionGetBySlugParameters & DataResolutionOption & DataResolutionParameters): Promise<T>;
24892
+ /** Fetches one composition by its ID */
24893
+ getCompositionById(options: CompositionGetByIdParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
24894
+ getCompositionById(options: CompositionGetByIdParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
24895
+ getCompositionById<T extends CompositionGetResponse = CompositionGetValidResponses>(options: CompositionGetByIdParameters & DataResolutionOption & DataResolutionParameters): Promise<T>;
24896
+ /** Fetches a component definition's composition defaults */
24897
+ getCompositionDefaults(options: CompositionGetByComponentIdParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
24898
+ getCompositionDefaults(options: CompositionGetByComponentIdParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
24899
+ getCompositionDefaults<T extends CompositionGetResponse = CompositionGetValidResponses>(options: CompositionGetByComponentIdParameters & DataResolutionOption & DataResolutionParameters): Promise<T>;
24900
+ /** Fetches historical versions of a composition or pattern */
24901
+ getCompositionHistory(options: ExceptProject<ComponentInstanceHistoryGetParameters>): Promise<{
24902
+ cursor?: string | undefined;
24903
+ truncated?: boolean | undefined;
24904
+ results?: {
24905
+ versionId: string;
24906
+ timestamp: number;
24907
+ authorName: string;
24908
+ authorIsApiKey: boolean;
24909
+ state: number;
24910
+ }[] | undefined;
24911
+ }>;
24912
+ private getOneComposition;
24913
+ /** Updates or creates a Canvas component definition */
24914
+ updateComposition(body: Omit<CompositionPutParameters, 'projectId'>): Promise<void>;
24915
+ /** Deletes a Canvas component definition */
24916
+ removeComposition(body: Omit<CompositionDeleteParameters, 'projectId'>): Promise<void>;
24917
+ /** Fetches all Canvas component definitions */
24918
+ getComponentDefinitions(options?: Omit<ComponentDefinitionGetParameters, 'projectId'>): Promise<{
24919
+ componentDefinitions: {
24920
+ id: string;
24921
+ name: string;
24922
+ icon?: string | undefined;
24923
+ titleParameter?: string | null | undefined;
24924
+ thumbnailParameter?: string | null | undefined;
24925
+ canBeComposition?: boolean | undefined;
24926
+ parameters?: {
24927
+ id: string;
24928
+ name: string;
24929
+ helpText?: string | undefined;
24930
+ type: string;
24931
+ localizable?: boolean | undefined;
24932
+ typeConfig?: unknown;
24933
+ }[] | undefined;
24934
+ categoryId?: string | null | undefined;
24935
+ description?: string | undefined;
24936
+ previewImageUrl?: string | undefined;
24937
+ useTeamPermissions?: boolean | undefined;
24938
+ permissions?: {
24939
+ roleId: string;
24940
+ permission: "read" | "write" | "create" | "delete";
24941
+ state: number;
24942
+ }[] | undefined;
24943
+ slots?: {
24944
+ id: string;
24945
+ name: string;
24946
+ allowedComponents: string[];
24947
+ inheritAllowedComponents: boolean;
24948
+ allowAllComponents?: boolean | undefined;
24949
+ patternsInAllowedComponents?: boolean | undefined;
24950
+ minComponents?: number | undefined;
24951
+ maxComponents?: number | undefined;
24952
+ }[] | undefined;
24953
+ slugSettings?: {
24954
+ required?: "no" | "yes" | "disabled" | undefined;
24955
+ unique?: "no" | "local" | "global" | undefined;
24956
+ regularExpression?: string | undefined;
24957
+ regularExpressionMessage?: string | undefined;
24958
+ } | undefined;
24959
+ defaults?: {
24960
+ type: string;
24961
+ parameters?: {
24962
+ [key: string]: {
24963
+ value?: unknown;
24964
+ type: string;
24965
+ connectedData?: {
24966
+ pointer: string;
24967
+ syntax: "jptr";
24968
+ failureAction?: "t" | "p" | "c" | "a" | undefined;
24969
+ failureLogLevel?: "e" | "w" | "i" | undefined;
24970
+ failureDefault?: string | undefined;
24971
+ } | undefined;
24972
+ locales?: {
24973
+ [key: string]: unknown;
24974
+ } | undefined;
24975
+ };
24976
+ } | undefined;
24977
+ variant?: string | undefined;
24978
+ slots?: {
24979
+ [key: string]: any[];
24980
+ } | undefined;
24981
+ _id?: string | undefined;
24982
+ _pattern?: string | undefined;
24983
+ _dataResources?: {
24984
+ [key: string]: {
24985
+ type: string;
24986
+ isPatternParameter?: boolean | undefined;
24987
+ ignorePatternParameterDefault?: boolean | undefined;
24988
+ optionalPatternParameter?: boolean | undefined;
24989
+ variables?: {
24990
+ [key: string]: string;
24991
+ } | undefined;
24992
+ };
24993
+ } | undefined;
24994
+ _patternDataResources?: {
24995
+ [key: string]: {
24996
+ type: string;
24997
+ isPatternParameter?: boolean | undefined;
24998
+ ignorePatternParameterDefault?: boolean | undefined;
24999
+ optionalPatternParameter?: boolean | undefined;
25000
+ variables?: {
25001
+ [key: string]: string;
25002
+ } | undefined;
25003
+ };
25004
+ } | undefined;
25005
+ _patternError?: "NOTFOUND" | "CYCLIC" | undefined;
25006
+ _overrides?: {
25007
+ [key: string]: {
25008
+ parameters?: {
25009
+ [key: string]: {
25010
+ value?: unknown;
25011
+ type: string;
25012
+ connectedData?: {
25013
+ pointer: string;
25014
+ syntax: "jptr";
25015
+ failureAction?: "t" | "p" | "c" | "a" | undefined;
25016
+ failureLogLevel?: "e" | "w" | "i" | undefined;
25017
+ failureDefault?: string | undefined;
25018
+ } | undefined;
25019
+ locales?: {
25020
+ [key: string]: unknown;
25021
+ } | undefined;
25022
+ };
25023
+ } | undefined;
25024
+ slots?: {
25025
+ [key: string]: any[];
25026
+ } | undefined;
25027
+ variant?: string | undefined;
25028
+ };
25029
+ } | undefined;
25030
+ _overridability?: {
25031
+ parameters?: {
25032
+ [key: string]: "no" | "yes";
25033
+ } | undefined;
25034
+ variants?: boolean | undefined;
25035
+ hideLockedParameters?: boolean | undefined;
25036
+ } | undefined;
25037
+ _locales?: string[] | undefined;
25038
+ } | null | undefined;
25039
+ variants?: {
25040
+ id: string;
25041
+ name: string;
25042
+ }[] | undefined;
25043
+ created?: string | undefined;
25044
+ updated?: string | undefined;
25045
+ workflowId?: string | undefined;
25046
+ }[];
25047
+ }>;
25048
+ /** Updates or creates a Canvas component definition */
25049
+ updateComponentDefinition(body: Omit<ComponentDefinitionPutParameters, 'projectId'>): Promise<void>;
25050
+ /** Deletes a Canvas component definition */
25051
+ removeComponentDefinition(body: Omit<ComponentDefinitionDeleteParameters, 'projectId'>): Promise<void>;
25052
+ }
25053
+ declare class UncachedCanvasClient extends CanvasClient {
25054
+ constructor(options: Omit<CanvasClientOptions, 'bypassCache'>);
25056
25055
  }
25057
25056
 
25058
- type WorkflowsApi = paths$1['/api/v1/workflows'];
25059
- type SharedComponents = components$7['schemas'];
25060
- type WorkflowDefinition = SharedComponents['WorkflowDefinition'];
25061
- type WorkflowStage = SharedComponents['WorkflowStage'];
25062
- type WorkflowStagePermission = SharedComponents['WorkflowStagePermission'];
25063
- type WorkflowStageTransition = SharedComponents['WorkflowStageTransition'];
25064
- type WorkflowStageTransitionPermission = SharedComponents['WorkflowStageTransitionPermission'];
25065
- /** Query parameter options for GET /api/v1/workflows */
25066
- type WorkflowsGetParameters = WorkflowsApi['get']['parameters']['query'];
25067
- /** The GET response from /api/v1/workflows */
25068
- type WorkflowsGetResponse = WorkflowsApi['get']['responses']['200']['content']['application/json'];
25069
- /** The PUT request body for /api/v1/workflows */
25070
- type WorkflowsPutParameters = WorkflowsApi['put']['requestBody']['content']['application/json'];
25071
- /** Shape of the DELETE request body for /api/v1/workflows */
25072
- type WorkflowsDeleteParameters = WorkflowsApi['delete']['requestBody']['content']['application/json'];
25057
+ declare class CategoryClient extends ApiClient {
25058
+ constructor(options: ClientOptions);
25059
+ /** Fetches all categories created in given project */
25060
+ getCategories(options?: Omit<CategoriesGetParameters, 'projectId'>): Promise<{
25061
+ categories: {
25062
+ id: string;
25063
+ name: string;
25064
+ order?: number | undefined;
25065
+ }[];
25066
+ }>;
25067
+ /** Updates or creates a category, also used to re-order them */
25068
+ upsertCategories(categories: CategoriesPutParameters['categories']): Promise<unknown>;
25069
+ /** Deletes a category */
25070
+ removeCategory(options: Omit<CategoriesDeleteParameters, 'projectId'>): Promise<unknown>;
25071
+ }
25072
+ declare class UncachedCategoryClient extends CategoryClient {
25073
+ constructor(options: Omit<ClientOptions, 'bypassCache'>);
25074
+ }
25073
25075
 
25074
25076
  type ContentClientOptions = ClientOptions & {
25075
25077
  edgeApiHost?: string;
25076
25078
  disableSWR?: boolean;
25077
25079
  };
25078
- type Filters = Partial<Record<'entityId' | 'type' | 'uiStatus', {
25079
- eq: string;
25080
- } | {
25081
- neq: string;
25082
- } | {
25083
- in: string[];
25084
- } | {
25085
- nin: string[];
25086
- }> | Record<`${'entityId' | 'type' | 'uiStatus'}[${'eq' | 'neq'}]`, string> | Record<`${'entityId' | 'type' | 'uiStatus'}[${'in' | 'nin'}]`, string[]> | Record<'created' | 'modified', {
25087
- eq: string;
25088
- } | {
25089
- neq: string;
25090
- } | {
25091
- in: string[];
25092
- } | {
25093
- nin: string[];
25094
- } | {
25095
- gt: string;
25096
- } | {
25097
- gte: string;
25098
- } | {
25099
- lt: string;
25100
- } | {
25101
- lte: string;
25102
- }> | Record<`${'created' | 'modified'}[${'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte'}]`, string> | Record<`${'created' | 'modified'}[${'in' | 'nin'}]`, string[]> | Record<'locale' | 'releaseId' | 'patternId', {
25103
- eq: string;
25104
- } | {
25105
- neq: string;
25106
- } | {
25107
- in: string[];
25108
- } | {
25109
- nin: string[];
25110
- } | {
25111
- def: boolean | 'true' | 'false';
25112
- }> | Record<`${'locale' | 'releaseId' | 'patternId'}[${'eq' | 'neq'}]`, string> | Record<`${'locale' | 'releaseId' | 'patternId'}[${'in' | 'nin'}]`, string[]> | Record<`${'locale' | 'releaseId' | 'patternId'}[def]`, boolean | 'true' | 'false'> | Record<'name' | 'slug', {
25113
- match: string;
25114
- } | {
25115
- starts: string;
25116
- } | {
25117
- eq: string;
25118
- } | {
25119
- neq: string;
25120
- } | {
25121
- in: string[];
25122
- } | {
25123
- nin: string[];
25124
- } | {
25125
- def: boolean | 'true' | 'false';
25126
- }> | Record<`${'name' | 'slug'}[${'match' | 'starts' | 'eq' | 'neq'}]`, string> | Record<`${'name' | 'slug'}[${'in' | 'nin'}]`, string[]> | Record<`${'name' | 'slug'}[def]`, boolean | 'true' | 'false'> | Record<'creator' | 'author', {
25127
- match: string;
25128
- } | {
25129
- starts: string;
25130
- } | {
25131
- eq: string;
25132
- } | {
25133
- neq: string;
25134
- } | {
25135
- in: string[];
25136
- } | {
25137
- nin: string[];
25138
- }> | Record<`${'creator' | 'author'}[${'match' | 'starts' | 'eq' | 'neq'}]`, string> | Record<`${'creator' | 'author'}[${'in' | 'nin'}]`, string[]> | Record<'isPattern', {
25139
- eq: boolean | 'true' | 'false';
25140
- } | {
25141
- neq: boolean | 'true' | 'false';
25142
- }> | Record<`isPattern[${'eq' | 'neq'}]`, boolean | 'true' | 'false'> | Record<`fields.${string}`, {
25143
- match: string;
25144
- } | {
25145
- starts: string;
25146
- } | {
25147
- eq: string | number | boolean;
25148
- } | {
25149
- neq: string | number | boolean;
25150
- } | {
25151
- in: (string | number | boolean)[];
25152
- } | {
25153
- nin: (string | number | boolean)[];
25154
- } | {
25155
- gt: string | number;
25156
- } | {
25157
- gte: string | number;
25158
- } | {
25159
- lt: string | number;
25160
- } | {
25161
- lte: string | number;
25162
- } | {
25163
- def: boolean | 'true' | 'false';
25164
- }> | Record<`fields.${string}[${'match' | 'starts'}]`, string> | Record<`fields.${string}[${'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte'}]`, string | number> | Record<`fields.${string}[${'in' | 'nin'}]`, (string | number)[]> | Record<`fields.${string}[def]`, boolean | 'true' | 'false'>>;
25165
25080
  declare class ContentClient extends ApiClient<ContentClientOptions> {
25166
25081
  #private;
25167
25082
  private edgeApiHost;
25168
25083
  constructor(options: ContentClientOptions);
25169
25084
  getContentTypes(options?: ExceptProject<GetContentTypesOptions>): Promise<GetContentTypesResponse>;
25170
25085
  getEntries(options: ExceptProject<GetEntriesOptions> & DataResolutionParameters & DataResolutionOption & {
25171
- filters?: Filters;
25086
+ filters?: EntryFilters;
25172
25087
  }): Promise<GetEntriesResponse>;
25173
25088
  /** Fetches historical versions of an entry */
25174
25089
  getEntryHistory(options: ExceptProject<EntriesHistoryGetParameters>): Promise<{
@@ -26513,4 +26428,4 @@ declare class WorkflowClient extends ApiClient {
26513
26428
 
26514
26429
  declare const CanvasClientError: typeof ApiClientError;
26515
26430
 
26516
- export { ASSETS_SOURCE_CUSTOM_URL, ASSETS_SOURCE_UNIFORM, ASSET_PARAMETER_TYPE, ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, type AddComponentMessage, type AssetParamValue, type AssetParamValueItem, type BatchEnhancer, BatchEntry, type BatchInvalidationPayload, type BindVariablesOptions, type BindVariablesResult, type BindVariablesToObjectOptions, type BlockLocationReference, type BlockValue, CANVAS_BLOCK_PARAM_TYPE, CANVAS_DRAFT_STATE, CANVAS_EDITOR_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_SLOT_SECTION_SLOT, CANVAS_SLOT_SECTION_TYPE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, type CanvasDefinitions, type CategoriesDeleteParameters, type CategoriesGetParameters, type CategoriesGetResponse, type CategoriesPutParameters, type Category, CategoryClient, type Channel, type ChannelMessage, type ChannelSubscription, ChildEnhancerBuilder, type ComponentDefinition, type ComponentDefinitionDeleteParameters, type ComponentDefinitionGetParameters, type ComponentDefinitionGetResponse, type ComponentDefinitionParameter, type ComponentDefinitionPermission, type ComponentDefinitionPutParameters, type ComponentDefinitionSlot, type ComponentDefinitionSlugSettings, type ComponentDefinitionVariant, type ComponentEnhancer, type ComponentEnhancerFunction, type ComponentEnhancerOptions, type ComponentInstance, type ComponentInstanceContextualEditing, type ComponentInstanceHistoryEntry, type ComponentInstanceHistoryGetParameters, type ComponentInstanceHistoryGetResponse, type ComponentLocationReference, type ComponentLocationReferenceV2, type ComponentOverridability, type ComponentOverride, type ComponentOverrides, type ComponentParameter, type ComponentParameterBlock, type ComponentParameterContextualEditing, type ComponentParameterEnhancer, type ComponentParameterEnhancerFunction, type ComponentParameterEnhancerOptions, type CompositionDataDiagnostic, type CompositionDeleteParameters, type CompositionDiagnostics, type CompositionFilters, type CompositionGetByComponentIdParameters, type CompositionGetByIdParameters, type CompositionGetByNodeIdParameters, type CompositionGetByNodePathParameters, type CompositionGetBySlugParameters, type CompositionGetListResponse, type CompositionGetOrderBy, type CompositionGetParameters, type CompositionGetResponse, type CompositionGetValidResponses, type CompositionIssue, type CompositionPatternIssue, type CompositionPutParameters, type CompositionResolvedGetResponse, type CompositionResolvedListResponse, type CompositionUIStatus, ContentClient, type ContentType, type ContentTypeField, type ContextualEditingComponentReference, type CopiedComponentSubtree, type DataDiagnostic, type DataElementBindingIssue, type DataElementConnectionDefinition, type DataElementConnectionFailureAction, type DataElementConnectionFailureLogLevel, type DataResolutionConfigIssue, type DataResolutionIssue, type DataResolutionOption, type DataResolutionOptionNegative, type DataResolutionOptionPositive, type DataResolutionParameters, type DataResourceDefinition, type DataResourceDefinitions, type DataResourceIssue, type DataResourceVariables, type DataSource, DataSourceClient, type DataSourceDeleteParameters, type DataSourceGetParameters, type DataSourceGetResponse, type DataSourcePutParameters, type DataSourcesGetParameters, type DataSourcesGetResponse, type DataType, DataTypeClient, type DataTypeDeleteParameters, type DataTypeGetParameters, type DataTypeGetResponse, type DataTypePutParameters, type DataVariableDefinition, type DataWithProperties, type DeleteContentTypeOptions, type DeleteEntryOptions, type DismissPlaceholderMessage, type DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_MAX_CACHE_TTL, EDGE_MIN_CACHE_TTL, EMPTY_COMPOSITION, type EdgehancersDiagnostics, type EdgehancersWholeResponseCacheDiagnostics, type EditorStateUpdatedMessage, EnhancerBuilder, type EnhancerContext, type EnhancerError, type EntriesGetParameters, type EntriesGetResponse, type EntriesHistoryGetParameters, type EntriesHistoryGetResponse, type EntriesResolvedListResponse, type Entry, type EntryData, type EntryList, type EventNames, type Filters, type FindInNodeTreeReference, type FlattenProperty, type FlattenValues, type FlattenValuesOptions, type GetContentTypesOptions, type GetContentTypesResponse, type GetEntriesOptions, type GetEntriesResponse, type GetParameterAttributesProps, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_FORCED_SETTINGS_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, type InvalidationPayload, LOCALE_DYNAMIC_INPUT_NAME, type LimitPolicy, type LinkComponentParameterValue, type LinkParamConfiguration, type LinkParamValue, type LinkParameterType, type LinkTypeConfiguration, type Locale, LocaleClient, type LocaleDeleteParameters, type LocalePutParameters, type LocalesGetParameters, type LocalesGetResponse, type LocalizeDeprecatedOptions, type LocalizeModernOptions, type MessageHandler, type MoveComponentMessage, type NodeLocationReference, type NonProjectMapLinkParamValue, type OpenParameterEditorMessage, type OverrideOptions, PLACEHOLDER_ID, type PatternIssue, type PreviewEventBus, type PreviewPanelSettings, type ProjectMapLinkComponentParameterValue, type ProjectMapLinkParamValue, type Prompt, PromptClient, type PromptsDeleteParameters, type PromptsGetParameters, type PromptsGetResponse, type PromptsPutParameters, type PutContentTypeBody, type PutEntryBody, type ReadyMessage, RelationshipClient, type RelationshipResultInstance, type Release, ReleaseClient, type ReleaseContent, ReleaseContentsClient, type ReleaseContentsDeleteBody, type ReleaseContentsGetParameters, type ReleaseContentsGetResponse, type ReleaseDeleteParameters, type ReleasePatchParameters, type ReleasePutParameters, type ReleaseState, type ReleasesGetParameters, type ReleasesGetResponse, type ReportRenderedCompositionsMessage, type RequestComponentSuggestionMessage, type ResolvedRouteGetResponse, type RichTextBuiltInElement, type RichTextBuiltInFormat, type RichTextParamConfiguration, type RichTextParamValue, type RootComponentInstance, type RootEntryReference, type RootLocationReference, RouteClient, type RouteDynamicInputs, type RouteGetParameters, type RouteGetResponse, type RouteGetResponseComposition, type RouteGetResponseEdgehancedComposition, type RouteGetResponseEdgehancedNotFound, type RouteGetResponseNotFound, type RouteGetResponseRedirect, SECRET_QUERY_STRING_PARAM, type SelectComponentMessage, type SelectParameterMessage, type SpecificProjectMap, type SubscribeToCompositionOptions, type SuggestComponentMessage, type TreeNodeInfoTypes, type TriggerComponentActionMessage, type TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UniqueBatchEntries, type UnsubscribeCallback, type UpdateComponentParameterMessage, type UpdateComponentReferencesMessage, type UpdateCompositionInternalMessage, type UpdateCompositionMessage, type UpdateContextualEditingStateInternalMessage, type UpdateFeatureFlagsMessage, type UpdatePreviewSettingsMessage, type WalkComponentTreeActions, type WalkNodeTreeActions, type WalkNodeTreeOptions, WorkflowClient, type WorkflowDefinition, type WorkflowStage, type WorkflowStagePermission, type WorkflowStageTransition, type WorkflowStageTransitionPermission, type WorkflowsDeleteParameters, type WorkflowsGetParameters, type WorkflowsGetResponse, type WorkflowsPutParameters, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, createVariableReference, enhance, extractLocales, findParameterInNodeTree, flattenValues, generateComponentPlaceholderId, generateHash, getBlockValue, getChannelName, getComponentJsonPointer, getComponentPath, getLocalizedPropertyValues, getNounForLocation, getNounForNode, getParameterAttributes, getPropertiesValue, getPropertyValue, isAddComponentMessage, isAllowedReferrer, isAssetParamValue, isAssetParamValueItem, isComponentActionMessage, isComponentPlaceholderId, isDismissPlaceholderMessage, isEntryData, isMovingComponentMessage, isNestedNodeType, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isRequestComponentSuggestionMessage, isRootEntryReference, isSelectComponentMessage, isSelectParameterMessage, isSuggestComponentMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdateFeatureFlagsMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, parseComponentPlaceholderId, parseVariableExpression, subscribeToComposition, walkComponentTree, walkNodeTree };
26431
+ export { ASSETS_SOURCE_CUSTOM_URL, ASSETS_SOURCE_UNIFORM, ASSET_PARAMETER_TYPE, ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, type AddComponentMessage, type AssetParamValue, type AssetParamValueItem, type BatchEnhancer, BatchEntry, type BatchInvalidationPayload, type BindVariablesOptions, type BindVariablesResult, type BindVariablesToObjectOptions, type BlockLocationReference, type BlockValue, CANVAS_BLOCK_PARAM_TYPE, CANVAS_DRAFT_STATE, CANVAS_EDITOR_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_SLOT_SECTION_SLOT, CANVAS_SLOT_SECTION_TYPE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, type CanvasDefinitions, type CategoriesDeleteParameters, type CategoriesGetParameters, type CategoriesGetResponse, type CategoriesPutParameters, type Category, CategoryClient, type Channel, type ChannelMessage, type ChannelSubscription, ChildEnhancerBuilder, type ComponentDefinition, type ComponentDefinitionDeleteParameters, type ComponentDefinitionGetParameters, type ComponentDefinitionGetResponse, type ComponentDefinitionParameter, type ComponentDefinitionPermission, type ComponentDefinitionPutParameters, type ComponentDefinitionSlot, type ComponentDefinitionSlugSettings, type ComponentDefinitionVariant, type ComponentEnhancer, type ComponentEnhancerFunction, type ComponentEnhancerOptions, type ComponentInstance, type ComponentInstanceContextualEditing, type ComponentInstanceHistoryEntry, type ComponentInstanceHistoryGetParameters, type ComponentInstanceHistoryGetResponse, type ComponentLocationReference, type ComponentLocationReferenceV2, type ComponentOverridability, type ComponentOverride, type ComponentOverrides, type ComponentParameter, type ComponentParameterBlock, type ComponentParameterContextualEditing, type ComponentParameterEnhancer, type ComponentParameterEnhancerFunction, type ComponentParameterEnhancerOptions, type CompositionDataDiagnostic, type CompositionDeleteParameters, type CompositionDiagnostics, type CompositionFilters, type CompositionGetByComponentIdParameters, type CompositionGetByIdParameters, type CompositionGetByNodeIdParameters, type CompositionGetByNodePathParameters, type CompositionGetBySlugParameters, type CompositionGetListResponse, type CompositionGetOrderBy, type CompositionGetParameters, type CompositionGetResponse, type CompositionGetValidResponses, type CompositionIssue, type CompositionPatternIssue, type CompositionPutParameters, type CompositionResolvedGetResponse, type CompositionResolvedListResponse, type CompositionUIStatus, ContentClient, type ContentType, type ContentTypeField, type ContextualEditingComponentReference, type CopiedComponentSubtree, type DataDiagnostic, type DataElementBindingIssue, type DataElementConnectionDefinition, type DataElementConnectionFailureAction, type DataElementConnectionFailureLogLevel, type DataResolutionConfigIssue, type DataResolutionIssue, type DataResolutionOption, type DataResolutionOptionNegative, type DataResolutionOptionPositive, type DataResolutionParameters, type DataResourceDefinition, type DataResourceDefinitions, type DataResourceIssue, type DataResourceVariables, type DataSource, DataSourceClient, type DataSourceDeleteParameters, type DataSourceGetParameters, type DataSourceGetResponse, type DataSourcePutParameters, type DataSourcesGetParameters, type DataSourcesGetResponse, type DataType, DataTypeClient, type DataTypeDeleteParameters, type DataTypeGetParameters, type DataTypeGetResponse, type DataTypePutParameters, type DataVariableDefinition, type DataWithProperties, type DeleteContentTypeOptions, type DeleteEntryOptions, type DismissPlaceholderMessage, type DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_MAX_CACHE_TTL, EDGE_MIN_CACHE_TTL, EMPTY_COMPOSITION, type EdgehancersDiagnostics, type EdgehancersWholeResponseCacheDiagnostics, type EditorStateUpdatedMessage, EnhancerBuilder, type EnhancerContext, type EnhancerError, type EntriesGetParameters, type EntriesGetResponse, type EntriesHistoryGetParameters, type EntriesHistoryGetResponse, type EntriesResolvedListResponse, type Entry, type EntryData, type EntryFilters, type EntryList, type EventNames, type Filters, type FindInNodeTreeReference, type FlattenProperty, type FlattenValues, type FlattenValuesOptions, type GetContentTypesOptions, type GetContentTypesResponse, type GetEntriesOptions, type GetEntriesResponse, type GetParameterAttributesProps, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_FORCED_SETTINGS_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, type InvalidationPayload, LOCALE_DYNAMIC_INPUT_NAME, type LimitPolicy, type LinkComponentParameterValue, type LinkParamConfiguration, type LinkParamValue, type LinkParameterType, type LinkTypeConfiguration, type Locale, LocaleClient, type LocaleDeleteParameters, type LocalePutParameters, type LocalesGetParameters, type LocalesGetResponse, type LocalizeDeprecatedOptions, type LocalizeModernOptions, type MessageHandler, type MoveComponentMessage, type NodeLocationReference, type NonProjectMapLinkParamValue, type OpenParameterEditorMessage, type OverrideOptions, PLACEHOLDER_ID, type PatternIssue, type PreviewEventBus, type PreviewPanelSettings, type ProjectMapLinkComponentParameterValue, type ProjectMapLinkParamValue, type Prompt, PromptClient, type PromptsDeleteParameters, type PromptsGetParameters, type PromptsGetResponse, type PromptsPutParameters, type PutContentTypeBody, type PutEntryBody, type ReadyMessage, RelationshipClient, type RelationshipResultInstance, type Release, ReleaseClient, type ReleaseContent, ReleaseContentsClient, type ReleaseContentsDeleteBody, type ReleaseContentsGetParameters, type ReleaseContentsGetResponse, type ReleaseDeleteParameters, type ReleasePatchParameters, type ReleasePutParameters, type ReleaseState, type ReleasesGetParameters, type ReleasesGetResponse, type ReportRenderedCompositionsMessage, type RequestComponentSuggestionMessage, type ResolvedRouteGetResponse, type RichTextBuiltInElement, type RichTextBuiltInFormat, type RichTextParamConfiguration, type RichTextParamValue, type RootComponentInstance, type RootEntryReference, type RootLocationReference, RouteClient, type RouteDynamicInputs, type RouteGetParameters, type RouteGetResponse, type RouteGetResponseComposition, type RouteGetResponseEdgehancedComposition, type RouteGetResponseEdgehancedNotFound, type RouteGetResponseNotFound, type RouteGetResponseRedirect, SECRET_QUERY_STRING_PARAM, type SelectComponentMessage, type SelectParameterMessage, type SpecificProjectMap, type SubscribeToCompositionOptions, type SuggestComponentMessage, type TreeNodeInfoTypes, type TriggerComponentActionMessage, type TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UniqueBatchEntries, type UnsubscribeCallback, type UpdateComponentParameterMessage, type UpdateComponentReferencesMessage, type UpdateCompositionInternalMessage, type UpdateCompositionMessage, type UpdateContextualEditingStateInternalMessage, type UpdateFeatureFlagsMessage, type UpdatePreviewSettingsMessage, type WalkComponentTreeActions, type WalkNodeTreeActions, type WalkNodeTreeOptions, WorkflowClient, type WorkflowDefinition, type WorkflowStage, type WorkflowStagePermission, type WorkflowStageTransition, type WorkflowStageTransitionPermission, type WorkflowsDeleteParameters, type WorkflowsGetParameters, type WorkflowsGetResponse, type WorkflowsPutParameters, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, createVariableReference, enhance, extractLocales, findParameterInNodeTree, flattenValues, generateComponentPlaceholderId, generateHash, getBlockValue, getChannelName, getComponentJsonPointer, getComponentPath, getLocalizedPropertyValues, getNounForLocation, getNounForNode, getParameterAttributes, getPropertiesValue, getPropertyValue, isAddComponentMessage, isAllowedReferrer, isAssetParamValue, isAssetParamValueItem, isComponentActionMessage, isComponentPlaceholderId, isDismissPlaceholderMessage, isEntryData, isMovingComponentMessage, isNestedNodeType, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isRequestComponentSuggestionMessage, isRootEntryReference, isSelectComponentMessage, isSelectParameterMessage, isSuggestComponentMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdateFeatureFlagsMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, parseComponentPlaceholderId, parseVariableExpression, subscribeToComposition, walkComponentTree, walkNodeTree };