@contentful/optimization-api-client 2.1.0 → 2.2.1

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.
@@ -157,9 +157,7 @@ export declare const BatchExperienceEvent: z.ZodMiniDiscriminatedUnion<[z.ZodMin
157
157
  entityId: z.ZodMiniString<string>;
158
158
  entityKind: z.ZodMiniEnum<{
159
159
  Experience: "Experience";
160
- Fragment: "Fragment";
161
- InlineFragment: "InlineFragment";
162
- InlineComponent: "InlineComponent";
160
+ ExperienceFragment: "ExperienceFragment";
163
161
  }>;
164
162
  entityKindId: z.ZodMiniOptional<z.ZodMiniString<string>>;
165
163
  entryIds: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
@@ -533,9 +531,7 @@ export declare const BatchExperienceEventArray: z.ZodMiniArray<z.ZodMiniDiscrimi
533
531
  entityId: z.ZodMiniString<string>;
534
532
  entityKind: z.ZodMiniEnum<{
535
533
  Experience: "Experience";
536
- Fragment: "Fragment";
537
- InlineFragment: "InlineFragment";
538
- InlineComponent: "InlineComponent";
534
+ ExperienceFragment: "ExperienceFragment";
539
535
  }>;
540
536
  entityKindId: z.ZodMiniOptional<z.ZodMiniString<string>>;
541
537
  entryIds: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
@@ -918,9 +914,7 @@ export declare const BatchExperienceRequestData: z.ZodMiniObject<{
918
914
  entityId: z.ZodMiniString<string>;
919
915
  entityKind: z.ZodMiniEnum<{
920
916
  Experience: "Experience";
921
- Fragment: "Fragment";
922
- InlineFragment: "InlineFragment";
923
- InlineComponent: "InlineComponent";
917
+ ExperienceFragment: "ExperienceFragment";
924
918
  }>;
925
919
  entityKindId: z.ZodMiniOptional<z.ZodMiniString<string>>;
926
920
  entryIds: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
@@ -1163,7 +1157,7 @@ export declare const BatchExperienceRequestData: z.ZodMiniObject<{
1163
1157
  anonymousId: z.ZodMiniString<string>;
1164
1158
  }, z.core.$strip>], "type">>;
1165
1159
  /**
1166
- * Optional configuration for this experience request.
1160
+ * Optional feature configuration. Batch locations belong in each event's `context.location`.
1167
1161
  */
1168
1162
  options: z.ZodMiniOptional<z.ZodMiniObject<{
1169
1163
  features: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
@@ -1558,9 +1552,7 @@ export declare const BatchInsightsEvent: z.ZodMiniObject<{
1558
1552
  entityId: z.ZodMiniString<string>;
1559
1553
  entityKind: z.ZodMiniEnum<{
1560
1554
  Experience: "Experience";
1561
- Fragment: "Fragment";
1562
- InlineFragment: "InlineFragment";
1563
- InlineComponent: "InlineComponent";
1555
+ ExperienceFragment: "ExperienceFragment";
1564
1556
  }>;
1565
1557
  entityKindId: z.ZodMiniOptional<z.ZodMiniString<string>>;
1566
1558
  entryIds: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
@@ -1630,9 +1622,7 @@ export declare const BatchInsightsEvent: z.ZodMiniObject<{
1630
1622
  entityId: z.ZodMiniString<string>;
1631
1623
  entityKind: z.ZodMiniEnum<{
1632
1624
  Experience: "Experience";
1633
- Fragment: "Fragment";
1634
- InlineFragment: "InlineFragment";
1635
- InlineComponent: "InlineComponent";
1625
+ ExperienceFragment: "ExperienceFragment";
1636
1626
  }>;
1637
1627
  entityKindId: z.ZodMiniOptional<z.ZodMiniString<string>>;
1638
1628
  entryIds: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
@@ -1700,9 +1690,7 @@ export declare const BatchInsightsEvent: z.ZodMiniObject<{
1700
1690
  entityId: z.ZodMiniString<string>;
1701
1691
  entityKind: z.ZodMiniEnum<{
1702
1692
  Experience: "Experience";
1703
- Fragment: "Fragment";
1704
- InlineFragment: "InlineFragment";
1705
- InlineComponent: "InlineComponent";
1693
+ ExperienceFragment: "ExperienceFragment";
1706
1694
  }>;
1707
1695
  entityKindId: z.ZodMiniOptional<z.ZodMiniString<string>>;
1708
1696
  entryIds: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
@@ -1985,9 +1973,7 @@ export declare const BatchInsightsEventArray: z.ZodMiniArray<z.ZodMiniObject<{
1985
1973
  entityId: z.ZodMiniString<string>;
1986
1974
  entityKind: z.ZodMiniEnum<{
1987
1975
  Experience: "Experience";
1988
- Fragment: "Fragment";
1989
- InlineFragment: "InlineFragment";
1990
- InlineComponent: "InlineComponent";
1976
+ ExperienceFragment: "ExperienceFragment";
1991
1977
  }>;
1992
1978
  entityKindId: z.ZodMiniOptional<z.ZodMiniString<string>>;
1993
1979
  entryIds: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
@@ -2057,9 +2043,7 @@ export declare const BatchInsightsEventArray: z.ZodMiniArray<z.ZodMiniObject<{
2057
2043
  entityId: z.ZodMiniString<string>;
2058
2044
  entityKind: z.ZodMiniEnum<{
2059
2045
  Experience: "Experience";
2060
- Fragment: "Fragment";
2061
- InlineFragment: "InlineFragment";
2062
- InlineComponent: "InlineComponent";
2046
+ ExperienceFragment: "ExperienceFragment";
2063
2047
  }>;
2064
2048
  entityKindId: z.ZodMiniOptional<z.ZodMiniString<string>>;
2065
2049
  entryIds: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
@@ -2127,9 +2111,7 @@ export declare const BatchInsightsEventArray: z.ZodMiniArray<z.ZodMiniObject<{
2127
2111
  entityId: z.ZodMiniString<string>;
2128
2112
  entityKind: z.ZodMiniEnum<{
2129
2113
  Experience: "Experience";
2130
- Fragment: "Fragment";
2131
- InlineFragment: "InlineFragment";
2132
- InlineComponent: "InlineComponent";
2114
+ ExperienceFragment: "ExperienceFragment";
2133
2115
  }>;
2134
2116
  entityKindId: z.ZodMiniOptional<z.ZodMiniString<string>>;
2135
2117
  entryIds: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
@@ -2329,8 +2311,8 @@ export declare const ChangeBase: z.ZodMiniObject<{
2329
2311
  */
2330
2312
  type: z.ZodMiniUnion<readonly [z.ZodMiniEnum<{
2331
2313
  Experience: "Experience";
2332
- Fragment: "Fragment";
2333
2314
  Variable: "Variable";
2315
+ Fragment: "Fragment";
2334
2316
  }>, z.ZodMiniString<string>]>;
2335
2317
  /**
2336
2318
  * Metadata describing the originating experience and variant index.
@@ -2566,9 +2548,7 @@ export declare const ExoClickEvent: z.ZodMiniObject<{
2566
2548
  entityId: z.ZodMiniString<string>;
2567
2549
  entityKind: z.ZodMiniEnum<{
2568
2550
  Experience: "Experience";
2569
- Fragment: "Fragment";
2570
- InlineFragment: "InlineFragment";
2571
- InlineComponent: "InlineComponent";
2551
+ ExperienceFragment: "ExperienceFragment";
2572
2552
  }>;
2573
2553
  entityKindId: z.ZodMiniOptional<z.ZodMiniString<string>>;
2574
2554
  entryIds: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
@@ -2595,9 +2575,7 @@ export declare type ExoClickEvent = z.infer<typeof ExoClickEvent>;
2595
2575
  */
2596
2576
  export declare const ExoEntityKind: z.ZodMiniEnum<{
2597
2577
  Experience: "Experience";
2598
- Fragment: "Fragment";
2599
- InlineFragment: "InlineFragment";
2600
- InlineComponent: "InlineComponent";
2578
+ ExperienceFragment: "ExperienceFragment";
2601
2579
  }>;
2602
2580
 
2603
2581
  /**
@@ -2669,9 +2647,7 @@ export declare const ExoEventProperties: z.ZodMiniObject<{
2669
2647
  entityId: z.ZodMiniString<string>;
2670
2648
  entityKind: z.ZodMiniEnum<{
2671
2649
  Experience: "Experience";
2672
- Fragment: "Fragment";
2673
- InlineFragment: "InlineFragment";
2674
- InlineComponent: "InlineComponent";
2650
+ ExperienceFragment: "ExperienceFragment";
2675
2651
  }>;
2676
2652
  entityKindId: z.ZodMiniOptional<z.ZodMiniString<string>>;
2677
2653
  entryIds: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
@@ -2752,9 +2728,7 @@ export declare const ExoHoverEvent: z.ZodMiniObject<{
2752
2728
  entityId: z.ZodMiniString<string>;
2753
2729
  entityKind: z.ZodMiniEnum<{
2754
2730
  Experience: "Experience";
2755
- Fragment: "Fragment";
2756
- InlineFragment: "InlineFragment";
2757
- InlineComponent: "InlineComponent";
2731
+ ExperienceFragment: "ExperienceFragment";
2758
2732
  }>;
2759
2733
  entityKindId: z.ZodMiniOptional<z.ZodMiniString<string>>;
2760
2734
  entryIds: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
@@ -2838,9 +2812,7 @@ export declare const ExoViewEvent: z.ZodMiniObject<{
2838
2812
  entityId: z.ZodMiniString<string>;
2839
2813
  entityKind: z.ZodMiniEnum<{
2840
2814
  Experience: "Experience";
2841
- Fragment: "Fragment";
2842
- InlineFragment: "InlineFragment";
2843
- InlineComponent: "InlineComponent";
2815
+ ExperienceFragment: "ExperienceFragment";
2844
2816
  }>;
2845
2817
  entityKindId: z.ZodMiniOptional<z.ZodMiniString<string>>;
2846
2818
  entryIds: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
@@ -3116,9 +3088,7 @@ export declare const ExperienceEvent: z.ZodMiniDiscriminatedUnion<[z.ZodMiniObje
3116
3088
  entityId: z.ZodMiniString<string>;
3117
3089
  entityKind: z.ZodMiniEnum<{
3118
3090
  Experience: "Experience";
3119
- Fragment: "Fragment";
3120
- InlineFragment: "InlineFragment";
3121
- InlineComponent: "InlineComponent";
3091
+ ExperienceFragment: "ExperienceFragment";
3122
3092
  }>;
3123
3093
  entityKindId: z.ZodMiniOptional<z.ZodMiniString<string>>;
3124
3094
  entryIds: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
@@ -3486,9 +3456,7 @@ export declare const ExperienceEventArray: z.ZodMiniArray<z.ZodMiniDiscriminated
3486
3456
  entityId: z.ZodMiniString<string>;
3487
3457
  entityKind: z.ZodMiniEnum<{
3488
3458
  Experience: "Experience";
3489
- Fragment: "Fragment";
3490
- InlineFragment: "InlineFragment";
3491
- InlineComponent: "InlineComponent";
3459
+ ExperienceFragment: "ExperienceFragment";
3492
3460
  }>;
3493
3461
  entityKindId: z.ZodMiniOptional<z.ZodMiniString<string>>;
3494
3462
  entryIds: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
@@ -3874,9 +3842,7 @@ export declare const ExperienceRequestData: z.ZodMiniObject<{
3874
3842
  entityId: z.ZodMiniString<string>;
3875
3843
  entityKind: z.ZodMiniEnum<{
3876
3844
  Experience: "Experience";
3877
- Fragment: "Fragment";
3878
- InlineFragment: "InlineFragment";
3879
- InlineComponent: "InlineComponent";
3845
+ ExperienceFragment: "ExperienceFragment";
3880
3846
  }>;
3881
3847
  entityKindId: z.ZodMiniOptional<z.ZodMiniString<string>>;
3882
3848
  entryIds: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
@@ -4121,6 +4087,23 @@ export declare const ExperienceRequestData: z.ZodMiniObject<{
4121
4087
  * Features or capabilities to enable for this request.
4122
4088
  */
4123
4089
  features: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
4090
+ /**
4091
+ * Location default for singular profile requests. Event `context.location` fields override it.
4092
+ */
4093
+ location: z.ZodMiniOptional<z.ZodMiniObject<{
4094
+ coordinates: z.ZodMiniOptional<z.ZodMiniObject<{
4095
+ latitude: z.ZodMiniNumber<number>;
4096
+ longitude: z.ZodMiniNumber<number>;
4097
+ }, z.core.$strip>>;
4098
+ city: z.ZodMiniOptional<z.ZodMiniString<string>>;
4099
+ postalCode: z.ZodMiniOptional<z.ZodMiniString<string>>;
4100
+ region: z.ZodMiniOptional<z.ZodMiniString<string>>;
4101
+ regionCode: z.ZodMiniOptional<z.ZodMiniString<string>>;
4102
+ country: z.ZodMiniOptional<z.ZodMiniString<string>>;
4103
+ countryCode: z.ZodMiniOptional<z.ZodMiniString<string>>;
4104
+ continent: z.ZodMiniOptional<z.ZodMiniString<string>>;
4105
+ timezone: z.ZodMiniOptional<z.ZodMiniString<string>>;
4106
+ }, z.core.$strip>>;
4124
4107
  }, z.core.$strip>>;
4125
4108
  }, z.core.$strip>;
4126
4109
 
@@ -4135,8 +4118,8 @@ export declare type ExperienceRequestData = z.infer<typeof ExperienceRequestData
4135
4118
  * Zod schema describing optional configuration for an experience request.
4136
4119
  *
4137
4120
  * @remarks
4138
- * These options can be used to enable or filter specific features when
4139
- * evaluating experiences.
4121
+ * These options configure feature flags and the request location default when
4122
+ * evaluating experiences through singular profile requests.
4140
4123
  *
4141
4124
  * @public
4142
4125
  */
@@ -4145,6 +4128,23 @@ export declare const ExperienceRequestOptions: z.ZodMiniObject<{
4145
4128
  * Features or capabilities to enable for this request.
4146
4129
  */
4147
4130
  features: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
4131
+ /**
4132
+ * Location default for singular profile requests. Event `context.location` fields override it.
4133
+ */
4134
+ location: z.ZodMiniOptional<z.ZodMiniObject<{
4135
+ coordinates: z.ZodMiniOptional<z.ZodMiniObject<{
4136
+ latitude: z.ZodMiniNumber<number>;
4137
+ longitude: z.ZodMiniNumber<number>;
4138
+ }, z.core.$strip>>;
4139
+ city: z.ZodMiniOptional<z.ZodMiniString<string>>;
4140
+ postalCode: z.ZodMiniOptional<z.ZodMiniString<string>>;
4141
+ region: z.ZodMiniOptional<z.ZodMiniString<string>>;
4142
+ regionCode: z.ZodMiniOptional<z.ZodMiniString<string>>;
4143
+ country: z.ZodMiniOptional<z.ZodMiniString<string>>;
4144
+ countryCode: z.ZodMiniOptional<z.ZodMiniString<string>>;
4145
+ continent: z.ZodMiniOptional<z.ZodMiniString<string>>;
4146
+ timezone: z.ZodMiniOptional<z.ZodMiniString<string>>;
4147
+ }, z.core.$strip>>;
4148
4148
  }, z.core.$strip>;
4149
4149
 
4150
4150
  /**
@@ -4294,7 +4294,7 @@ export declare const FragmentChange: z.ZodMiniObject<{
4294
4294
  export declare type FragmentChange = z.infer<typeof FragmentChange>;
4295
4295
 
4296
4296
  /**
4297
- * Zod schema describing geo-location properties associated with an event.
4297
+ * Zod schema describing geo-location properties for an event or singular profile request.
4298
4298
  *
4299
4299
  * @remarks
4300
4300
  * All properties are optional and can be derived from IP or device data.
@@ -4766,9 +4766,7 @@ export declare const InsightsEvent: z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject
4766
4766
  entityId: z.ZodMiniString<string>;
4767
4767
  entityKind: z.ZodMiniEnum<{
4768
4768
  Experience: "Experience";
4769
- Fragment: "Fragment";
4770
- InlineFragment: "InlineFragment";
4771
- InlineComponent: "InlineComponent";
4769
+ ExperienceFragment: "ExperienceFragment";
4772
4770
  }>;
4773
4771
  entityKindId: z.ZodMiniOptional<z.ZodMiniString<string>>;
4774
4772
  entryIds: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
@@ -4838,9 +4836,7 @@ export declare const InsightsEvent: z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject
4838
4836
  entityId: z.ZodMiniString<string>;
4839
4837
  entityKind: z.ZodMiniEnum<{
4840
4838
  Experience: "Experience";
4841
- Fragment: "Fragment";
4842
- InlineFragment: "InlineFragment";
4843
- InlineComponent: "InlineComponent";
4839
+ ExperienceFragment: "ExperienceFragment";
4844
4840
  }>;
4845
4841
  entityKindId: z.ZodMiniOptional<z.ZodMiniString<string>>;
4846
4842
  entryIds: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
@@ -4908,9 +4904,7 @@ export declare const InsightsEvent: z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject
4908
4904
  entityId: z.ZodMiniString<string>;
4909
4905
  entityKind: z.ZodMiniEnum<{
4910
4906
  Experience: "Experience";
4911
- Fragment: "Fragment";
4912
- InlineFragment: "InlineFragment";
4913
- InlineComponent: "InlineComponent";
4907
+ ExperienceFragment: "ExperienceFragment";
4914
4908
  }>;
4915
4909
  entityKindId: z.ZodMiniOptional<z.ZodMiniString<string>>;
4916
4910
  entryIds: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
@@ -5175,9 +5169,7 @@ export declare const InsightsEventArray: z.ZodMiniArray<z.ZodMiniDiscriminatedUn
5175
5169
  entityId: z.ZodMiniString<string>;
5176
5170
  entityKind: z.ZodMiniEnum<{
5177
5171
  Experience: "Experience";
5178
- Fragment: "Fragment";
5179
- InlineFragment: "InlineFragment";
5180
- InlineComponent: "InlineComponent";
5172
+ ExperienceFragment: "ExperienceFragment";
5181
5173
  }>;
5182
5174
  entityKindId: z.ZodMiniOptional<z.ZodMiniString<string>>;
5183
5175
  entryIds: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
@@ -5247,9 +5239,7 @@ export declare const InsightsEventArray: z.ZodMiniArray<z.ZodMiniDiscriminatedUn
5247
5239
  entityId: z.ZodMiniString<string>;
5248
5240
  entityKind: z.ZodMiniEnum<{
5249
5241
  Experience: "Experience";
5250
- Fragment: "Fragment";
5251
- InlineFragment: "InlineFragment";
5252
- InlineComponent: "InlineComponent";
5242
+ ExperienceFragment: "ExperienceFragment";
5253
5243
  }>;
5254
5244
  entityKindId: z.ZodMiniOptional<z.ZodMiniString<string>>;
5255
5245
  entryIds: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
@@ -5317,9 +5307,7 @@ export declare const InsightsEventArray: z.ZodMiniArray<z.ZodMiniDiscriminatedUn
5317
5307
  entityId: z.ZodMiniString<string>;
5318
5308
  entityKind: z.ZodMiniEnum<{
5319
5309
  Experience: "Experience";
5320
- Fragment: "Fragment";
5321
- InlineFragment: "InlineFragment";
5322
- InlineComponent: "InlineComponent";
5310
+ ExperienceFragment: "ExperienceFragment";
5323
5311
  }>;
5324
5312
  entityKindId: z.ZodMiniOptional<z.ZodMiniString<string>>;
5325
5313
  entryIds: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
@@ -75,9 +75,7 @@ const UniversalEventProperties = __rspack_external_zod_mini_edc6895a.object({
75
75
  });
76
76
  const ExoEntityKind = __rspack_external_zod_mini_edc6895a["enum"]([
77
77
  'Experience',
78
- 'Fragment',
79
- 'InlineFragment',
80
- 'InlineComponent'
78
+ 'ExperienceFragment'
81
79
  ]);
82
80
  const ExoEventProperties = __rspack_external_zod_mini_edc6895a.extend(UniversalEventProperties, {
83
81
  entityId: __rspack_external_zod_mini_edc6895a.string(),
@@ -159,7 +157,8 @@ const ExperienceEvent = __rspack_external_zod_mini_edc6895a.discriminatedUnion('
159
157
  ]);
160
158
  const ExperienceEventArray = __rspack_external_zod_mini_edc6895a.array(ExperienceEvent);
161
159
  const ExperienceRequestOptions = __rspack_external_zod_mini_edc6895a.object({
162
- features: __rspack_external_zod_mini_edc6895a.optional(__rspack_external_zod_mini_edc6895a.array(__rspack_external_zod_mini_edc6895a.string()))
160
+ features: __rspack_external_zod_mini_edc6895a.optional(__rspack_external_zod_mini_edc6895a.array(__rspack_external_zod_mini_edc6895a.string())),
161
+ location: __rspack_external_zod_mini_edc6895a.optional(GeoLocation)
163
162
  });
164
163
  const ExperienceRequestData = __rspack_external_zod_mini_edc6895a.object({
165
164
  events: ExperienceEventArray.check(__rspack_external_zod_mini_edc6895a.minLength(1)),
@@ -167,7 +166,9 @@ const ExperienceRequestData = __rspack_external_zod_mini_edc6895a.object({
167
166
  });
168
167
  const BatchExperienceRequestData = __rspack_external_zod_mini_edc6895a.object({
169
168
  events: BatchExperienceEventArray.check(__rspack_external_zod_mini_edc6895a.minLength(1)),
170
- options: __rspack_external_zod_mini_edc6895a.optional(ExperienceRequestOptions)
169
+ options: __rspack_external_zod_mini_edc6895a.optional(__rspack_external_zod_mini_edc6895a.omit(ExperienceRequestOptions, {
170
+ location: true
171
+ }))
171
172
  });
172
173
  const SessionStatistics = __rspack_external_zod_mini_edc6895a.object({
173
174
  id: __rspack_external_zod_mini_edc6895a.string(),