@useinsider/guido 3.8.0-beta.84f6c0a → 3.8.0-beta.bf9ea20
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/config/compiler/utils/recommendationCompilerUtils.js +25 -19
- package/dist/extensions/Blocks/Items/block.js +48 -29
- package/dist/extensions/Blocks/Items/utils/nodeConfigUtils.js +62 -45
- package/dist/extensions/Blocks/Recommendation/constants/selectors.js +10 -11
- package/dist/extensions/Blocks/Recommendation/controls/main/index.js +26 -24
- package/dist/extensions/Blocks/Recommendation/controls/main/layoutOrientation.js +39 -30
- package/dist/extensions/Blocks/Recommendation/controls/main/productLayout.js +34 -28
- package/dist/extensions/Blocks/Recommendation/controls/main/utils.js +333 -285
- package/dist/extensions/Blocks/Recommendation/extension.js +5 -6
- package/dist/extensions/Blocks/Recommendation/settingsPanel.js +2 -3
- package/dist/extensions/Blocks/Recommendation/templates/grid/elementRenderer.js +173 -142
- package/dist/extensions/Blocks/Recommendation/templates/grid/template.js +30 -56
- package/dist/extensions/Blocks/Recommendation/templates/index.js +8 -29
- package/dist/extensions/Blocks/Recommendation/templates/list/elementRenderer.js +105 -132
- package/dist/extensions/Blocks/Recommendation/templates/list/template.js +23 -44
- package/dist/extensions/Blocks/Recommendation/templates/utils.js +64 -112
- package/dist/extensions/Blocks/Recommendation/utils/preserveTextStyles.js +19 -24
- package/dist/extensions/Blocks/Recommendation/utils/tagName.js +22 -30
- package/dist/extensions/Blocks/controlFactories.js +133 -159
- package/dist/src/extensions/Blocks/Items/block.d.ts +8 -0
- package/dist/src/extensions/Blocks/Items/controls/index.d.ts +1 -1
- package/dist/src/extensions/Blocks/Items/utils/nodeConfigUtils.d.ts +1 -1
- package/dist/src/extensions/Blocks/Recommendation/constants/index.d.ts +1 -1
- package/dist/src/extensions/Blocks/Recommendation/constants/selectors.d.ts +0 -2
- package/dist/src/extensions/Blocks/Recommendation/controls/button/index.d.ts +1 -1
- package/dist/src/extensions/Blocks/Recommendation/controls/main/layoutOrientation.d.ts +1 -2
- package/dist/src/extensions/Blocks/Recommendation/controls/main/utils.d.ts +47 -20
- package/dist/src/extensions/Blocks/Recommendation/templates/grid/template.d.ts +4 -4
- package/dist/src/extensions/Blocks/Recommendation/templates/index.d.ts +1 -1
- package/dist/src/extensions/Blocks/Recommendation/templates/list/template.d.ts +2 -3
- package/dist/src/extensions/Blocks/Recommendation/templates/utils.d.ts +11 -165
- package/dist/src/extensions/Blocks/Recommendation/utils/preserveTextStyles.d.ts +0 -15
- package/dist/src/extensions/Blocks/Recommendation/utils/stylePreserver.d.ts +113 -0
- package/dist/src/extensions/Blocks/Recommendation/utils/tagName.d.ts +9 -29
- package/dist/src/extensions/Blocks/controlFactories.d.ts +1 -11
- package/package.json +1 -1
- package/dist/extensions/Blocks/Recommendation/utils/captureStyleTemplates.js +0 -219
- package/dist/src/extensions/Blocks/Recommendation/utils/captureStyleTemplates.d.ts +0 -78
|
@@ -60,17 +60,39 @@ export interface RegenerateProductRowsOptions {
|
|
|
60
60
|
composition?: string[];
|
|
61
61
|
}
|
|
62
62
|
/**
|
|
63
|
-
* Regenerates only the mobile product container rows
|
|
64
|
-
*
|
|
65
|
-
*
|
|
66
|
-
* apply-free accumulateMobileProductRows() so the whole rebuild is one commit.
|
|
63
|
+
* Regenerates only the mobile product container rows.
|
|
64
|
+
* Used when mobile-specific settings change (mobileCardsInRow)
|
|
65
|
+
* or when the desktop container is regenerated (to keep both in sync).
|
|
67
66
|
*
|
|
68
|
-
* For list layout
|
|
69
|
-
* For grid layout with mobileLayoutEnabled
|
|
67
|
+
* For list layout: clears the mobile row content (list rows are inherently responsive).
|
|
68
|
+
* For grid layout with mobileLayoutEnabled OFF: clears the mobile row content.
|
|
69
|
+
* For grid layout with mobileLayoutEnabled ON: rebuilds the full mobile row
|
|
70
|
+
* structure (<td><table>...products...</table></td>) in a single operation.
|
|
70
71
|
*/
|
|
71
72
|
export declare function regenerateMobileProductRows(options: Omit<RegenerateProductRowsOptions, 'afterRegenerate'>): void;
|
|
73
|
+
/**
|
|
74
|
+
* Regenerates product rows in the desktop container based on current store configuration.
|
|
75
|
+
* Also regenerates the mobile container to keep both in sync.
|
|
76
|
+
* Reads products, layout, and composition from store/DOM and rebuilds the HTML.
|
|
77
|
+
* @param options - Configuration options for regeneration
|
|
78
|
+
*/
|
|
79
|
+
export declare function regenerateProductRows(options: RegenerateProductRowsOptions): void;
|
|
80
|
+
export interface ReapplySpacingOptions {
|
|
81
|
+
currentNode: ImmutableHtmlNode | null | undefined;
|
|
82
|
+
documentModifier: DocumentModifier;
|
|
83
|
+
}
|
|
84
|
+
/**
|
|
85
|
+
* Reapplies spacing values after product regeneration.
|
|
86
|
+
* Desktop spacing applies only to the desktop container;
|
|
87
|
+
* mobile spacing applies only to the mobile container.
|
|
88
|
+
*
|
|
89
|
+
* Reads values from node config (primary) with data-attribute fallback
|
|
90
|
+
* for backward compatibility with pre-nodeConfig templates.
|
|
91
|
+
* @param options - Configuration options
|
|
92
|
+
*/
|
|
93
|
+
export declare function reapplySpacing(options: ReapplySpacingOptions): void;
|
|
72
94
|
export interface RegenerateWithStylesOptions extends Omit<RegenerateProductRowsOptions, 'products' | 'layout'> {
|
|
73
|
-
/** Skip style capture if styles were already handled externally */
|
|
95
|
+
/** Skip style capture/restore if styles were already handled externally */
|
|
74
96
|
skipStylePreservation?: boolean;
|
|
75
97
|
/** Optional: pass products directly instead of reading from store */
|
|
76
98
|
products?: RecommendationProduct[];
|
|
@@ -78,21 +100,26 @@ export interface RegenerateWithStylesOptions extends Omit<RegenerateProductRowsO
|
|
|
78
100
|
layout?: Orientation;
|
|
79
101
|
}
|
|
80
102
|
/**
|
|
81
|
-
* Regenerates product rows while preserving user-applied styles
|
|
103
|
+
* Regenerates product rows while preserving user-applied styles
|
|
104
|
+
*
|
|
105
|
+
* This unified function handles the complete regeneration flow:
|
|
106
|
+
* 1. Captures existing styles (fonts, colors, button styles, etc.)
|
|
107
|
+
* 2. Regenerates HTML with new products/layout
|
|
108
|
+
* 3. Restores captured styles to new elements
|
|
109
|
+
* 4. Reapplies spacing from data attributes
|
|
82
110
|
*
|
|
83
|
-
*
|
|
84
|
-
*
|
|
85
|
-
*
|
|
86
|
-
*
|
|
87
|
-
* baked straight into the generated HTML.
|
|
88
|
-
* 3. Commit everything with ONE apply().
|
|
111
|
+
* NOTE: Style restoration is temporarily disabled due to Stripo selection bug.
|
|
112
|
+
* Multiple apply() calls (setInnerHtml + restoreStyles + reapplySpacing) cause
|
|
113
|
+
* Stripo's internal cursor/selection tracking to lose node references, resulting in
|
|
114
|
+
* "Cannot read properties of undefined (reading 'textContent')" errors.
|
|
89
115
|
*
|
|
90
|
-
*
|
|
91
|
-
*
|
|
92
|
-
*
|
|
93
|
-
*
|
|
94
|
-
*
|
|
95
|
-
*
|
|
116
|
+
* Use this instead of `regenerateProductRows` when styles must be preserved.
|
|
117
|
+
* @example
|
|
118
|
+
* // When products change (API response, count change, layout change)
|
|
119
|
+
* regenerateProductRowsWithStyles({
|
|
120
|
+
* currentNode: this.currentNode,
|
|
121
|
+
* documentModifier: this.api.getDocumentModifier(),
|
|
122
|
+
* });
|
|
96
123
|
* @param options - Configuration options for regeneration
|
|
97
124
|
*/
|
|
98
125
|
export declare function regenerateProductRowsWithStyles(options: RegenerateWithStylesOptions): void;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { FiltersResponse, RecommendationProduct } from '@@/Types/recommendation';
|
|
2
|
-
import { type ElementRenderer
|
|
2
|
+
import { type ElementRenderer } from '../utils';
|
|
3
3
|
/**
|
|
4
4
|
* Generates attribute-aligned product rows for grid layout.
|
|
5
5
|
* Creates rows where each row contains one attribute type from all products.
|
|
@@ -9,7 +9,7 @@ import { type ElementRenderer, type RenderOptions } from '../utils';
|
|
|
9
9
|
* @param composition - Array defining order of card elements
|
|
10
10
|
* @returns HTML string for attribute-aligned rows
|
|
11
11
|
*/
|
|
12
|
-
export declare function prepareGridAttributeRows(products: RecommendationProduct[], productsPerRow: number, elementRenderer: ElementRenderer, composition?: string[], filterList?: FiltersResponse
|
|
12
|
+
export declare function prepareGridAttributeRows(products: RecommendationProduct[], productsPerRow: number, elementRenderer: ElementRenderer, composition?: string[], filterList?: FiltersResponse): string;
|
|
13
13
|
/**
|
|
14
14
|
* Prepares grid product rows with attribute-aligned structure
|
|
15
15
|
* Groups products into rows, then generates attribute-aligned HTML for each group
|
|
@@ -19,7 +19,7 @@ export declare function prepareGridAttributeRows(products: RecommendationProduct
|
|
|
19
19
|
* @param composition - Array defining order of card elements
|
|
20
20
|
* @returns HTML string for all product rows
|
|
21
21
|
*/
|
|
22
|
-
export declare function prepareGridProductRows(products: RecommendationProduct[], productsPerRow: number, elementRenderer: ElementRenderer, composition?: string[], filterList?: FiltersResponse
|
|
22
|
+
export declare function prepareGridProductRows(products: RecommendationProduct[], productsPerRow: number, elementRenderer: ElementRenderer, composition?: string[], filterList?: FiltersResponse): string;
|
|
23
23
|
/**
|
|
24
24
|
* Prepares grid product rows with attribute-aligned structure.
|
|
25
25
|
* Uses row-based rendering where each attribute type forms a single row across all products.
|
|
@@ -28,6 +28,6 @@ export declare function prepareGridProductRows(products: RecommendationProduct[]
|
|
|
28
28
|
* @param composition - Array defining element order
|
|
29
29
|
* @returns HTML string for product rows
|
|
30
30
|
*/
|
|
31
|
-
export declare function prepareProductRows(products: RecommendationProduct[], productsPerRow: number, composition?: string[], filterList?: FiltersResponse
|
|
31
|
+
export declare function prepareProductRows(products: RecommendationProduct[], productsPerRow: number, composition?: string[], filterList?: FiltersResponse): string;
|
|
32
32
|
export declare function getDefaultTemplate(recommendationId?: number): string;
|
|
33
33
|
export declare function generateBlockTemplate(products: RecommendationProduct[], productsPerRow: number, title?: string, composition?: string[], mobileProductsPerRow?: number): string;
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
*/
|
|
7
7
|
import type { RecommendationProduct } from '@@/Types/recommendation';
|
|
8
8
|
import { type Orientation, type PrepareProductRowsOptions } from './utils';
|
|
9
|
-
export { DEFAULTS, DEFAULT_CARD_COMPOSITION, DEFAULT_CARD_VISIBILITY, getDefaultProducts, spacer, sanitizeImageUrl, createBlockTemplate, toDisplayableAttributeValue, type Orientation, type PrepareProductRowsOptions, type ElementRenderer, type ProductCardGetter,
|
|
9
|
+
export { DEFAULTS, DEFAULT_CARD_COMPOSITION, DEFAULT_CARD_VISIBILITY, getDefaultProducts, spacer, sanitizeImageUrl, createBlockTemplate, toDisplayableAttributeValue, type Orientation, type PrepareProductRowsOptions, type ElementRenderer, type ProductCardGetter, } from './utils';
|
|
10
10
|
/**
|
|
11
11
|
* Unified function to prepare product rows for any layout.
|
|
12
12
|
* Delegates to the appropriate layout-specific implementation.
|
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import type { FiltersResponse, RecommendationProduct } from '@@/Types/recommendation';
|
|
2
|
-
import { type RenderOptions } from '../utils';
|
|
3
2
|
/**
|
|
4
3
|
* Generates a list product card with 3-column layout
|
|
5
4
|
* Uses buildElementRenderer to render Image, Info content, and Button
|
|
@@ -12,7 +11,7 @@ import { type RenderOptions } from '../utils';
|
|
|
12
11
|
* @param composition - Array defining order of card elements
|
|
13
12
|
* @returns HTML string for a single product card row
|
|
14
13
|
*/
|
|
15
|
-
export declare function getListProductCard(product: RecommendationProduct, composition?: string[], filterList?: FiltersResponse
|
|
14
|
+
export declare function getListProductCard(product: RecommendationProduct, composition?: string[], filterList?: FiltersResponse): string;
|
|
16
15
|
/**
|
|
17
16
|
* Prepares list product rows
|
|
18
17
|
* Each product is a full-width row with 3-column layout
|
|
@@ -20,6 +19,6 @@ export declare function getListProductCard(product: RecommendationProduct, compo
|
|
|
20
19
|
* @param composition - Array defining order of card elements
|
|
21
20
|
* @returns HTML string for product rows
|
|
22
21
|
*/
|
|
23
|
-
export declare function prepareProductRows(products: RecommendationProduct[], composition?: string[], filterList?: FiltersResponse
|
|
22
|
+
export declare function prepareProductRows(products: RecommendationProduct[], composition?: string[], filterList?: FiltersResponse): string;
|
|
24
23
|
export declare function getDefaultTemplate(): string;
|
|
25
24
|
export declare function generateBlockTemplate(products: RecommendationProduct[], title?: string, composition?: string[]): string;
|
|
@@ -25,20 +25,13 @@ export declare function isDefaultAttribute(attrName: string, filterList: Filters
|
|
|
25
25
|
* - Product attributes → "product_attribute.<name>" (e.g., "product_attribute.rating_star")
|
|
26
26
|
*/
|
|
27
27
|
export declare function resolveProductAttrValue(attrName: string, filterList: FiltersResponse): string;
|
|
28
|
-
/**
|
|
29
|
-
* Reverse of `resolveProductAttrValue`: maps a cell's `product-attr` value back to its
|
|
30
|
-
* `customAttr:<name>` composition key. The resolver only ever emits `<name>` (default
|
|
31
|
-
* attribute) or `product_attribute.<name>` (custom product attribute), so stripping the
|
|
32
|
-
* prefix recovers the attribute name without needing the store's filter list.
|
|
33
|
-
*/
|
|
34
|
-
export declare function toCustomCompositionKey(productAttrValue: string): string;
|
|
35
28
|
/**
|
|
36
29
|
* Callback that generates the cell HTML for a custom product attribute.
|
|
37
30
|
* Layout-specific: grid returns `<td>…`, list returns `<tr><td>…</td></tr>`.
|
|
38
31
|
* @param productAttrValue - The resolved `product-attr` value (e.g., "brand" or "product_attribute.rating_star")
|
|
39
32
|
* @param content - The display content for the cell
|
|
40
33
|
*/
|
|
41
|
-
export type CustomCellHtmlGetter = (productAttrValue: string, content: string
|
|
34
|
+
export type CustomCellHtmlGetter = (productAttrValue: string, content: string) => string;
|
|
42
35
|
/**
|
|
43
36
|
* Symbol key for embedding custom attribute HTML in an ElementRenderer.
|
|
44
37
|
* Grid and list renderers store their custom-attribute cell template under this key
|
|
@@ -61,99 +54,10 @@ export declare const CUSTOM_CELL_HTML: unique symbol;
|
|
|
61
54
|
*/
|
|
62
55
|
export declare function buildElementRenderer(baseRenderer: ElementRenderer, composition: string[], filterList?: FiltersResponse): ElementRenderer;
|
|
63
56
|
export type Orientation = 'list' | 'grid';
|
|
64
|
-
/**
|
|
65
|
-
* A captured "style template" for one text attribute, used to bake user-applied
|
|
66
|
-
* styling back into regenerated HTML in a SINGLE setInnerHtml/apply pass.
|
|
67
|
-
*
|
|
68
|
-
* Stripo applies inline formats as TAGS (`<strong>`, `<em>`, `<s>`), not CSS, so we
|
|
69
|
-
* preserve the actual wrapper tags around the text — re-emitting `text-decoration`
|
|
70
|
-
* CSS would render a strike that Stripo's own toggle can't detect. `pStyle` carries
|
|
71
|
-
* the `<p>`-level inline CSS (font-size/color/align/etc.).
|
|
72
|
-
*/
|
|
73
|
-
export interface AttributeStyleTemplate {
|
|
74
|
-
/** Raw inline style for the `<p>`, e.g. "font-size: 18px; color: #111;" */
|
|
75
|
-
pStyle?: string;
|
|
76
|
-
/** Opening inline-format tags captured around the text (or button label), e.g. "<strong><em>" */
|
|
77
|
-
openTags?: string;
|
|
78
|
-
/** Matching closing tags in reverse order, e.g. "</em></strong>" */
|
|
79
|
-
closeTags?: string;
|
|
80
|
-
/** Button: inline style of the `<span class="es-button-border">` (background/border/radius). */
|
|
81
|
-
buttonBorderStyle?: string;
|
|
82
|
-
/** Button: inline style of the `<a class="es-button">` (color/background/font/padding/width). */
|
|
83
|
-
buttonAnchorStyle?: string;
|
|
84
|
-
/** Button: whether "Fit to Container" is on (the `es-fw` class on the border span). */
|
|
85
|
-
buttonFitToContainer?: boolean;
|
|
86
|
-
/** Button: the user-edited label text (without wrapper tags), e.g. "Shop Now" instead of "Buy". */
|
|
87
|
-
buttonText?: string;
|
|
88
|
-
/** Image: inline style of the `<img>` (width/height/max-width/border-radius/margin). */
|
|
89
|
-
imgStyle?: string;
|
|
90
|
-
}
|
|
91
|
-
/** Per-attribute style templates keyed by ATTR_PRODUCT_* composition key. */
|
|
92
|
-
export type AttributeStyleTemplates = Record<string, AttributeStyleTemplate>;
|
|
93
|
-
/** Per-attribute "Block Background Color" values keyed by ATTR_PRODUCT_* composition key. */
|
|
94
|
-
export type CellBackgroundColors = Record<string, string>;
|
|
95
|
-
/** Per-attribute text alignment (the cell's `align` attribute) keyed by ATTR_PRODUCT_* composition key. */
|
|
96
|
-
export type CellAlignments = Record<string, string>;
|
|
97
|
-
/** Per-attribute preserved cell classes (padding `es-p*`, margin `es-m*`, text-trim) keyed by attr. */
|
|
98
|
-
export type CellClasses = Record<string, string>;
|
|
99
|
-
/** A user-edited omnibus prefix/suffix, e.g. before = "Lowest 30-day price: ". */
|
|
100
|
-
export interface OmnibusText {
|
|
101
|
-
before?: string;
|
|
102
|
-
after?: string;
|
|
103
|
-
}
|
|
104
|
-
/** Per-attribute omnibus before/after texts keyed by ATTR_PRODUCT_OMNIBUS_* composition key. */
|
|
105
|
-
export type OmnibusTexts = Record<string, OmnibusText>;
|
|
106
|
-
/** Per-attribute visibility (show/hide) keyed by ATTR_PRODUCT_* composition key. */
|
|
107
|
-
export type AttributeVisibility = Record<string, boolean>;
|
|
108
|
-
/**
|
|
109
|
-
* Per-cell rendering context passed to each ElementRenderer function so a single
|
|
110
|
-
* regeneration can bake column spacing and preserved styles directly into the HTML.
|
|
111
|
-
*/
|
|
112
|
-
export interface CellRenderOptions {
|
|
113
|
-
/** Column-spacing padding for the attribute cell, e.g. "0 7px". Falls back to DEFAULT_CELL_PADDING. */
|
|
114
|
-
cellPadding?: string;
|
|
115
|
-
/** Captured style template for this attribute (preserves user bold/italic/strike + p-style). */
|
|
116
|
-
styleTemplate?: AttributeStyleTemplate;
|
|
117
|
-
/** Card background color baked onto the `.product-card-segment` of every cell. */
|
|
118
|
-
cardBackgroundColor?: string;
|
|
119
|
-
/** This text attribute's "Block Background Color", baked onto its `[esd-extension-block-id]` cell. */
|
|
120
|
-
cellBackgroundColor?: string;
|
|
121
|
-
/** This text attribute's alignment, baked onto its `[esd-extension-block-id]` cell `align` attribute. */
|
|
122
|
-
cellAlignment?: string;
|
|
123
|
-
/** This cell's preserved spacing/text-trim classes, replacing the renderer's hardcoded `es-p*` defaults. */
|
|
124
|
-
cellClasses?: string;
|
|
125
|
-
/** Omnibus cell's user-edited before/after text, replacing the renderer's hardcoded prefix. */
|
|
126
|
-
omnibusText?: OmnibusText;
|
|
127
|
-
}
|
|
128
|
-
/**
|
|
129
|
-
* Spacing + preserved-style values baked into generated HTML so a regeneration
|
|
130
|
-
* needs only a single setInnerHtml/apply (no deferred reapply pass). Shared by the
|
|
131
|
-
* grid and list layout generators and by `PrepareProductRowsOptions`.
|
|
132
|
-
*/
|
|
133
|
-
export interface RenderOptions {
|
|
134
|
-
/** Column-spacing padding baked into product cells (grid) or the card wrapper (list), e.g. "0 7px". */
|
|
135
|
-
cellPadding?: string;
|
|
136
|
-
/** Row-spacing height in px baked into spacer rows between product rows. */
|
|
137
|
-
rowSpacingPx?: number;
|
|
138
|
-
/** Per-attribute captured style templates to preserve user styling across regeneration. */
|
|
139
|
-
styleTemplates?: AttributeStyleTemplates;
|
|
140
|
-
/** Card background color baked into the card containers (`.product-card-segment` / `.product-card-wrapper`). */
|
|
141
|
-
cardBackgroundColor?: string;
|
|
142
|
-
/** Per-attribute "Block Background Color" values baked onto each text cell across regeneration. */
|
|
143
|
-
cellBackgroundColors?: CellBackgroundColors;
|
|
144
|
-
/** Per-attribute text alignment baked onto each text cell's `align` attribute across regeneration. */
|
|
145
|
-
cellAlignments?: CellAlignments;
|
|
146
|
-
/** Per-attribute preserved cell classes (padding/margin/text-trim) re-baked across regeneration. */
|
|
147
|
-
cellClasses?: CellClasses;
|
|
148
|
-
/** Per-attribute omnibus before/after texts re-baked across regeneration. */
|
|
149
|
-
omnibusTexts?: OmnibusTexts;
|
|
150
|
-
/** Per-attribute visibility (show/hide) re-applied across regeneration; falls back to defaults. */
|
|
151
|
-
visibility?: AttributeVisibility;
|
|
152
|
-
}
|
|
153
57
|
/**
|
|
154
58
|
* Options for prepareProductRows unified function
|
|
155
59
|
*/
|
|
156
|
-
export interface PrepareProductRowsOptions
|
|
60
|
+
export interface PrepareProductRowsOptions {
|
|
157
61
|
/** Number of products per row (only for grid layout, defaults to 3) */
|
|
158
62
|
productsPerRow?: number;
|
|
159
63
|
/** Number of products per row on mobile (only for grid layout, defaults to 1) */
|
|
@@ -171,15 +75,15 @@ export interface PrepareProductRowsOptions extends RenderOptions {
|
|
|
171
75
|
* for custom attributes — used by `buildElementRenderer` to create custom entries.
|
|
172
76
|
*/
|
|
173
77
|
export interface ElementRenderer {
|
|
174
|
-
[ATTR_PRODUCT_IMAGE]: (product: RecommendationProduct
|
|
175
|
-
[ATTR_PRODUCT_NAME]: (product: RecommendationProduct
|
|
176
|
-
[ATTR_PRODUCT_PRICE]: (product: RecommendationProduct
|
|
177
|
-
[ATTR_PRODUCT_OLD_PRICE]: (product: RecommendationProduct
|
|
178
|
-
[ATTR_PRODUCT_OMNIBUS_PRICE]: (product: RecommendationProduct
|
|
179
|
-
[ATTR_PRODUCT_OMNIBUS_DISCOUNT]: (product: RecommendationProduct
|
|
180
|
-
[ATTR_PRODUCT_BUTTON]: (product: RecommendationProduct
|
|
78
|
+
[ATTR_PRODUCT_IMAGE]: (product: RecommendationProduct) => string;
|
|
79
|
+
[ATTR_PRODUCT_NAME]: (product: RecommendationProduct) => string;
|
|
80
|
+
[ATTR_PRODUCT_PRICE]: (product: RecommendationProduct) => string;
|
|
81
|
+
[ATTR_PRODUCT_OLD_PRICE]: (product: RecommendationProduct) => string;
|
|
82
|
+
[ATTR_PRODUCT_OMNIBUS_PRICE]: (product: RecommendationProduct) => string;
|
|
83
|
+
[ATTR_PRODUCT_OMNIBUS_DISCOUNT]: (product: RecommendationProduct) => string;
|
|
84
|
+
[ATTR_PRODUCT_BUTTON]: (product: RecommendationProduct) => string;
|
|
181
85
|
[CUSTOM_CELL_HTML]?: CustomCellHtmlGetter;
|
|
182
|
-
[key: string]: (product: RecommendationProduct
|
|
86
|
+
[key: string]: (product: RecommendationProduct) => string;
|
|
183
87
|
}
|
|
184
88
|
/**
|
|
185
89
|
* Product card getter function type
|
|
@@ -192,65 +96,7 @@ export declare const DEFAULTS: {
|
|
|
192
96
|
};
|
|
193
97
|
export declare const DEFAULT_CARD_COMPOSITION: string[];
|
|
194
98
|
export declare const DEFAULT_CARD_VISIBILITY: Record<string, boolean>;
|
|
195
|
-
|
|
196
|
-
export declare const DEFAULT_ROW_SPACING_PX = 10;
|
|
197
|
-
/**
|
|
198
|
-
* Builds a spacer row with the given height. Baking row spacing into the HTML lets
|
|
199
|
-
* regeneration use a single setInnerHtml/apply instead of a deferred reapply pass.
|
|
200
|
-
*/
|
|
201
|
-
export declare function buildSpacer(heightPx?: number): string;
|
|
202
|
-
export declare const spacer: string;
|
|
203
|
-
/**
|
|
204
|
-
* Resolves the `<p>` inline style for a text cell. When a captured template exists,
|
|
205
|
-
* it wins (even when empty — meaning the user cleared the style); otherwise the
|
|
206
|
-
* renderer's default style is used.
|
|
207
|
-
*/
|
|
208
|
-
export declare function resolvePStyle(defaultPStyle: string, template?: AttributeStyleTemplate): string;
|
|
209
|
-
/**
|
|
210
|
-
* Renders `<p>…text…</p>` for a text attribute, preserving captured inline-format
|
|
211
|
-
* tags (`<strong>`/`<em>`/`<s>`) and p-style when a template is supplied, or falling
|
|
212
|
-
* back to the renderer defaults. A present-but-empty template faithfully drops the
|
|
213
|
-
* default wrapper (e.g. the user removed bold).
|
|
214
|
-
*/
|
|
215
|
-
export declare function renderStyledParagraph(text: string, defaults: {
|
|
216
|
-
pStyle: string;
|
|
217
|
-
openTags: string;
|
|
218
|
-
closeTags: string;
|
|
219
|
-
}, template?: AttributeStyleTemplate): string;
|
|
220
|
-
/**
|
|
221
|
-
* Builds the inline style for a card container (`.product-card-segment` in grid,
|
|
222
|
-
* `.product-card-wrapper` in list), appending the captured card background color to any
|
|
223
|
-
* base style. Returns '' when there is nothing to set.
|
|
224
|
-
*/
|
|
225
|
-
export declare function resolveSegmentBgStyle(baseStyle: string, cardBackgroundColor?: string): string;
|
|
226
|
-
/**
|
|
227
|
-
* Builds the ` style="background-color: …"` attribute for a text attribute's
|
|
228
|
-
* `[esd-extension-block-id]` cell, baking in the captured "Block Background Color".
|
|
229
|
-
* Returns '' when there is nothing to set (the cell otherwise carries no inline style).
|
|
230
|
-
*/
|
|
231
|
-
export declare function cellBgStyleAttr(cellBackgroundColor?: string): string;
|
|
232
|
-
/** Resolves an omnibus cell's before/after text, falling back to the renderer's defaults. */
|
|
233
|
-
export declare function resolveOmnibusText(captured?: OmnibusText, defaultBefore?: string): Required<OmnibusText>;
|
|
234
|
-
/**
|
|
235
|
-
* Wraps a button label in the captured inline-format tags (bold/italic), or returns it
|
|
236
|
-
* plain. Mirrors text wrapper preservation for the button's `<a>` content.
|
|
237
|
-
*/
|
|
238
|
-
export declare function renderButtonLabel(label: string, template?: AttributeStyleTemplate): string;
|
|
239
|
-
/**
|
|
240
|
-
* Resolves the `<span class="es-button-border">` class, adding `es-fw` (full-width)
|
|
241
|
-
* when the captured template had "Fit to Container" on. Stripo applies fit via this
|
|
242
|
-
* class, not inline width, so we preserve the class across regeneration.
|
|
243
|
-
*/
|
|
244
|
-
export declare function resolveButtonBorderClass(template?: AttributeStyleTemplate): string;
|
|
245
|
-
/** Default inline style for the product image `<img>` (used when nothing is captured). */
|
|
246
|
-
export declare const DEFAULT_IMG_STYLE = "display: block; max-width: 100%; height: auto;";
|
|
247
|
-
/** Default inline style for the button `<span class="es-button-border">`. */
|
|
248
|
-
export declare const DEFAULT_BUTTON_BORDER_STYLE: string;
|
|
249
|
-
/**
|
|
250
|
-
* Default inline style for the button `<a class="es-button">`. The list layout appends its
|
|
251
|
-
* own `padding: 5px 30px;` on top of this shared base.
|
|
252
|
-
*/
|
|
253
|
-
export declare const DEFAULT_BUTTON_ANCHOR_STYLE: string;
|
|
99
|
+
export declare const spacer = "\n <tr>\n <td class=\"spacer\" style=\"height: 10px;\"></td>\n </tr>\n";
|
|
254
100
|
export declare const PLACEHOLDER_IMAGE = "https://email-static.useinsider.com/stripo/modules/email-recommendation-v3/assets/images/image-placeholder.png";
|
|
255
101
|
/**
|
|
256
102
|
* Sanitizes product image URLs for consistent rendering
|
|
@@ -1,19 +1,4 @@
|
|
|
1
1
|
import type { ImmutableHtmlNode } from '@stripoinc/ui-editor-extensions';
|
|
2
|
-
/**
|
|
3
|
-
* Extracts the nested inline-format wrapper tags around text content, outermost first.
|
|
4
|
-
*
|
|
5
|
-
* Stripo applies bold/italic/underline/strike as tags (`<strong>/<em>/<u>/<s>`), so to
|
|
6
|
-
* preserve user formatting across a text swap or block regeneration we capture the actual
|
|
7
|
-
* wrapper tags rather than CSS.
|
|
8
|
-
* @example
|
|
9
|
-
* // '<strong><em>Hi</em></strong>' → { openTags: '<strong><em>', closeTags: '</em></strong>' }
|
|
10
|
-
* @param html - The inner HTML to parse
|
|
11
|
-
* @returns The concatenated opening tags and matching closing tags (empty strings if none)
|
|
12
|
-
*/
|
|
13
|
-
export declare function extractWrapperTags(html: string): {
|
|
14
|
-
openTags: string;
|
|
15
|
-
closeTags: string;
|
|
16
|
-
};
|
|
17
2
|
/**
|
|
18
3
|
* Preserves existing style tags when updating text content
|
|
19
4
|
*
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Style Preserver Utility
|
|
3
|
+
*
|
|
4
|
+
* Captures and restores element styles during block regeneration.
|
|
5
|
+
* This ensures user styling is preserved when:
|
|
6
|
+
* - Layout changes (grid <-> list)
|
|
7
|
+
* - Cards per row changes
|
|
8
|
+
* - Composition order changes
|
|
9
|
+
*
|
|
10
|
+
* Works with the node config system to provide complete style persistence.
|
|
11
|
+
*/
|
|
12
|
+
import type { ImmutableHtmlNode } from '@stripoinc/ui-editor-extensions';
|
|
13
|
+
import { ModificationDescription } from '@stripoinc/ui-editor-extensions';
|
|
14
|
+
/**
|
|
15
|
+
* Style properties that can be captured for text elements
|
|
16
|
+
*/
|
|
17
|
+
export interface TextElementStyles {
|
|
18
|
+
fontSize?: string;
|
|
19
|
+
fontFamily?: string;
|
|
20
|
+
fontWeight?: string;
|
|
21
|
+
fontStyle?: string;
|
|
22
|
+
color?: string;
|
|
23
|
+
textAlign?: string;
|
|
24
|
+
lineHeight?: string;
|
|
25
|
+
textDecoration?: string;
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Style properties for button elements
|
|
29
|
+
*/
|
|
30
|
+
export interface ButtonElementStyles extends TextElementStyles {
|
|
31
|
+
backgroundColor?: string;
|
|
32
|
+
borderRadius?: string;
|
|
33
|
+
border?: string;
|
|
34
|
+
padding?: string;
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* Style properties for image elements
|
|
38
|
+
*/
|
|
39
|
+
export interface ImageElementStyles {
|
|
40
|
+
width?: string;
|
|
41
|
+
height?: string;
|
|
42
|
+
maxWidth?: string;
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Complete captured styles for a recommendation block
|
|
46
|
+
*/
|
|
47
|
+
export interface CapturedStyles {
|
|
48
|
+
/** Product name text styles */
|
|
49
|
+
name: TextElementStyles;
|
|
50
|
+
/** Current price text styles */
|
|
51
|
+
price: TextElementStyles;
|
|
52
|
+
/** Original/old price text styles */
|
|
53
|
+
oldPrice: TextElementStyles;
|
|
54
|
+
/** Omnibus price text styles */
|
|
55
|
+
omnibusPrice: TextElementStyles;
|
|
56
|
+
/** Omnibus discount text styles */
|
|
57
|
+
omnibusDiscount: TextElementStyles;
|
|
58
|
+
/** CTA button styles */
|
|
59
|
+
button: ButtonElementStyles;
|
|
60
|
+
/** Product image styles */
|
|
61
|
+
image: ImageElementStyles;
|
|
62
|
+
/** Card background color */
|
|
63
|
+
cardBackgroundColor: string | null;
|
|
64
|
+
/** Column spacing in pixels */
|
|
65
|
+
columnSpacing: number;
|
|
66
|
+
/** Row spacing in pixels */
|
|
67
|
+
rowSpacing: number;
|
|
68
|
+
/** Element composition order */
|
|
69
|
+
composition: string[];
|
|
70
|
+
/** Element visibility flags */
|
|
71
|
+
visibility: Record<string, boolean>;
|
|
72
|
+
}
|
|
73
|
+
type DocumentModifier = {
|
|
74
|
+
modifyHtml: (node: ImmutableHtmlNode) => {
|
|
75
|
+
setStyle: (prop: string, value: string) => DocumentModifier;
|
|
76
|
+
};
|
|
77
|
+
apply: (description: ModificationDescription) => void;
|
|
78
|
+
};
|
|
79
|
+
/**
|
|
80
|
+
* Capture all styles from a recommendation block
|
|
81
|
+
*
|
|
82
|
+
* Call this BEFORE any operation that regenerates the block HTML.
|
|
83
|
+
* The captured styles can then be restored after regeneration.
|
|
84
|
+
* @example
|
|
85
|
+
* // Before layout change
|
|
86
|
+
* const styles = captureStyles(this.currentNode);
|
|
87
|
+
*
|
|
88
|
+
* // ... regenerate block HTML ...
|
|
89
|
+
*
|
|
90
|
+
* // After regeneration
|
|
91
|
+
* restoreStyles(this.currentNode, this.api.getDocumentModifier(), styles);
|
|
92
|
+
* @param node - The block node to capture styles from
|
|
93
|
+
* @returns Complete captured styles object
|
|
94
|
+
*/
|
|
95
|
+
export declare function captureStyles(node: ImmutableHtmlNode | null | undefined): CapturedStyles;
|
|
96
|
+
/**
|
|
97
|
+
* Restore captured styles to a regenerated block
|
|
98
|
+
*
|
|
99
|
+
* Call this AFTER regenerating block HTML to reapply user styling.
|
|
100
|
+
* @example
|
|
101
|
+
* restoreStyles(this.currentNode, this.api.getDocumentModifier(), capturedStyles);
|
|
102
|
+
* @param node - The block node to restore styles to
|
|
103
|
+
* @param modifier - Document modifier for applying changes
|
|
104
|
+
* @param styles - Previously captured styles
|
|
105
|
+
*/
|
|
106
|
+
export declare function restoreStyles(node: ImmutableHtmlNode | null | undefined, modifier: DocumentModifier, styles: CapturedStyles): void;
|
|
107
|
+
/**
|
|
108
|
+
* Check if styles have meaningful content worth restoring
|
|
109
|
+
* @param styles - Captured styles to check
|
|
110
|
+
* @returns True if styles contain restorable content
|
|
111
|
+
*/
|
|
112
|
+
export declare function hasRestorableStyles(styles: CapturedStyles): boolean;
|
|
113
|
+
export {};
|
|
@@ -5,54 +5,33 @@
|
|
|
5
5
|
* Handles both standard DOM properties and Stripo's custom methods.
|
|
6
6
|
*/
|
|
7
7
|
import type { ImmutableHtmlNode } from '@stripoinc/ui-editor-extensions';
|
|
8
|
+
/** Interface for nodes with standard tagName property */
|
|
9
|
+
interface NodeWithTagName {
|
|
10
|
+
tagName: string;
|
|
11
|
+
}
|
|
8
12
|
/** Interface for nodes with getStyle method */
|
|
9
13
|
export interface NodeWithGetStyle {
|
|
10
14
|
getStyle: (property: string) => string | null | undefined;
|
|
11
15
|
}
|
|
12
|
-
/** Interface for nodes with getComputedStyle method */
|
|
13
|
-
export interface NodeWithGetComputedStyle {
|
|
14
|
-
getComputedStyle: (property: string) => string | null | undefined;
|
|
15
|
-
}
|
|
16
|
-
/** Interface for nodes with getAttribute method */
|
|
17
|
-
export interface NodeWithGetAttribute {
|
|
18
|
-
getAttribute: (name: string) => string | null;
|
|
19
|
-
}
|
|
20
16
|
/** Interface for nodes with parent method */
|
|
21
17
|
export interface NodeWithParent {
|
|
22
18
|
parent: () => ImmutableHtmlNode | null;
|
|
23
19
|
}
|
|
24
|
-
/** Interface for nodes with querySelectorAll method */
|
|
25
|
-
export interface NodeWithQuerySelectorAll {
|
|
26
|
-
querySelectorAll: (selector: string) => ImmutableHtmlNode[];
|
|
27
|
-
}
|
|
28
20
|
/**
|
|
29
21
|
* Type guard to check if a node has getStyle method
|
|
30
22
|
* @param node - The node to check
|
|
31
23
|
*/
|
|
32
24
|
export declare function hasGetStyle(node: unknown): node is NodeWithGetStyle;
|
|
33
25
|
/**
|
|
34
|
-
* Type guard to check if a node has
|
|
35
|
-
* This is the only read that sees a background applied by Stripo's built-in
|
|
36
|
-
* "Block Background Color" control — it writes neither an inline style nor a
|
|
37
|
-
* queryable stylesheet rule, but the computed value is still resolvable.
|
|
38
|
-
* @param node - The node to check
|
|
39
|
-
*/
|
|
40
|
-
export declare function hasGetComputedStyle(node: unknown): node is NodeWithGetComputedStyle;
|
|
41
|
-
/**
|
|
42
|
-
* Type guard to check if a node has getAttribute method
|
|
43
|
-
* @param node - The node to check
|
|
44
|
-
*/
|
|
45
|
-
export declare function hasGetAttribute(node: unknown): node is NodeWithGetAttribute;
|
|
46
|
-
/**
|
|
47
|
-
* Type guard to check if a node has querySelectorAll method
|
|
26
|
+
* Type guard to check if a node has parent method
|
|
48
27
|
* @param node - The node to check
|
|
49
28
|
*/
|
|
50
|
-
export declare function
|
|
29
|
+
export declare function hasParent(node: unknown): node is NodeWithParent;
|
|
51
30
|
/**
|
|
52
|
-
* Type guard to check if a node
|
|
31
|
+
* Type guard to check if a node is a TD element
|
|
53
32
|
* @param node - The node to check
|
|
54
33
|
*/
|
|
55
|
-
export declare function
|
|
34
|
+
export declare function isTdNode(node: unknown): node is ImmutableHtmlNode & NodeWithTagName;
|
|
56
35
|
/**
|
|
57
36
|
* Safely retrieves a style value from a node
|
|
58
37
|
* @param node - The node to get the style from
|
|
@@ -95,3 +74,4 @@ export declare function isTableCellNode(node: ImmutableHtmlNode | null | undefin
|
|
|
95
74
|
* @returns The CSS display value ('table-cell' or 'table-row')
|
|
96
75
|
*/
|
|
97
76
|
export declare function getTableDisplayValue(node: ImmutableHtmlNode | null | undefined): 'table-cell' | 'table-row';
|
|
77
|
+
export {};
|
|
@@ -280,21 +280,11 @@ export declare function createButtonTextStyleAndFontColorControl(controlId: stri
|
|
|
280
280
|
new (): {
|
|
281
281
|
getId(): string;
|
|
282
282
|
getTargetNodes(root: ImmutableHtmlNode): ImmutableHtmlNode[];
|
|
283
|
-
/**
|
|
284
|
-
* Propagates Bold/Italic to ALL product buttons, not just the focused one.
|
|
285
|
-
*
|
|
286
|
-
* Stripo's built-in applies font-color/size to every target node but writes
|
|
287
|
-
* the text-style (font-weight/font-style) only to the selected button. Bold/italic
|
|
288
|
-
* are plain inline CSS on the `<a class="es-button">` (no tags), so we mirror them
|
|
289
|
-
* onto every button's anchor. The toggle state comes from the control's form
|
|
290
|
-
* (`buttonTextStyleForm.{bold,italic}`) because the patched node isn't updated yet
|
|
291
|
-
* when this runs. Returned modifications are merged into the parent control's patch.
|
|
292
|
-
*/
|
|
293
|
-
getAdditionalModifications(root: ImmutableHtmlNode): import("@stripoinc/ui-editor-extensions").TemplateModifier<import("@stripoinc/ui-editor-extensions").HtmlNodeModifier, import("@stripoinc/ui-editor-extensions").CssNodeModifier> | undefined;
|
|
294
283
|
getParentControlId(): string;
|
|
295
284
|
getLabels(): import("@stripoinc/ui-editor-extensions").ButtonTextStyleAndFontColorControlLabels | undefined;
|
|
296
285
|
api: import("@stripoinc/ui-editor-extensions").ControlApi;
|
|
297
286
|
getModificationDescription(): import("@stripoinc/ui-editor-extensions").ModificationDescription | undefined;
|
|
287
|
+
getAdditionalModifications(_root: ImmutableHtmlNode): import("@stripoinc/ui-editor-extensions").TemplateModifier<import("@stripoinc/ui-editor-extensions").HtmlNodeModifier, import("@stripoinc/ui-editor-extensions").CssNodeModifier> | undefined;
|
|
298
288
|
isVisible(_node: ImmutableHtmlNode): boolean;
|
|
299
289
|
};
|
|
300
290
|
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@useinsider/guido",
|
|
3
|
-
"version": "3.8.0-beta.
|
|
3
|
+
"version": "3.8.0-beta.bf9ea20",
|
|
4
4
|
"description": "Guido is a Vue + TypeScript wrapper for Email Plugin. Easily embed the email editor in your Vue applications.",
|
|
5
5
|
"main": "./dist/guido.umd.cjs",
|
|
6
6
|
"module": "./dist/library.js",
|