@ketch-sdk/ketch-types 1.24.0 → 1.24.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.
- package/dist/index.d.ts +92 -94
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -3117,175 +3117,175 @@ export interface PreferenceExperienceLayoutConfig {
|
|
|
3117
3117
|
subscriptions?: PreferenceSubscriptionsTabExperienceLayoutConfig;
|
|
3118
3118
|
requests?: PreferenceRequestsTabExperienceLayoutConfig;
|
|
3119
3119
|
}
|
|
3120
|
-
/** Top level experience layout config object
|
|
3120
|
+
/** Top level experience layout config object */
|
|
3121
3121
|
export interface ExperienceLayoutConfig {
|
|
3122
3122
|
banner?: BannerExperienceLayoutConfig;
|
|
3123
3123
|
modal?: ModalExperienceLayoutConfig;
|
|
3124
3124
|
preference?: PreferenceExperienceLayoutConfig;
|
|
3125
3125
|
}
|
|
3126
3126
|
/**
|
|
3127
|
-
* Experience V2
|
|
3127
|
+
* Experience V2 Content Config
|
|
3128
3128
|
*/
|
|
3129
|
-
/** Shared Experience
|
|
3129
|
+
/** Shared Experience Content Config Entities */
|
|
3130
3130
|
/** Banner/Modal Header */
|
|
3131
|
-
export interface
|
|
3131
|
+
export interface HeaderExperienceContentConfig {
|
|
3132
3132
|
title?: string;
|
|
3133
3133
|
}
|
|
3134
3134
|
/** Banner/Modal Footer */
|
|
3135
|
-
export interface
|
|
3135
|
+
export interface FooterExperienceContentConfig {
|
|
3136
3136
|
actionButtonText?: string;
|
|
3137
3137
|
}
|
|
3138
3138
|
/** Switch Buttons */
|
|
3139
|
-
export interface
|
|
3139
|
+
export interface SwitchButtonsExperienceContentConfig {
|
|
3140
3140
|
onText?: string;
|
|
3141
3141
|
offText?: string;
|
|
3142
3142
|
}
|
|
3143
3143
|
/** Text Block - A block of text with optional title */
|
|
3144
|
-
export interface
|
|
3144
|
+
export interface TextBlockTitleExperienceContentConfig {
|
|
3145
3145
|
text?: string;
|
|
3146
3146
|
}
|
|
3147
|
-
export interface
|
|
3148
|
-
title?:
|
|
3147
|
+
export interface TextBlockExperienceContentConfig {
|
|
3148
|
+
title?: TextBlockTitleExperienceContentConfig;
|
|
3149
3149
|
text?: string;
|
|
3150
3150
|
}
|
|
3151
|
-
export interface
|
|
3151
|
+
export interface PreferenceTabHeaderExperienceContentConfig {
|
|
3152
3152
|
description?: string;
|
|
3153
|
-
title?:
|
|
3153
|
+
title?: TextBlockTitleExperienceContentConfig;
|
|
3154
3154
|
}
|
|
3155
|
-
/** Banner Experience
|
|
3155
|
+
/** Banner Experience Content Config */
|
|
3156
3156
|
/** Banner Action Button */
|
|
3157
|
-
export interface
|
|
3157
|
+
export interface BannerActionButtonExperienceContentConfig {
|
|
3158
3158
|
text?: string;
|
|
3159
3159
|
}
|
|
3160
|
-
/** Banner Buttons Experience
|
|
3161
|
-
export interface
|
|
3162
|
-
primary?:
|
|
3163
|
-
secondary?:
|
|
3164
|
-
tertiary?:
|
|
3160
|
+
/** Banner Buttons Experience Content Config - Rightmost === primary */
|
|
3161
|
+
export interface BannerButtonsExperienceContentConfig {
|
|
3162
|
+
primary?: BannerActionButtonExperienceContentConfig;
|
|
3163
|
+
secondary?: BannerActionButtonExperienceContentConfig;
|
|
3164
|
+
tertiary?: BannerActionButtonExperienceContentConfig;
|
|
3165
3165
|
}
|
|
3166
|
-
export interface
|
|
3167
|
-
header?:
|
|
3166
|
+
export interface BannerExperienceContentConfig {
|
|
3167
|
+
header?: HeaderExperienceContentConfig;
|
|
3168
3168
|
description?: string;
|
|
3169
|
-
buttons?:
|
|
3170
|
-
footer?:
|
|
3169
|
+
buttons?: BannerButtonsExperienceContentConfig;
|
|
3170
|
+
footer?: FooterExperienceContentConfig;
|
|
3171
3171
|
}
|
|
3172
|
-
/** Modal Experience
|
|
3173
|
-
export interface
|
|
3172
|
+
/** Modal Experience Content Config */
|
|
3173
|
+
export interface ModalListHeaderExperienceContentConfig {
|
|
3174
3174
|
text?: string;
|
|
3175
3175
|
}
|
|
3176
|
-
export interface
|
|
3177
|
-
switchButtonLabels?:
|
|
3176
|
+
export interface ModalPurposeListExperienceContentConfig {
|
|
3177
|
+
switchButtonLabels?: SwitchButtonsExperienceContentConfig;
|
|
3178
3178
|
}
|
|
3179
|
-
export interface
|
|
3180
|
-
header?:
|
|
3181
|
-
description?:
|
|
3182
|
-
listHeader?:
|
|
3183
|
-
purposeList?:
|
|
3184
|
-
footer?:
|
|
3179
|
+
export interface ModalExperienceContentConfig {
|
|
3180
|
+
header?: HeaderExperienceContentConfig;
|
|
3181
|
+
description?: TextBlockExperienceContentConfig;
|
|
3182
|
+
listHeader?: ModalListHeaderExperienceContentConfig;
|
|
3183
|
+
purposeList?: ModalPurposeListExperienceContentConfig;
|
|
3184
|
+
footer?: FooterExperienceContentConfig;
|
|
3185
3185
|
}
|
|
3186
|
-
/** Preferences - Welcome Experience
|
|
3187
|
-
export interface
|
|
3186
|
+
/** Preferences - Welcome Experience Content Config */
|
|
3187
|
+
export interface WelcomeTabHeaderExperienceContentConfig {
|
|
3188
3188
|
title?: string;
|
|
3189
3189
|
}
|
|
3190
|
-
export interface
|
|
3190
|
+
export interface WelcomeTabNavigationExperienceContentConfig {
|
|
3191
3191
|
welcomeTitle?: string;
|
|
3192
3192
|
privacyPolicyTitle?: string;
|
|
3193
3193
|
purposesTitle?: string;
|
|
3194
3194
|
subscriptionsTitle?: string;
|
|
3195
3195
|
requestsTitle?: string;
|
|
3196
3196
|
}
|
|
3197
|
-
export interface
|
|
3197
|
+
export interface WelcomeTabWelcomeMsgExperienceContentConfig {
|
|
3198
3198
|
title?: string;
|
|
3199
3199
|
subtitle?: string;
|
|
3200
3200
|
}
|
|
3201
|
-
export interface
|
|
3201
|
+
export interface QuickLinkExperienceContentConfig {
|
|
3202
3202
|
text?: string;
|
|
3203
3203
|
}
|
|
3204
|
-
export interface
|
|
3205
|
-
links?:
|
|
3204
|
+
export interface WelcomeTabQuickLinksExperienceContentConfig {
|
|
3205
|
+
links?: QuickLinkExperienceContentConfig[];
|
|
3206
3206
|
}
|
|
3207
|
-
export interface
|
|
3207
|
+
export interface WelcomeTabAboutExperienceContentConfig {
|
|
3208
3208
|
title?: string;
|
|
3209
3209
|
description?: string;
|
|
3210
3210
|
}
|
|
3211
|
-
export interface
|
|
3212
|
-
header?:
|
|
3213
|
-
navigation?:
|
|
3214
|
-
footer?:
|
|
3215
|
-
welcomeMsg?:
|
|
3216
|
-
quickLinks?:
|
|
3217
|
-
about?:
|
|
3211
|
+
export interface PreferenceWelcomeTabExperienceContentConfig {
|
|
3212
|
+
header?: WelcomeTabHeaderExperienceContentConfig;
|
|
3213
|
+
navigation?: WelcomeTabNavigationExperienceContentConfig;
|
|
3214
|
+
footer?: FooterExperienceContentConfig;
|
|
3215
|
+
welcomeMsg?: WelcomeTabWelcomeMsgExperienceContentConfig;
|
|
3216
|
+
quickLinks?: WelcomeTabQuickLinksExperienceContentConfig;
|
|
3217
|
+
about?: WelcomeTabAboutExperienceContentConfig;
|
|
3218
3218
|
}
|
|
3219
|
-
/** Preferences - Purposes Experience
|
|
3220
|
-
export interface
|
|
3219
|
+
/** Preferences - Purposes Experience Content Config */
|
|
3220
|
+
export interface PurposesTabListHeaderExperienceContentConfig {
|
|
3221
3221
|
title?: string;
|
|
3222
3222
|
}
|
|
3223
|
-
export interface
|
|
3224
|
-
switchButtonLabels?:
|
|
3223
|
+
export interface PurposesTabListExperienceContentConfig {
|
|
3224
|
+
switchButtonLabels?: SwitchButtonsExperienceContentConfig;
|
|
3225
3225
|
}
|
|
3226
|
-
export interface
|
|
3227
|
-
header?:
|
|
3228
|
-
listHeader?:
|
|
3229
|
-
list?:
|
|
3226
|
+
export interface PreferencePurposesTabExperienceContentConfig {
|
|
3227
|
+
header?: PreferenceTabHeaderExperienceContentConfig;
|
|
3228
|
+
listHeader?: PurposesTabListHeaderExperienceContentConfig;
|
|
3229
|
+
list?: PurposesTabListExperienceContentConfig;
|
|
3230
3230
|
actionButtonText?: string;
|
|
3231
3231
|
}
|
|
3232
|
-
/** Preferences - Subscriptions Experience
|
|
3233
|
-
export interface
|
|
3232
|
+
/** Preferences - Subscriptions Experience Content Config */
|
|
3233
|
+
export interface SubscriptionsTabUnsubscribeAllExperienceContentConfig {
|
|
3234
3234
|
title?: string;
|
|
3235
3235
|
description?: string;
|
|
3236
|
-
switchLabels?:
|
|
3236
|
+
switchLabels?: SwitchButtonsExperienceContentConfig;
|
|
3237
3237
|
}
|
|
3238
|
-
export interface
|
|
3239
|
-
header?:
|
|
3240
|
-
unsubscribeAll?:
|
|
3241
|
-
listSwitchLabels?:
|
|
3238
|
+
export interface PreferenceSubscriptionsTabExperienceContentConfig {
|
|
3239
|
+
header?: PreferenceTabHeaderExperienceContentConfig;
|
|
3240
|
+
unsubscribeAll?: SubscriptionsTabUnsubscribeAllExperienceContentConfig;
|
|
3241
|
+
listSwitchLabels?: SwitchButtonsExperienceContentConfig;
|
|
3242
3242
|
actionButtonText?: string;
|
|
3243
3243
|
}
|
|
3244
|
-
/** Preferences - Requests Experience
|
|
3245
|
-
export interface
|
|
3244
|
+
/** Preferences - Requests Experience Content Config */
|
|
3245
|
+
export interface RequestsTabDsrLinkExperienceContentConfig {
|
|
3246
3246
|
title?: string;
|
|
3247
3247
|
subtitle?: string;
|
|
3248
3248
|
}
|
|
3249
|
-
export interface
|
|
3249
|
+
export interface RightsTitleExperienceContentConfig {
|
|
3250
3250
|
title?: string;
|
|
3251
3251
|
}
|
|
3252
|
-
export interface
|
|
3252
|
+
export interface RightsRequestTypesExperienceContentConfig {
|
|
3253
3253
|
provideData: string;
|
|
3254
3254
|
deleteData: string;
|
|
3255
3255
|
restrictProcessing: string;
|
|
3256
3256
|
updateData: string;
|
|
3257
3257
|
}
|
|
3258
|
-
export interface
|
|
3259
|
-
title?:
|
|
3260
|
-
requestTypes?:
|
|
3258
|
+
export interface RequestsTabRightsExperienceContentConfig {
|
|
3259
|
+
title?: RightsTitleExperienceContentConfig;
|
|
3260
|
+
requestTypes?: RightsRequestTypesExperienceContentConfig;
|
|
3261
3261
|
}
|
|
3262
|
-
export interface
|
|
3263
|
-
header?:
|
|
3264
|
-
dsrPortalLink?:
|
|
3265
|
-
rights?:
|
|
3262
|
+
export interface RequestsTabHomeExperienceContentConfig {
|
|
3263
|
+
header?: PreferenceTabHeaderExperienceContentConfig;
|
|
3264
|
+
dsrPortalLink?: RequestsTabDsrLinkExperienceContentConfig;
|
|
3265
|
+
rights?: RequestsTabRightsExperienceContentConfig;
|
|
3266
3266
|
}
|
|
3267
|
-
export interface
|
|
3267
|
+
export interface RequestsTabRightFormExperienceContentConfig {
|
|
3268
3268
|
recaptchaFailureText?: string;
|
|
3269
3269
|
}
|
|
3270
|
-
export interface
|
|
3270
|
+
export interface RequestsTabSubmittedExperienceContentConfig {
|
|
3271
3271
|
title?: string;
|
|
3272
3272
|
subtitle?: string;
|
|
3273
3273
|
description?: string;
|
|
3274
3274
|
actionButtonText?: string;
|
|
3275
3275
|
}
|
|
3276
|
-
export interface
|
|
3277
|
-
home?:
|
|
3278
|
-
rightForm?:
|
|
3279
|
-
submitted?:
|
|
3276
|
+
export interface PreferenceRequestsTabExperienceContentConfig {
|
|
3277
|
+
home?: RequestsTabHomeExperienceContentConfig;
|
|
3278
|
+
rightForm?: RequestsTabRightFormExperienceContentConfig;
|
|
3279
|
+
submitted?: RequestsTabSubmittedExperienceContentConfig;
|
|
3280
3280
|
}
|
|
3281
|
-
export interface
|
|
3282
|
-
welcome?:
|
|
3283
|
-
purposes?:
|
|
3284
|
-
subscriptions?:
|
|
3285
|
-
requests?:
|
|
3281
|
+
export interface PreferenceExperienceContentConfig {
|
|
3282
|
+
welcome?: PreferenceWelcomeTabExperienceContentConfig;
|
|
3283
|
+
purposes?: PreferencePurposesTabExperienceContentConfig;
|
|
3284
|
+
subscriptions?: PreferenceSubscriptionsTabExperienceContentConfig;
|
|
3285
|
+
requests?: PreferenceRequestsTabExperienceContentConfig;
|
|
3286
3286
|
}
|
|
3287
3287
|
/** Static text */
|
|
3288
|
-
export interface
|
|
3288
|
+
export interface StaticContentConfig {
|
|
3289
3289
|
powered_by?: string;
|
|
3290
3290
|
purpose?: string;
|
|
3291
3291
|
reject_all?: string;
|
|
@@ -3562,20 +3562,18 @@ export interface StaticTranslationConfig {
|
|
|
3562
3562
|
verification?: string;
|
|
3563
3563
|
and?: string;
|
|
3564
3564
|
}
|
|
3565
|
-
/** Top level experience
|
|
3566
|
-
export interface
|
|
3567
|
-
banner?:
|
|
3568
|
-
modal?:
|
|
3569
|
-
preference?:
|
|
3570
|
-
static?:
|
|
3565
|
+
/** Top level experience content config objects */
|
|
3566
|
+
export interface ExperienceContentConfig {
|
|
3567
|
+
banner?: BannerExperienceContentConfig;
|
|
3568
|
+
modal?: ModalExperienceContentConfig;
|
|
3569
|
+
preference?: PreferenceExperienceContentConfig;
|
|
3570
|
+
static?: StaticContentConfig;
|
|
3571
3571
|
}
|
|
3572
3572
|
/**
|
|
3573
3573
|
* Experience V2 config
|
|
3574
3574
|
*/
|
|
3575
3575
|
export interface ExperienceConfig {
|
|
3576
3576
|
layout?: ExperienceLayoutConfig;
|
|
3577
|
-
|
|
3578
|
-
[locale: string]: ExperienceTranslationConfig;
|
|
3579
|
-
};
|
|
3577
|
+
content?: ExperienceContentConfig;
|
|
3580
3578
|
}
|
|
3581
3579
|
export { ExperienceFormField, FormFieldDropdownOption, FormFieldWidth, FormFieldCategory, FormFieldType, FormFieldVariant, CanonicalRightForm, CustomRightForm, FormSection, FormTemplate, } from './forms';
|