@azzas/azzas-tracker-web 1.0.103 → 2.0.0-preview.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/mod.cjs +714 -129
- package/dist/mod.cjs.map +1 -1
- package/dist/mod.d.cts +1052 -217
- package/dist/mod.d.ts +1052 -217
- package/dist/mod.global.js +714 -129
- package/dist/mod.global.js.map +1 -1
- package/dist/mod.js +714 -129
- package/dist/mod.js.map +1 -1
- package/dist/mod.vtex.global.js +833 -165
- package/package.json +2 -2
package/dist/mod.d.ts
CHANGED
|
@@ -1,159 +1,159 @@
|
|
|
1
1
|
declare const EVENTS: {
|
|
2
2
|
CUSTOM_VIEW_CART: {
|
|
3
|
-
name:
|
|
4
|
-
hasEcommerce:
|
|
5
|
-
destinations:
|
|
6
|
-
requiredParams:
|
|
3
|
+
readonly name: "custom_view_cart";
|
|
4
|
+
readonly hasEcommerce: true;
|
|
5
|
+
readonly destinations: readonly ["DataLayer"];
|
|
6
|
+
readonly requiredParams: readonly ["brand", "region", "line_items", "currency", "value", "total_discount", "subtotal", "items"];
|
|
7
7
|
};
|
|
8
8
|
ADD_TO_WISHLIST: {
|
|
9
|
-
name:
|
|
10
|
-
hasEcommerce:
|
|
11
|
-
destinations:
|
|
12
|
-
requiredParams:
|
|
9
|
+
readonly name: "add_to_wishlist";
|
|
10
|
+
readonly hasEcommerce: true;
|
|
11
|
+
readonly destinations: readonly ["DataLayer"];
|
|
12
|
+
readonly requiredParams: readonly ["brand", "region", "line_items", "currency", "value", "items"];
|
|
13
13
|
};
|
|
14
14
|
CUSTOM_ADD_TO_CART: {
|
|
15
|
-
name:
|
|
16
|
-
hasEcommerce:
|
|
17
|
-
destinations:
|
|
18
|
-
requiredParams:
|
|
15
|
+
readonly name: "custom_add_to_cart";
|
|
16
|
+
readonly hasEcommerce: true;
|
|
17
|
+
readonly destinations: readonly ["DataLayer"];
|
|
18
|
+
readonly requiredParams: readonly ["brand", "region", "line_items", "currency", "value", "items"];
|
|
19
19
|
};
|
|
20
20
|
CUSTOM_REMOVE_FROM_CART: {
|
|
21
|
-
name:
|
|
22
|
-
hasEcommerce:
|
|
23
|
-
destinations:
|
|
24
|
-
requiredParams:
|
|
21
|
+
readonly name: "custom_remove_from_cart";
|
|
22
|
+
readonly hasEcommerce: true;
|
|
23
|
+
readonly destinations: readonly ["DataLayer"];
|
|
24
|
+
readonly requiredParams: readonly ["brand", "region", "line_items", "currency", "value", "items"];
|
|
25
25
|
};
|
|
26
26
|
ADD_TO_CART: {
|
|
27
|
-
name:
|
|
28
|
-
hasEcommerce:
|
|
29
|
-
destinations:
|
|
30
|
-
requiredParams:
|
|
27
|
+
readonly name: "add_to_cart";
|
|
28
|
+
readonly hasEcommerce: true;
|
|
29
|
+
readonly destinations: readonly ["DataLayer"];
|
|
30
|
+
readonly requiredParams: readonly ["brand", "region", "line_items", "currency", "value", "items"];
|
|
31
31
|
};
|
|
32
32
|
REMOVE_FROM_CART: {
|
|
33
|
-
name:
|
|
34
|
-
hasEcommerce:
|
|
35
|
-
destinations:
|
|
36
|
-
requiredParams:
|
|
33
|
+
readonly name: "remove_from_cart";
|
|
34
|
+
readonly hasEcommerce: true;
|
|
35
|
+
readonly destinations: readonly ["DataLayer"];
|
|
36
|
+
readonly requiredParams: readonly ["brand", "region", "line_items", "currency", "value", "items"];
|
|
37
37
|
};
|
|
38
38
|
ADD_COUPON: {
|
|
39
|
-
name:
|
|
40
|
-
hasEcommerce:
|
|
41
|
-
destinations:
|
|
42
|
-
requiredParams:
|
|
39
|
+
readonly name: "add_coupon";
|
|
40
|
+
readonly hasEcommerce: true;
|
|
41
|
+
readonly destinations: readonly ["DataLayer"];
|
|
42
|
+
readonly requiredParams: readonly ["brand", "region", "coupon", "coupon_message", "seller_cod_name"];
|
|
43
43
|
};
|
|
44
44
|
SEARCH: {
|
|
45
|
-
name:
|
|
46
|
-
hasEcommerce:
|
|
47
|
-
destinations:
|
|
48
|
-
requiredParams:
|
|
45
|
+
readonly name: "search";
|
|
46
|
+
readonly hasEcommerce: false;
|
|
47
|
+
readonly destinations: readonly ["DataLayer"];
|
|
48
|
+
readonly requiredParams: readonly ["brand", "search_term", "search_found", "search_quantity"];
|
|
49
49
|
};
|
|
50
50
|
SEARCH_ZIPCODE: {
|
|
51
|
-
name:
|
|
52
|
-
hasEcommerce:
|
|
53
|
-
destinations:
|
|
54
|
-
requiredParams:
|
|
51
|
+
readonly name: "search_zipcode";
|
|
52
|
+
readonly hasEcommerce: false;
|
|
53
|
+
readonly destinations: readonly ["DataLayer"];
|
|
54
|
+
readonly requiredParams: readonly ["brand", "region", "shippings", "zipcode", "flag_pickup"];
|
|
55
55
|
};
|
|
56
56
|
VIEW_PROMOTION: {
|
|
57
|
-
name:
|
|
58
|
-
hasEcommerce:
|
|
59
|
-
destinations:
|
|
60
|
-
requiredParams:
|
|
57
|
+
readonly name: "view_promotion";
|
|
58
|
+
readonly hasEcommerce: true;
|
|
59
|
+
readonly destinations: readonly ["DataLayer"];
|
|
60
|
+
readonly requiredParams: readonly ["brand", "region", "currency", "promotion_name", "creative_slot", "creative_name"];
|
|
61
61
|
};
|
|
62
62
|
SELECT_PROMOTION: {
|
|
63
|
-
name:
|
|
64
|
-
hasEcommerce:
|
|
65
|
-
destinations:
|
|
66
|
-
requiredParams:
|
|
63
|
+
readonly name: "select_promotion";
|
|
64
|
+
readonly hasEcommerce: true;
|
|
65
|
+
readonly destinations: readonly ["DataLayer"];
|
|
66
|
+
readonly requiredParams: readonly ["brand", "region", "currency", "promotion_name", "creative_slot", "creative_name"];
|
|
67
67
|
};
|
|
68
68
|
SELECT_CONTENT: {
|
|
69
|
-
name:
|
|
70
|
-
hasEcommerce:
|
|
71
|
-
destinations:
|
|
72
|
-
requiredParams:
|
|
69
|
+
readonly name: "select_content";
|
|
70
|
+
readonly hasEcommerce: false;
|
|
71
|
+
readonly destinations: readonly ["DataLayer"];
|
|
72
|
+
readonly requiredParams: readonly ["brand", "content_type"];
|
|
73
73
|
};
|
|
74
74
|
SELECT_ITEM: {
|
|
75
|
-
name:
|
|
76
|
-
hasEcommerce:
|
|
77
|
-
destinations:
|
|
78
|
-
requiredParams:
|
|
75
|
+
readonly name: "select_item";
|
|
76
|
+
readonly hasEcommerce: true;
|
|
77
|
+
readonly destinations: readonly ["DataLayer"];
|
|
78
|
+
readonly requiredParams: readonly ["brand", "region", "items", "line_items"];
|
|
79
79
|
};
|
|
80
80
|
VIEW_ITEM: {
|
|
81
|
-
name:
|
|
82
|
-
hasEcommerce:
|
|
83
|
-
destinations:
|
|
84
|
-
requiredParams:
|
|
81
|
+
readonly name: "view_item";
|
|
82
|
+
readonly hasEcommerce: true;
|
|
83
|
+
readonly destinations: readonly ["DataLayer"];
|
|
84
|
+
readonly requiredParams: readonly ["brand", "line_items", "currency", "value", "available_grid", "items"];
|
|
85
85
|
};
|
|
86
86
|
CUSTOM_VIEW_ITEM: {
|
|
87
|
-
name:
|
|
88
|
-
hasEcommerce:
|
|
89
|
-
destinations:
|
|
90
|
-
requiredParams:
|
|
87
|
+
readonly name: "custom_view_item";
|
|
88
|
+
readonly hasEcommerce: true;
|
|
89
|
+
readonly destinations: readonly ["DataLayer"];
|
|
90
|
+
readonly requiredParams: readonly ["brand", "line_items", "currency", "value", "available_grid", "items"];
|
|
91
91
|
};
|
|
92
92
|
VIEW_ITEM_LIST: {
|
|
93
|
-
name:
|
|
94
|
-
hasEcommerce:
|
|
95
|
-
destinations:
|
|
96
|
-
requiredParams:
|
|
93
|
+
readonly name: "view_item_list";
|
|
94
|
+
readonly hasEcommerce: true;
|
|
95
|
+
readonly destinations: readonly ["DataLayer"];
|
|
96
|
+
readonly requiredParams: readonly ["region", "brand", "line_items", "items"];
|
|
97
97
|
};
|
|
98
98
|
BEGIN_CHECKOUT: {
|
|
99
|
-
name:
|
|
100
|
-
hasEcommerce:
|
|
101
|
-
destinations:
|
|
102
|
-
requiredParams:
|
|
99
|
+
readonly name: "begin_checkout";
|
|
100
|
+
readonly hasEcommerce: true;
|
|
101
|
+
readonly destinations: readonly ["DataLayer"];
|
|
102
|
+
readonly requiredParams: readonly ["brand", "line_items", "currency", "value", "total_discount", "subtotal", "items"];
|
|
103
103
|
};
|
|
104
104
|
CUSTOM_BEGIN_CHECKOUT: {
|
|
105
|
-
name:
|
|
106
|
-
hasEcommerce:
|
|
107
|
-
destinations:
|
|
108
|
-
requiredParams:
|
|
105
|
+
readonly name: "custom_begin_checkout";
|
|
106
|
+
readonly hasEcommerce: true;
|
|
107
|
+
readonly destinations: readonly ["DataLayer"];
|
|
108
|
+
readonly requiredParams: readonly ["brand", "line_items", "currency", "value", "total_discount", "subtotal", "items"];
|
|
109
109
|
};
|
|
110
110
|
AUTH_ACTION: {
|
|
111
|
-
name:
|
|
112
|
-
hasEcommerce:
|
|
113
|
-
requiredParams:
|
|
114
|
-
destinations:
|
|
111
|
+
readonly name: "auth_action";
|
|
112
|
+
readonly hasEcommerce: false;
|
|
113
|
+
readonly requiredParams: readonly ["region", "method", "type", "brand"];
|
|
114
|
+
readonly destinations: readonly ["DataLayer"];
|
|
115
115
|
};
|
|
116
116
|
ADD_PERSONAL_INFO: {
|
|
117
|
-
name:
|
|
118
|
-
hasEcommerce:
|
|
119
|
-
destinations:
|
|
120
|
-
requiredParams:
|
|
117
|
+
readonly name: "add_personal_info";
|
|
118
|
+
readonly hasEcommerce: true;
|
|
119
|
+
readonly destinations: readonly ["DataLayer"];
|
|
120
|
+
readonly requiredParams: readonly ["brand", "pre_filled", "line_items", "currency", "value", "total_discount", "subtotal"];
|
|
121
121
|
};
|
|
122
122
|
CUSTOM_ADD_SHIPPING_INFO: {
|
|
123
|
-
name:
|
|
124
|
-
hasEcommerce:
|
|
125
|
-
destinations:
|
|
126
|
-
requiredParams:
|
|
123
|
+
readonly name: "add_shipping_info";
|
|
124
|
+
readonly hasEcommerce: true;
|
|
125
|
+
readonly destinations: readonly ["DataLayer"];
|
|
126
|
+
readonly requiredParams: readonly ["brand", "pre_filled", "shipping", "shipping_tier", "line_items", "currency", "value", "total_discount", "subtotal", "items"];
|
|
127
127
|
};
|
|
128
128
|
CUSTOM_ADD_PAYMENT_INFO: {
|
|
129
|
-
name:
|
|
130
|
-
hasEcommerce:
|
|
131
|
-
destinations:
|
|
132
|
-
requiredParams:
|
|
129
|
+
readonly name: "add_payment_info";
|
|
130
|
+
readonly hasEcommerce: true;
|
|
131
|
+
readonly destinations: readonly ["DataLayer"];
|
|
132
|
+
readonly requiredParams: readonly ["brand", "pre_filled", "line_items", "currency", "value", "total_discount", "payment_type", "subtotal", "items"];
|
|
133
133
|
};
|
|
134
134
|
ORDER_REVIEWED: {
|
|
135
|
-
name:
|
|
136
|
-
hasEcommerce:
|
|
137
|
-
destinations:
|
|
138
|
-
requiredParams:
|
|
135
|
+
readonly name: "order_reviewed";
|
|
136
|
+
readonly hasEcommerce: true;
|
|
137
|
+
readonly destinations: readonly ["DataLayer"];
|
|
138
|
+
readonly requiredParams: readonly ["brand", "line_items", "currency", "value", "total_discount", "subtotal", "payment_type"];
|
|
139
139
|
};
|
|
140
140
|
PURCHASE: {
|
|
141
|
-
name:
|
|
142
|
-
hasEcommerce:
|
|
143
|
-
destinations:
|
|
144
|
-
requiredParams:
|
|
141
|
+
readonly name: "purchase";
|
|
142
|
+
readonly hasEcommerce: true;
|
|
143
|
+
readonly destinations: readonly ["DataLayer"];
|
|
144
|
+
readonly requiredParams: readonly ["brand", "shipping_tier", "line_items", "currency", "value", "shipping", "transaction_id", "total_discount", "payment_type", "seller_cod_name", "subtotal", "coupon", "items"];
|
|
145
145
|
};
|
|
146
146
|
CUSTOM_PURCHASE: {
|
|
147
|
-
name:
|
|
148
|
-
hasEcommerce:
|
|
149
|
-
destinations:
|
|
150
|
-
requiredParams:
|
|
147
|
+
readonly name: "custom_purchase";
|
|
148
|
+
readonly hasEcommerce: true;
|
|
149
|
+
readonly destinations: readonly ["DataLayer"];
|
|
150
|
+
readonly requiredParams: readonly ["brand", "shipping_tier", "line_items", "currency", "value", "shipping", "transaction_id", "total_discount", "payment_type", "seller_cod_name", "subtotal", "coupon", "items"];
|
|
151
151
|
};
|
|
152
152
|
CUSTOM_USER_INFO: {
|
|
153
|
-
name:
|
|
154
|
-
hasEcommerce:
|
|
155
|
-
destinations:
|
|
156
|
-
requiredParams:
|
|
153
|
+
readonly name: "custom_user_info";
|
|
154
|
+
readonly hasEcommerce: false;
|
|
155
|
+
readonly destinations: readonly ["DataLayer"];
|
|
156
|
+
readonly requiredParams: readonly ["user_info"];
|
|
157
157
|
};
|
|
158
158
|
NOTIFY_ME: {
|
|
159
159
|
name: string;
|
|
@@ -161,6 +161,795 @@ declare const EVENTS: {
|
|
|
161
161
|
destinations: string[];
|
|
162
162
|
requiredParams: string[];
|
|
163
163
|
};
|
|
164
|
+
REFINE_RESULTS: {
|
|
165
|
+
readonly name: "refine_results";
|
|
166
|
+
readonly hasEcommerce: false;
|
|
167
|
+
readonly destinations: readonly ["DataLayer"];
|
|
168
|
+
readonly requiredParams: readonly ["brand", "region", "color", "price_range", "size", "category", "ordering"];
|
|
169
|
+
};
|
|
170
|
+
GRID_SIZE: {
|
|
171
|
+
readonly name: "grid_size";
|
|
172
|
+
readonly hasEcommerce: false;
|
|
173
|
+
readonly destinations: readonly ["DataLayer"];
|
|
174
|
+
readonly requiredParams: readonly ["brand", "slot_per_line"];
|
|
175
|
+
};
|
|
176
|
+
};
|
|
177
|
+
type EventName$1 = keyof typeof EVENTS;
|
|
178
|
+
type RequiredParamsOf<E extends EventName$1> = typeof EVENTS[E]['requiredParams'][number];
|
|
179
|
+
|
|
180
|
+
interface Thing {
|
|
181
|
+
"@type": "Thing";
|
|
182
|
+
/** IRI identifying the canonical address of this object. */
|
|
183
|
+
"@id"?: string;
|
|
184
|
+
/** An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally. */
|
|
185
|
+
additionalType?: string;
|
|
186
|
+
/** An alias for the item. */
|
|
187
|
+
alternateName?: string;
|
|
188
|
+
/** A description of the item. */
|
|
189
|
+
description?: string;
|
|
190
|
+
/** A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation. */
|
|
191
|
+
disambiguatingDescription?: string;
|
|
192
|
+
/** The identifier property represents any kind of identifier for any kind of {@link https://schema.org/Thing Thing}, such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See {@link /docs/datamodel.html#identifierBg background notes} for more details. */
|
|
193
|
+
identifier?: string;
|
|
194
|
+
/** An image of the item. This can be a {@link https://schema.org/URL URL} or a fully described {@link https://schema.org/ImageObject ImageObject}. */
|
|
195
|
+
image?: ImageObject[] | null;
|
|
196
|
+
video?: VideoObject[] | null;
|
|
197
|
+
/** The name of the item. */
|
|
198
|
+
name?: string;
|
|
199
|
+
/** URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website. */
|
|
200
|
+
sameAs?: string;
|
|
201
|
+
/** A CreativeWork or Event about this Thing. */
|
|
202
|
+
subjectOf?: string;
|
|
203
|
+
/** URL of the item. */
|
|
204
|
+
url?: string;
|
|
205
|
+
}
|
|
206
|
+
interface MediaObject {
|
|
207
|
+
/** Media type typically expressed using a MIME format (see IANA site and MDN reference) */
|
|
208
|
+
encodingFormat?: string;
|
|
209
|
+
/** A URL pointing to a player for a specific video. */
|
|
210
|
+
embedUrl?: string;
|
|
211
|
+
/** Actual bytes of the media object, for example the image file or video file. */
|
|
212
|
+
contentUrl?: string;
|
|
213
|
+
}
|
|
214
|
+
interface CreativeWork {
|
|
215
|
+
/** A thumbnail image relevant to the Thing */
|
|
216
|
+
thumbnailUrl?: string;
|
|
217
|
+
}
|
|
218
|
+
interface VideoObject extends MediaObject, CreativeWork, Omit<Thing, "@type" | "url"> {
|
|
219
|
+
/**
|
|
220
|
+
* @ignore
|
|
221
|
+
*/
|
|
222
|
+
"@type": "VideoObject";
|
|
223
|
+
/**
|
|
224
|
+
* @description date when video was published first time, format ISO 8601: https://en.wikipedia.org/wiki/ISO_8601
|
|
225
|
+
*/
|
|
226
|
+
uploadDate?: string;
|
|
227
|
+
/**
|
|
228
|
+
* @description video duration, format ISO 8601: https://en.wikipedia.org/wiki/ISO_8601,
|
|
229
|
+
* PT00H30M5S means 30 minutes and 5 seconds
|
|
230
|
+
*/
|
|
231
|
+
duration?: string;
|
|
232
|
+
}
|
|
233
|
+
interface ImageObject extends MediaObject, CreativeWork, Omit<Thing, "@type" | "url"> {
|
|
234
|
+
/**
|
|
235
|
+
* @ignore
|
|
236
|
+
*/
|
|
237
|
+
"@type": "ImageObject";
|
|
238
|
+
/**
|
|
239
|
+
* @format image-uri
|
|
240
|
+
*/
|
|
241
|
+
url?: string;
|
|
242
|
+
}
|
|
243
|
+
interface PropertyValue extends Omit<Thing, "@type"> {
|
|
244
|
+
"@type": "PropertyValue";
|
|
245
|
+
/** The upper value of some characteristic or property. */
|
|
246
|
+
maxValue?: number;
|
|
247
|
+
/** The lower value of some characteristic or property. */
|
|
248
|
+
minValue?: number;
|
|
249
|
+
/** A commonly used identifier for the characteristic represented by the property, e.g. a manufacturer or a standard code for a property. propertyID can be (1) a prefixed string, mainly meant to be used with standards for product properties; (2) a site-specific, non-prefixed string (e.g. the primary key of the property or the vendor-specific id of the property), or (3) a URL indicating the type of the property, either pointing to an external vocabulary, or a Web resource that describes the property (e.g. a glossary entry). Standards bodies should promote a standard prefix for the identifiers of properties from their standards. */
|
|
250
|
+
propertyID?: string;
|
|
251
|
+
/** The unit of measurement given using the UN/CEFACT Common Code (3 characters) or a URL. Other codes than the UN/CEFACT Common Code may be used with a prefix followed by a colon. */
|
|
252
|
+
unitCode?: string;
|
|
253
|
+
/** A string or text indicating the unit of measurement. Useful if you cannot provide a standard unit code for {@link unitCode unitCode}. */
|
|
254
|
+
unitText?: string;
|
|
255
|
+
/**
|
|
256
|
+
* The value of the quantitative value or property value node.
|
|
257
|
+
* - For {@link https://schema.org/QuantitativeValue QuantitativeValue} and {@link https://schema.org/MonetaryAmount MonetaryAmount}, the recommended type for values is 'Number'.
|
|
258
|
+
* - For {@link https://schema.org/PropertyValue PropertyValue}, it can be 'Text;', 'Number', 'Boolean', or 'StructuredValue'.
|
|
259
|
+
* - Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similiar Unicode symbols.
|
|
260
|
+
* - Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.
|
|
261
|
+
*/
|
|
262
|
+
value?: string;
|
|
263
|
+
/** A secondary value that provides additional information on the original value, e.g. a reference temperature or a type of measurement. */
|
|
264
|
+
valueReference?: string;
|
|
265
|
+
}
|
|
266
|
+
interface AggregateRating {
|
|
267
|
+
"@type": "AggregateRating";
|
|
268
|
+
/** The count of total number of ratings. */
|
|
269
|
+
ratingCount?: number;
|
|
270
|
+
/** The count of total number of reviews. */
|
|
271
|
+
reviewCount?: number;
|
|
272
|
+
/** The rating for the content. */
|
|
273
|
+
ratingValue?: number;
|
|
274
|
+
/** The highest value allowed in this rating system. */
|
|
275
|
+
bestRating?: number;
|
|
276
|
+
/** The lowest value allowed in this rating system. */
|
|
277
|
+
worstRating?: number;
|
|
278
|
+
/** A short explanation (e.g. one to two sentences) providing background context and other information that led to the conclusion expressed in the rating. This is particularly applicable to ratings associated with "fact check" markup using ClaimReview. */
|
|
279
|
+
ratingExplanation?: string;
|
|
280
|
+
}
|
|
281
|
+
declare type ItemAvailability = "https://schema.org/BackOrder" | "https://schema.org/Discontinued" | "https://schema.org/InStock" | "https://schema.org/InStoreOnly" | "https://schema.org/LimitedAvailability" | "https://schema.org/OnlineOnly" | "https://schema.org/OutOfStock" | "https://schema.org/PreOrder" | "https://schema.org/PreSale" | "https://schema.org/SoldOut";
|
|
282
|
+
declare type OfferItemCondition = "https://schema.org/DamagedCondition" | "https://schema.org/NewCondition" | "https://schema.org/RefurbishedCondition" | "https://schema.org/UsedCondition";
|
|
283
|
+
interface QuantitativeValue {
|
|
284
|
+
value?: number;
|
|
285
|
+
}
|
|
286
|
+
declare type PriceTypeEnumeration = "https://schema.org/InvoicePrice" | "https://schema.org/ListPrice" | "https://schema.org/MinimumAdvertisedPrice" | "https://schema.org/MSRP" | "https://schema.org/SalePrice" | "https://schema.org/SRP";
|
|
287
|
+
declare type PriceComponentTypeEnumeration = "https://schema.org/ActivationFee" | "https://schema.org/CleaningFee" | "https://schema.org/DistanceFee" | "https://schema.org/Downpayment" | "https://schema.org/Installment" | "https://schema.org/Subscription";
|
|
288
|
+
declare type ReturnFeesEnumeration = "https://schema.org/FreeReturn" | "https://schema.org/OriginalShippingFees" | "https://schema.org/RestockingFees" | "https://schema.org/ReturnFeesCustomerResponsibility" | "https://schema.org/ReturnShippingFees";
|
|
289
|
+
declare type ReturnMethodEnumeration = "https://schema.org/KeepProduct" | "https://schema.org/ReturnAtKiosk" | "https://schema.org/ReturnByMail" | "https://schema.org/ReturnInStore";
|
|
290
|
+
declare type MerchantReturnEnumeration = "https://schema.org/MerchantReturnFiniteReturnWindow" | "https://schema.org/MerchantReturnNotPermitted" | "https://schema.org/MerchantReturnUnlimitedWindow" | "https://schema.org/MerchantReturnUnspecified";
|
|
291
|
+
interface PriceSpecification extends Omit<Thing, "@type"> {
|
|
292
|
+
"@type": "PriceSpecification";
|
|
293
|
+
/** The interval and unit of measurement of ordering quantities for which the offer or price specification is valid. This allows e.g. specifying that a certain freight charge is valid only for a certain quantity. */
|
|
294
|
+
eligibleQuantity?: QuantitativeValue;
|
|
295
|
+
/**
|
|
296
|
+
* The offer price of a product, or of a price component when attached to PriceSpecification and its subtypes.
|
|
297
|
+
*
|
|
298
|
+
* Usage guidelines:
|
|
299
|
+
* - Use the {@link https://schema.org/priceCurrency priceCurrency} property (with standard formats: {@link http://en.wikipedia.org/wiki/ISO_4217 ISO 4217 currency format} e.g. "USD"; {@link https://en.wikipedia.org/wiki/List_of_cryptocurrencies Ticker symbol} for cryptocurrencies e.g. "BTC"; well known names for {@link https://en.wikipedia.org/wiki/Local_exchange_trading_system Local Exchange Tradings Systems} (LETS) and other currency types e.g. "Ithaca HOUR") instead of including {@link http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign ambiguous symbols} such as '$' in the value.
|
|
300
|
+
* - Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.
|
|
301
|
+
* - Note that both {@link http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute RDFa} and Microdata syntax allow the use of a "content=" attribute for publishing simple machine-readable values alongside more human-friendly formatting.
|
|
302
|
+
* - Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similiar Unicode symbols.
|
|
303
|
+
*/
|
|
304
|
+
price: number;
|
|
305
|
+
/**
|
|
306
|
+
* The currency of the price, or a price component when attached to {@link https://schema.org/PriceSpecification PriceSpecification} and its subtypes.
|
|
307
|
+
*
|
|
308
|
+
* Use standard formats: {@link http://en.wikipedia.org/wiki/ISO_4217 ISO 4217 currency format} e.g. "USD"; {@link https://en.wikipedia.org/wiki/List_of_cryptocurrencies Ticker symbol} for cryptocurrencies e.g. "BTC"; well known names for {@link https://en.wikipedia.org/wiki/Local_exchange_trading_system Local Exchange Tradings Systems} (LETS) and other currency types e.g. "Ithaca HOUR".
|
|
309
|
+
*/
|
|
310
|
+
priceCurrency?: string;
|
|
311
|
+
}
|
|
312
|
+
interface UnitPriceSpecification extends Omit<PriceSpecification, "@type"> {
|
|
313
|
+
"@type": "UnitPriceSpecification";
|
|
314
|
+
/** Identifies a price component (for example, a line item on an invoice), part of the total price for an offer. */
|
|
315
|
+
priceComponentType?: PriceComponentTypeEnumeration;
|
|
316
|
+
/** Defines the type of a price specified for an offered product, for example a list price, a (temporary) sale price or a manufacturer suggested retail price. If multiple prices are specified for an offer the {@link https://schema.org/priceType priceType} property can be used to identify the type of each such specified price. The value of priceType can be specified as a value from enumeration PriceTypeEnumeration or as a free form text string for price types that are not already predefined in PriceTypeEnumeration. */
|
|
317
|
+
priceType: PriceTypeEnumeration;
|
|
318
|
+
/** Specifies for how long this price (or price component) will be billed. Can be used, for example, to model the contractual duration of a subscription or payment plan. Type can be either a Duration or a Number (in which case the unit of measurement, for example month, is specified by the unitCode property). */
|
|
319
|
+
billingDuration?: number;
|
|
320
|
+
/** This property specifies the minimal quantity and rounding increment that will be the basis for the billing. The unit of measurement is specified by the unitCode property. */
|
|
321
|
+
billingIncrement?: number;
|
|
322
|
+
}
|
|
323
|
+
interface TeasersParameters {
|
|
324
|
+
name: string;
|
|
325
|
+
value: string;
|
|
326
|
+
}
|
|
327
|
+
interface TeasersConditions {
|
|
328
|
+
minimumQuantity: number;
|
|
329
|
+
parameters: TeasersParameters[];
|
|
330
|
+
}
|
|
331
|
+
interface TeasersEffect {
|
|
332
|
+
parameters: TeasersParameters[];
|
|
333
|
+
}
|
|
334
|
+
interface Teasers {
|
|
335
|
+
name: string;
|
|
336
|
+
generalValues?: unknown;
|
|
337
|
+
conditions: TeasersConditions;
|
|
338
|
+
effects: TeasersEffect;
|
|
339
|
+
}
|
|
340
|
+
interface MonetaryAmount extends Omit<Thing, "@type"> {
|
|
341
|
+
/**
|
|
342
|
+
* The currency in which the monetary amount is expressed.
|
|
343
|
+
*
|
|
344
|
+
* Use standard formats: ISO 4217 currency format, e.g. "USD"; Ticker symbol for cryptocurrencies, e.g. "BTC"; well known names for Local Exchange Trading Systems (LETS) and other currency types, e.g. "Ithaca HOUR".
|
|
345
|
+
*/
|
|
346
|
+
currency: string;
|
|
347
|
+
/**
|
|
348
|
+
* The upper value of some characteristic or property.
|
|
349
|
+
*/
|
|
350
|
+
maxValue: number;
|
|
351
|
+
/** The lower value of some characteristic or property. */
|
|
352
|
+
minValue: number;
|
|
353
|
+
/** The date when the item becomes valid. */
|
|
354
|
+
validFrom: string;
|
|
355
|
+
/** The date after when the item is not valid. For example the end of an offer, salary period, or a period of opening hours. */
|
|
356
|
+
validThrough: string;
|
|
357
|
+
/** The value of a QuantitativeValue (including Observation) or property value node. */
|
|
358
|
+
value: boolean | number | string;
|
|
359
|
+
}
|
|
360
|
+
interface MerchantReturnPolicy extends Omit<Thing, "@type"> {
|
|
361
|
+
"@type": "MerchantReturnPolicy";
|
|
362
|
+
/** Specifies either a fixed return date or the number of days (from the delivery date) that a product can be returned. Used when the returnPolicyCategory property is specified as MerchantReturnFiniteReturnWindow. Supersedes productReturnDays */
|
|
363
|
+
merchantReturnDays?: number;
|
|
364
|
+
/** A country where a particular merchant return policy applies to, for example the two-letter ISO 3166-1 alpha-2 country code. */
|
|
365
|
+
applicableCountry: string;
|
|
366
|
+
/** The type of return fees for purchased products (for any return reason). */
|
|
367
|
+
returnFees?: ReturnFeesEnumeration;
|
|
368
|
+
/** The type of return method offered, specified from an enumeration. */
|
|
369
|
+
returnMethod?: ReturnMethodEnumeration;
|
|
370
|
+
/** Specifies an applicable return policy (from an enumeration). */
|
|
371
|
+
returnPolicyCategory: MerchantReturnEnumeration;
|
|
372
|
+
/** Amount of shipping costs for product returns (for any reason). Applicable when property returnFees equals ReturnShippingFees. */
|
|
373
|
+
returnShippingFeesAmount?: MonetaryAmount;
|
|
374
|
+
}
|
|
375
|
+
interface Offer extends Omit<Thing, "@type"> {
|
|
376
|
+
"@type": "Offer";
|
|
377
|
+
/** The availability of this item—for example In stock, Out of stock, Pre-order, etc. */
|
|
378
|
+
availability: ItemAvailability;
|
|
379
|
+
/** A Global Trade Item Number ({@link https://www.gs1.org/standards/id-keys/gtin GTIN}). GTINs identify trade items, including products and services, using numeric identification codes. The {@link https://schema.org/gtin gtin} property generalizes the earlier {@link https://schema.org/gtin8 gtin8}, {@link https://schema.org/gtin12 gtin12}, {@link https://schema.org/gtin13 gtin13}, and {@link https://schema.org/gtin14 gtin14} properties. The GS1 {@link https://www.gs1.org/standards/Digital-Link/ digital link specifications} express GTINs as URLs. A correct {@link https://schema.org/gtin gtin} value should be a valid GTIN, which means that it should be an all-numeric string of either 8, 12, 13 or 14 digits, or a "GS1 Digital Link" URL based on such a string. The numeric component should also have a {@link https://www.gs1.org/services/check-digit-calculator valid GS1 check digit} and meet the other rules for valid GTINs. See also {@link http://www.gs1.org/barcodes/technical/idkeys/gtin GS1's GTIN Summary} and {@link https://en.wikipedia.org/wiki/Global_Trade_Item_Number Wikipedia} for more details. Left-padding of the gtin values is not required or encouraged. */
|
|
380
|
+
gtin?: string;
|
|
381
|
+
/** The current approximate inventory level for the item or items. */
|
|
382
|
+
inventoryLevel: QuantitativeValue;
|
|
383
|
+
/** A predefined value from OfferItemCondition specifying the condition of the product or service, or the products or services included in the offer. Also used for product return policies to specify the condition of products accepted for returns. */
|
|
384
|
+
itemCondition?: OfferItemCondition;
|
|
385
|
+
/**
|
|
386
|
+
* The offer price of a product, or of a price component when attached to PriceSpecification and its subtypes.
|
|
387
|
+
*
|
|
388
|
+
* Usage guidelines:
|
|
389
|
+
* - Use the {@link https://schema.org/priceCurrency priceCurrency} property (with standard formats: {@link http://en.wikipedia.org/wiki/ISO_4217 ISO 4217 currency format} e.g. "USD"; {@link https://en.wikipedia.org/wiki/List_of_cryptocurrencies Ticker symbol} for cryptocurrencies e.g. "BTC"; well known names for {@link https://en.wikipedia.org/wiki/Local_exchange_trading_system Local Exchange Tradings Systems} (LETS) and other currency types e.g. "Ithaca HOUR") instead of including {@link http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign ambiguous symbols} such as '$' in the value.
|
|
390
|
+
* - Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.
|
|
391
|
+
* - Note that both {@link http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute RDFa} and Microdata syntax allow the use of a "content=" attribute for publishing simple machine-readable values alongside more human-friendly formatting.
|
|
392
|
+
* - Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similiar Unicode symbols.
|
|
393
|
+
*/
|
|
394
|
+
price: number;
|
|
395
|
+
/**
|
|
396
|
+
* The currency of the price, or a price component when attached to {@link https://schema.org/PriceSpecification PriceSpecification} and its subtypes.
|
|
397
|
+
*
|
|
398
|
+
* Use standard formats: {@link http://en.wikipedia.org/wiki/ISO_4217 ISO 4217 currency format} e.g. "USD"; {@link https://en.wikipedia.org/wiki/List_of_cryptocurrencies Ticker symbol} for cryptocurrencies e.g. "BTC"; well known names for {@link https://en.wikipedia.org/wiki/Local_exchange_trading_system Local Exchange Tradings Systems} (LETS) and other currency types e.g. "Ithaca HOUR".
|
|
399
|
+
*/
|
|
400
|
+
priceCurrency?: string;
|
|
401
|
+
/** One or more detailed price specifications, indicating the unit price and delivery or payment charges. */
|
|
402
|
+
priceSpecification: UnitPriceSpecification[];
|
|
403
|
+
/** The date after which the price is no longer available. */
|
|
404
|
+
priceValidUntil?: string;
|
|
405
|
+
/** An entity which offers (sells / leases / lends / loans) the services / goods. A seller may also be a provider. */
|
|
406
|
+
seller?: string;
|
|
407
|
+
/** Name of the seller */
|
|
408
|
+
sellerName?: string;
|
|
409
|
+
/** The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers. */
|
|
410
|
+
sku?: string;
|
|
411
|
+
/** Used by some ecommerce sites to retrieve the sku of products that are part of the BuyAndWin promotion */
|
|
412
|
+
giftSkuIds?: string[];
|
|
413
|
+
/** Used by some ecommerce providers (e.g: VTEX) to describe special promotions that depend on some conditions */
|
|
414
|
+
teasers?: Teasers[];
|
|
415
|
+
/** Specifies a MerchantReturnPolicy that may be applicable. */
|
|
416
|
+
hasMerchantReturnPolicy?: MerchantReturnPolicy;
|
|
417
|
+
}
|
|
418
|
+
interface AggregateOffer {
|
|
419
|
+
"@type": "AggregateOffer";
|
|
420
|
+
/**
|
|
421
|
+
* The highest price of all offers available.
|
|
422
|
+
*
|
|
423
|
+
* Usage guidelines:
|
|
424
|
+
* - Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similiar Unicode symbols.
|
|
425
|
+
* - Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.
|
|
426
|
+
*/
|
|
427
|
+
highPrice: number;
|
|
428
|
+
/**
|
|
429
|
+
* The lowest price of all offers available.
|
|
430
|
+
*
|
|
431
|
+
* Usage guidelines:
|
|
432
|
+
* - Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similiar Unicode symbols.
|
|
433
|
+
* - Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.
|
|
434
|
+
*/
|
|
435
|
+
lowPrice: number;
|
|
436
|
+
/** The number of offers for the product. */
|
|
437
|
+
offerCount: number;
|
|
438
|
+
/** An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use {@link https://schema.org/businessFunction businessFunction} to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a {@link https://schema.org/Demand Demand}. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer. */
|
|
439
|
+
offers: Offer[];
|
|
440
|
+
/**
|
|
441
|
+
* The currency of the price, or a price component when attached to {@link https://schema.org/PriceSpecification PriceSpecification} and its subtypes.
|
|
442
|
+
*
|
|
443
|
+
* Use standard formats: {@link http://en.wikipedia.org/wiki/ISO_4217 ISO 4217 currency format} e.g. "USD"; {@link https://en.wikipedia.org/wiki/List_of_cryptocurrencies Ticker symbol} for cryptocurrencies e.g. "BTC"; well known names for {@link https://en.wikipedia.org/wiki/Local_exchange_trading_system Local Exchange Tradings Systems} (LETS) and other currency types e.g. "Ithaca HOUR".
|
|
444
|
+
*/
|
|
445
|
+
priceCurrency?: string;
|
|
446
|
+
/** Specifies a MerchantReturnPolicy that may be applicable. */
|
|
447
|
+
hasMerchantReturnPolicy?: MerchantReturnPolicy;
|
|
448
|
+
}
|
|
449
|
+
interface Review extends Omit<Thing, "@type"> {
|
|
450
|
+
"@type": "Review";
|
|
451
|
+
id?: string;
|
|
452
|
+
/** Author of the */
|
|
453
|
+
author?: Author[];
|
|
454
|
+
/** The date that the order was created, in ISO 8601 date format.*/
|
|
455
|
+
dateCreated?: string;
|
|
456
|
+
/** The date that the review was published, in ISO 8601 date format.*/
|
|
457
|
+
datePublished?: string;
|
|
458
|
+
/** The item that is being reviewed/rated. */
|
|
459
|
+
itemReviewed?: string;
|
|
460
|
+
/** Indicates, in the context of a {@link https://schema.org/Review Review} (e.g. framed as 'pro' vs 'con' considerations), negative considerations - either as unstructured text, or a list. */
|
|
461
|
+
negativeNotes?: string[];
|
|
462
|
+
/** Indicates, in the context of a {@link https://schema.org/Review Review} (e.g. framed as 'pro' vs 'con' considerations), positive considerations - either as unstructured text, or a list. */
|
|
463
|
+
positiveNotes?: string[];
|
|
464
|
+
/** This Review or Rating is relevant to this part or facet of the itemReviewed. */
|
|
465
|
+
reviewAspect?: string;
|
|
466
|
+
/** Emphasis part of the review */
|
|
467
|
+
reviewHeadline?: string;
|
|
468
|
+
/** The actual body of the review. */
|
|
469
|
+
reviewBody?: string;
|
|
470
|
+
/** The rating given in this review. Note that reviews can themselves be rated. The `reviewRating` applies to rating given by the review. The {@link https://schema.org/aggregateRating aggregateRating} property applies to the review itself, as a creative work. */
|
|
471
|
+
reviewRating?: AggregateRating;
|
|
472
|
+
/** Extra review informations */
|
|
473
|
+
tags?: ReviewTag[];
|
|
474
|
+
/** BrandReviewed */
|
|
475
|
+
brand?: ReviewBrand;
|
|
476
|
+
/** Medias */
|
|
477
|
+
media?: ReviewMedia[];
|
|
478
|
+
}
|
|
479
|
+
interface ReviewMedia {
|
|
480
|
+
type: "image" | "video";
|
|
481
|
+
url?: string;
|
|
482
|
+
alt?: string;
|
|
483
|
+
likes?: number;
|
|
484
|
+
unlikes?: number;
|
|
485
|
+
}
|
|
486
|
+
interface ReviewBrand {
|
|
487
|
+
/** Brand Name */
|
|
488
|
+
name: string;
|
|
489
|
+
/** Brand Logo */
|
|
490
|
+
logo: string;
|
|
491
|
+
/** Brand website url */
|
|
492
|
+
url: string;
|
|
493
|
+
}
|
|
494
|
+
interface ReviewTag {
|
|
495
|
+
/** Label of specific topic */
|
|
496
|
+
label?: string;
|
|
497
|
+
/** Caracteristics about the topic */
|
|
498
|
+
value?: string[];
|
|
499
|
+
}
|
|
500
|
+
interface Author extends Omit<Thing, "@type"> {
|
|
501
|
+
"@type": "Author";
|
|
502
|
+
/** The name of the author. */
|
|
503
|
+
name?: string;
|
|
504
|
+
/** A link to a web page that uniquely identifies the author of the article. For example, the author's social media page, an about me page, or a bio page. */
|
|
505
|
+
url?: string;
|
|
506
|
+
/** Indicates that the author is a real buyer */
|
|
507
|
+
verifiedBuyer?: boolean;
|
|
508
|
+
/** Author location */
|
|
509
|
+
location?: string;
|
|
510
|
+
}
|
|
511
|
+
interface ProductLeaf extends Omit<Product, "isVariantOf"> {
|
|
512
|
+
}
|
|
513
|
+
interface ProductGroup extends Omit<Thing, "@type"> {
|
|
514
|
+
"@type": "ProductGroup";
|
|
515
|
+
/** Indicates a {@link https://schema.org/Product Product} that is a member of this {@link https://schema.org/ProductGroup ProductGroup} (or {@link https://schema.org/ProductModel ProductModel}). */
|
|
516
|
+
hasVariant: ProductLeaf[];
|
|
517
|
+
/** Indicates a textual identifier for a ProductGroup. */
|
|
518
|
+
productGroupID: string;
|
|
519
|
+
/**
|
|
520
|
+
* A property-value pair representing an additional characteristics of the entitity, e.g. a product feature or another characteristic for which there is no matching property in schema.org.
|
|
521
|
+
*
|
|
522
|
+
* Note: Publishers should be aware that applications designed to use specific schema.org properties (e.g. https://schema.org/width, https://schema.org/color, https://schema.org/gtin13, ...) will typically expect such data to be provided using those properties, rather than using the generic property/value mechanism.
|
|
523
|
+
*/
|
|
524
|
+
additionalProperty: PropertyValue[];
|
|
525
|
+
/** docs https://schema.org/gtin */
|
|
526
|
+
model?: string;
|
|
527
|
+
}
|
|
528
|
+
interface Brand extends Omit<Thing, "@type"> {
|
|
529
|
+
"@type": "Brand";
|
|
530
|
+
/** Brand's image url */
|
|
531
|
+
logo?: string;
|
|
532
|
+
}
|
|
533
|
+
interface Answer extends Omit<Thing, "@type"> {
|
|
534
|
+
text: string;
|
|
535
|
+
/** The date that the anwser was published, in ISO 8601 date format.*/
|
|
536
|
+
dateModified?: string;
|
|
537
|
+
/** The date that the anwser was published, in ISO 8601 date format.*/
|
|
538
|
+
datePublished?: string;
|
|
539
|
+
/** Author of the */
|
|
540
|
+
author?: Author[];
|
|
541
|
+
}
|
|
542
|
+
interface Question extends Omit<Thing, "@type" | "name"> {
|
|
543
|
+
"@type": "Question";
|
|
544
|
+
answerCount: number;
|
|
545
|
+
/** The answer(s) that has been accepted as best */
|
|
546
|
+
acceptedAnswer?: Answer;
|
|
547
|
+
/** List of answer(s) */
|
|
548
|
+
suggestedAnswer?: Answer[];
|
|
549
|
+
name: string;
|
|
550
|
+
text: string;
|
|
551
|
+
/** The date that the question was published, in ISO 8601 date format.*/
|
|
552
|
+
dateModified?: string;
|
|
553
|
+
/** The date that the question was published, in ISO 8601 date format.*/
|
|
554
|
+
datePublished?: string;
|
|
555
|
+
/** Author of the */
|
|
556
|
+
author?: Author[];
|
|
557
|
+
}
|
|
558
|
+
interface Product extends Omit<Thing, "@type"> {
|
|
559
|
+
"@type": "Product";
|
|
560
|
+
/**
|
|
561
|
+
* A property-value pair representing an additional characteristics of the entitity, e.g. a product feature or another characteristic for which there is no matching property in schema.org.
|
|
562
|
+
*
|
|
563
|
+
* Note: Publishers should be aware that applications designed to use specific schema.org properties (e.g. https://schema.org/width, https://schema.org/color, https://schema.org/gtin13, ...) will typically expect such data to be provided using those properties, rather than using the generic property/value mechanism.
|
|
564
|
+
*/
|
|
565
|
+
additionalProperty?: PropertyValue[];
|
|
566
|
+
/** The overall rating, based on a collection of reviews or ratings, of the item. */
|
|
567
|
+
aggregateRating?: AggregateRating;
|
|
568
|
+
/** An award won by or for this item. */
|
|
569
|
+
award?: string;
|
|
570
|
+
/** The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person. */
|
|
571
|
+
brand?: Brand;
|
|
572
|
+
/** A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy. */
|
|
573
|
+
category?: string;
|
|
574
|
+
/** A Global Trade Item Number ({@link https://www.gs1.org/standards/id-keys/gtin GTIN}). GTINs identify trade items, including products and services, using numeric identification codes. The {@link https://schema.org/gtin gtin} property generalizes the earlier {@link https://schema.org/gtin8 gtin8}, {@link https://schema.org/gtin12 gtin12}, {@link https://schema.org/gtin13 gtin13}, and {@link https://schema.org/gtin14 gtin14} properties. The GS1 {@link https://www.gs1.org/standards/Digital-Link/ digital link specifications} express GTINs as URLs. A correct {@link https://schema.org/gtin gtin} value should be a valid GTIN, which means that it should be an all-numeric string of either 8, 12, 13 or 14 digits, or a "GS1 Digital Link" URL based on such a string. The numeric component should also have a {@link https://www.gs1.org/services/check-digit-calculator valid GS1 check digit} and meet the other rules for valid GTINs. See also {@link http://www.gs1.org/barcodes/technical/idkeys/gtin GS1's GTIN Summary} and {@link https://en.wikipedia.org/wiki/Global_Trade_Item_Number Wikipedia} for more details. Left-padding of the gtin values is not required or encouraged. */
|
|
575
|
+
gtin?: string;
|
|
576
|
+
/** Indicates the {@link https://schema.org/productGroupID productGroupID} for a {@link https://schema.org/ProductGroup ProductGroup} that this product {@link https://schema.org/isVariantOf isVariantOf}. */
|
|
577
|
+
inProductGroupWithID?: string;
|
|
578
|
+
isRelatedTo?: Product[] | null;
|
|
579
|
+
/** A pointer to another, functionally similar product (or multiple products). */
|
|
580
|
+
isSimilarTo?: Product[] | null;
|
|
581
|
+
/** Indicates the kind of product that this is a variant of. In the case of {@link https://schema.org/ProductModel ProductModel}, this is a pointer (from a ProductModel) to a base product from which this product is a variant. It is safe to infer that the variant inherits all product features from the base model, unless defined locally. This is not transitive. In the case of a {@link https://schema.org/ProductGroup ProductGroup}, the group description also serves as a template, representing a set of Products that vary on explicitly defined, specific dimensions only (so it defines both a set of variants, as well as which values distinguish amongst those variants). When used with {@link https://schema.org/ProductGroup ProductGroup}, this property can apply to any {@link https://schema.org/Product Product} included in the group. */
|
|
582
|
+
isVariantOf?: ProductGroup;
|
|
583
|
+
index?: number;
|
|
584
|
+
item_list_name?: string;
|
|
585
|
+
/** An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use {@link https://schema.org/businessFunction businessFunction} to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a {@link https://schema.org/Demand Demand}. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer. */
|
|
586
|
+
offers?: AggregateOffer;
|
|
587
|
+
/** The product identifier, such as ISBN. For example: `meta itemprop="productID" content="isbn:123-456-789"`. */
|
|
588
|
+
productID: string;
|
|
589
|
+
/** The date of production of the item, e.g. vehicle. */
|
|
590
|
+
productionDate?: string;
|
|
591
|
+
/** The release date of a product or product model. This can be used to distinguish the exact variant of a product. */
|
|
592
|
+
releaseDate?: string;
|
|
593
|
+
/** A review of the item. */
|
|
594
|
+
review?: Review[];
|
|
595
|
+
/** The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers. */
|
|
596
|
+
sku: string;
|
|
597
|
+
/** A pointer to another product (or multiple products) for which this product is an accessory or spare part. */
|
|
598
|
+
isAccessoryOrSparePartFor?: Product[] | null;
|
|
599
|
+
questions?: Question[];
|
|
600
|
+
}
|
|
601
|
+
|
|
602
|
+
type HasVariant = {
|
|
603
|
+
name: string;
|
|
604
|
+
slug: string;
|
|
605
|
+
sku: string;
|
|
606
|
+
additionalProperty: Array<{
|
|
607
|
+
propertyID: string;
|
|
608
|
+
value: string;
|
|
609
|
+
name: string;
|
|
610
|
+
valueReference: string;
|
|
611
|
+
}>;
|
|
612
|
+
offers: {
|
|
613
|
+
offers: Array<{
|
|
614
|
+
listPrice: number;
|
|
615
|
+
price: number;
|
|
616
|
+
availability: string;
|
|
617
|
+
quantity?: number;
|
|
618
|
+
seller: {
|
|
619
|
+
identifier: string;
|
|
620
|
+
};
|
|
621
|
+
}>;
|
|
622
|
+
};
|
|
623
|
+
productId?: string;
|
|
624
|
+
};
|
|
625
|
+
interface CommonProductType_PDP_APISearch {
|
|
626
|
+
productId: string;
|
|
627
|
+
productName: string;
|
|
628
|
+
brand: string;
|
|
629
|
+
brandId: number;
|
|
630
|
+
linkText: string;
|
|
631
|
+
productReference: string;
|
|
632
|
+
categoryId: string;
|
|
633
|
+
clusterHighlights: Record<string, any>;
|
|
634
|
+
productClusters: Record<string, string>;
|
|
635
|
+
releaseDate: string;
|
|
636
|
+
categories: string[];
|
|
637
|
+
categoriesIds: string[];
|
|
638
|
+
link: string;
|
|
639
|
+
description: string;
|
|
640
|
+
}
|
|
641
|
+
type ImageType = {
|
|
642
|
+
imageId: string;
|
|
643
|
+
imageLabel: string;
|
|
644
|
+
imageTag: string;
|
|
645
|
+
imageUrl: string;
|
|
646
|
+
imageText: string;
|
|
647
|
+
imageLastModified: string;
|
|
648
|
+
};
|
|
649
|
+
type ReferenceIdType = {
|
|
650
|
+
Key: string;
|
|
651
|
+
Value: string;
|
|
652
|
+
};
|
|
653
|
+
type PaymentOptionInstallmentType = {
|
|
654
|
+
count: number;
|
|
655
|
+
hasInterestRate: boolean;
|
|
656
|
+
interestRate: number;
|
|
657
|
+
value: number;
|
|
658
|
+
total: number;
|
|
659
|
+
sellerMerchantInstallments: {
|
|
660
|
+
id: string;
|
|
661
|
+
count: number;
|
|
662
|
+
hasInterestRate: boolean;
|
|
663
|
+
interestRate: number;
|
|
664
|
+
value: number;
|
|
665
|
+
total: number;
|
|
666
|
+
}[];
|
|
667
|
+
};
|
|
668
|
+
type PaymentOptionType = {
|
|
669
|
+
paymentSystem: string;
|
|
670
|
+
bin: any;
|
|
671
|
+
paymentName: string;
|
|
672
|
+
paymentGroupName: string;
|
|
673
|
+
value: number;
|
|
674
|
+
installments: PaymentOptionInstallmentType[];
|
|
675
|
+
};
|
|
676
|
+
type PaymentSystemType = {
|
|
677
|
+
id: number;
|
|
678
|
+
name: string;
|
|
679
|
+
groupName: string;
|
|
680
|
+
validator: any;
|
|
681
|
+
stringId: string;
|
|
682
|
+
template: string;
|
|
683
|
+
requiresDocument: boolean;
|
|
684
|
+
isCustom: boolean;
|
|
685
|
+
description: any;
|
|
686
|
+
requiresAuthentication: boolean;
|
|
687
|
+
dueDate: string;
|
|
688
|
+
availablePayments: any;
|
|
689
|
+
};
|
|
690
|
+
type PaymentOptionsType = {
|
|
691
|
+
installmentOptions: PaymentOptionType[];
|
|
692
|
+
paymentSystems: PaymentSystemType[];
|
|
693
|
+
payments: any[];
|
|
694
|
+
giftCards: any[];
|
|
695
|
+
giftCardMessages: any[];
|
|
696
|
+
availableAccounts: any[];
|
|
697
|
+
availableTokens: any[];
|
|
698
|
+
};
|
|
699
|
+
type DeliverySlaSampleType = {
|
|
700
|
+
DeliverySlaPerTypes: any[];
|
|
701
|
+
Region: any;
|
|
702
|
+
};
|
|
703
|
+
type InstallmentType = {
|
|
704
|
+
Value: number;
|
|
705
|
+
InterestRate: number;
|
|
706
|
+
TotalValuePlusInterestRate: number;
|
|
707
|
+
NumberOfInstallments: number;
|
|
708
|
+
PaymentSystemName: string;
|
|
709
|
+
PaymentSystemGroupName: string;
|
|
710
|
+
Name: string;
|
|
711
|
+
};
|
|
712
|
+
type CommertialOfferType = {
|
|
713
|
+
DeliverySlaSamplesPerRegion: {
|
|
714
|
+
[key: string]: DeliverySlaSampleType;
|
|
715
|
+
};
|
|
716
|
+
Installments: InstallmentType[];
|
|
717
|
+
DiscountHighLight: any[];
|
|
718
|
+
GiftSkuIds: any[];
|
|
719
|
+
Teasers: any[];
|
|
720
|
+
PromotionTeasers: any[];
|
|
721
|
+
BuyTogether: any[];
|
|
722
|
+
ItemMetadataAttachment: any[];
|
|
723
|
+
Price: number;
|
|
724
|
+
ListPrice: number;
|
|
725
|
+
spotPrice: number;
|
|
726
|
+
PriceWithoutDiscount: number;
|
|
727
|
+
FullSellingPrice: number;
|
|
728
|
+
RewardValue: number;
|
|
729
|
+
PriceValidUntil: string;
|
|
730
|
+
AvailableQuantity: number;
|
|
731
|
+
IsAvailable: boolean;
|
|
732
|
+
Tax: number;
|
|
733
|
+
DeliverySlaSamples: DeliverySlaSampleType[];
|
|
734
|
+
GetInfoErrorMessage: any;
|
|
735
|
+
CacheVersionUsedToCallCheckout: string;
|
|
736
|
+
PaymentOptions: PaymentOptionsType;
|
|
737
|
+
};
|
|
738
|
+
type SellerType = {
|
|
739
|
+
sellerId: string;
|
|
740
|
+
sellerName: string;
|
|
741
|
+
addToCartLink: string;
|
|
742
|
+
sellerDefault: boolean;
|
|
743
|
+
commertialOffer: CommertialOfferType;
|
|
744
|
+
};
|
|
745
|
+
interface CommonItemType {
|
|
746
|
+
itemId: string;
|
|
747
|
+
name: string;
|
|
748
|
+
nameComplete: string;
|
|
749
|
+
complementName: string;
|
|
750
|
+
ean: string;
|
|
751
|
+
referenceId: ReferenceIdType[];
|
|
752
|
+
measurementUnit: string;
|
|
753
|
+
unitMultiplier: number;
|
|
754
|
+
modalType: any | null;
|
|
755
|
+
images: ImageType[];
|
|
756
|
+
sellers: SellerType[];
|
|
757
|
+
isKit: boolean;
|
|
758
|
+
}
|
|
759
|
+
interface ItemType_PDP extends CommonItemType {
|
|
760
|
+
Tamanho: string[];
|
|
761
|
+
variations: string[];
|
|
762
|
+
Videos: any[];
|
|
763
|
+
estimatedDateArrival: string | null;
|
|
764
|
+
}
|
|
765
|
+
interface OfferingItem {
|
|
766
|
+
type: string;
|
|
767
|
+
id: number;
|
|
768
|
+
name: string;
|
|
769
|
+
price: number;
|
|
770
|
+
}
|
|
771
|
+
type CartItemOfferedImage = {
|
|
772
|
+
url: string;
|
|
773
|
+
alternateName: string;
|
|
774
|
+
};
|
|
775
|
+
type CartItemSpecification = {
|
|
776
|
+
propertyID: string;
|
|
777
|
+
value: string;
|
|
778
|
+
name: string;
|
|
779
|
+
valueReference: string;
|
|
780
|
+
};
|
|
781
|
+
type ProductType_PDC = {
|
|
782
|
+
index?: number;
|
|
783
|
+
item_list_name?: string | null | undefined;
|
|
784
|
+
sku: string;
|
|
785
|
+
gtin: string;
|
|
786
|
+
name: string;
|
|
787
|
+
description: string;
|
|
788
|
+
releaseDate: string;
|
|
789
|
+
slug: string;
|
|
790
|
+
video: string | null;
|
|
791
|
+
categories: string[];
|
|
792
|
+
categoryId: string;
|
|
793
|
+
categoriesIds: string[];
|
|
794
|
+
id: string;
|
|
795
|
+
brand: {
|
|
796
|
+
name: string;
|
|
797
|
+
};
|
|
798
|
+
seo: {
|
|
799
|
+
title: string;
|
|
800
|
+
description: string;
|
|
801
|
+
canonical: string;
|
|
802
|
+
};
|
|
803
|
+
cluster: {
|
|
804
|
+
generals: Array<{
|
|
805
|
+
id: string;
|
|
806
|
+
name: string;
|
|
807
|
+
}>;
|
|
808
|
+
highlights: Array<{
|
|
809
|
+
id: string;
|
|
810
|
+
name: string;
|
|
811
|
+
}>;
|
|
812
|
+
};
|
|
813
|
+
availability: {
|
|
814
|
+
status: boolean;
|
|
815
|
+
};
|
|
816
|
+
breadcrumbList: {
|
|
817
|
+
itemListElement: Array<{
|
|
818
|
+
item: string;
|
|
819
|
+
name: string;
|
|
820
|
+
position: number;
|
|
821
|
+
}>;
|
|
822
|
+
};
|
|
823
|
+
image: Array<{
|
|
824
|
+
url: string;
|
|
825
|
+
alternateName: string;
|
|
826
|
+
keywords: string;
|
|
827
|
+
}>;
|
|
828
|
+
offers: {
|
|
829
|
+
lowPrice: number;
|
|
830
|
+
highPrice: number;
|
|
831
|
+
priceCurrency: string;
|
|
832
|
+
offers: Array<{
|
|
833
|
+
availability: string;
|
|
834
|
+
listPrice: number;
|
|
835
|
+
price: number;
|
|
836
|
+
quantity: number;
|
|
837
|
+
priceValidUntil: string;
|
|
838
|
+
priceCurrency: string;
|
|
839
|
+
itemCondition: string;
|
|
840
|
+
seller: {
|
|
841
|
+
identifier: string;
|
|
842
|
+
};
|
|
843
|
+
}>;
|
|
844
|
+
};
|
|
845
|
+
additionalProperty?: Array<{
|
|
846
|
+
propertyID: string;
|
|
847
|
+
value: string | number;
|
|
848
|
+
name: string;
|
|
849
|
+
valueReference: string;
|
|
850
|
+
}>;
|
|
851
|
+
isVariantOf: {
|
|
852
|
+
productGroupID: string;
|
|
853
|
+
name: string;
|
|
854
|
+
hasVariant?: HasVariant[];
|
|
855
|
+
additionalProperty: Array<{
|
|
856
|
+
propertyID: string;
|
|
857
|
+
value: string | number;
|
|
858
|
+
name: string;
|
|
859
|
+
valueReference: string;
|
|
860
|
+
}>;
|
|
861
|
+
skuVariants: {
|
|
862
|
+
activeVariations: Record<string, string>;
|
|
863
|
+
allVariantsByName: Record<string, string[]>;
|
|
864
|
+
availableVariations: Record<string, Array<Record<string, string>>>;
|
|
865
|
+
} | null;
|
|
866
|
+
};
|
|
867
|
+
installments: {
|
|
868
|
+
count: number;
|
|
869
|
+
value: number;
|
|
870
|
+
};
|
|
871
|
+
};
|
|
872
|
+
interface ProductType_PDP extends CommonProductType_PDP_APISearch {
|
|
873
|
+
index?: number;
|
|
874
|
+
item_list_name?: string | null | undefined;
|
|
875
|
+
brandImageUrl: string | null;
|
|
876
|
+
productReferenceCode: string;
|
|
877
|
+
productTitle: string;
|
|
878
|
+
metaTagDescription: string;
|
|
879
|
+
searchableClusters: Record<string, string>;
|
|
880
|
+
Informação: string[];
|
|
881
|
+
'Tipo de Cor': string[];
|
|
882
|
+
Composição: string[];
|
|
883
|
+
'Tipo de Produto': string[];
|
|
884
|
+
SALE: string[];
|
|
885
|
+
Coleção: string[];
|
|
886
|
+
'Coleção Atual': string[];
|
|
887
|
+
'ID Coleção': string[];
|
|
888
|
+
'Tabela de Medidas': string[];
|
|
889
|
+
'Cores Filtráveis': string[];
|
|
890
|
+
Especificação: string[];
|
|
891
|
+
allSpecifications: string[];
|
|
892
|
+
allSpecificationsGroups: string[];
|
|
893
|
+
items: ItemType_PDP[];
|
|
894
|
+
skuSpecifications: {
|
|
895
|
+
field: {
|
|
896
|
+
id: number;
|
|
897
|
+
name: string;
|
|
898
|
+
isActive: boolean;
|
|
899
|
+
position: number;
|
|
900
|
+
type: string;
|
|
901
|
+
};
|
|
902
|
+
values: {
|
|
903
|
+
id: string;
|
|
904
|
+
name: string;
|
|
905
|
+
position: number;
|
|
906
|
+
}[];
|
|
907
|
+
}[];
|
|
908
|
+
}
|
|
909
|
+
type ProductType_Minicart = {
|
|
910
|
+
index?: number;
|
|
911
|
+
item_list_name?: string | null | undefined;
|
|
912
|
+
availability: string;
|
|
913
|
+
bundleItems: Record<string, never>[];
|
|
914
|
+
id: string;
|
|
915
|
+
uniqueId: string;
|
|
916
|
+
referenceId: Array<{
|
|
917
|
+
Key: string;
|
|
918
|
+
Value: string;
|
|
919
|
+
}>;
|
|
920
|
+
productRefId: string;
|
|
921
|
+
ean: string;
|
|
922
|
+
categories?: string[];
|
|
923
|
+
itemOffered: {
|
|
924
|
+
additionalProperty: CartItemSpecification[];
|
|
925
|
+
brand: Record<string, string>;
|
|
926
|
+
categories: string[];
|
|
927
|
+
categoriesIds: string;
|
|
928
|
+
gtin: string;
|
|
929
|
+
name: string;
|
|
930
|
+
image: CartItemOfferedImage[];
|
|
931
|
+
isVariationOf: {
|
|
932
|
+
name: string;
|
|
933
|
+
productGroupID: string;
|
|
934
|
+
};
|
|
935
|
+
sku: string;
|
|
936
|
+
skuName?: string;
|
|
937
|
+
slug: string;
|
|
938
|
+
};
|
|
939
|
+
listPrice: number;
|
|
940
|
+
quantity: number;
|
|
941
|
+
price: number;
|
|
942
|
+
sellingPrice: number;
|
|
943
|
+
priceDefinition: {
|
|
944
|
+
calculatedSellingPrice: number;
|
|
945
|
+
total: number;
|
|
946
|
+
sellingPrices: Array<{
|
|
947
|
+
value: number;
|
|
948
|
+
quantity: number;
|
|
949
|
+
}>;
|
|
950
|
+
};
|
|
951
|
+
seller: string;
|
|
952
|
+
offerings: OfferingItem[];
|
|
164
953
|
};
|
|
165
954
|
|
|
166
955
|
declare global {
|
|
@@ -169,175 +958,209 @@ declare global {
|
|
|
169
958
|
}
|
|
170
959
|
}
|
|
171
960
|
type EventName = keyof typeof EVENTS;
|
|
172
|
-
type
|
|
961
|
+
type ProductMeta = {
|
|
962
|
+
index?: number;
|
|
963
|
+
item_list_name?: string | undefined | null;
|
|
964
|
+
};
|
|
965
|
+
type AdapterPayload = {
|
|
966
|
+
adapter: 'HEADLESS';
|
|
967
|
+
zone: 'PDP';
|
|
968
|
+
products: (ProductType_PDP & ProductMeta)[];
|
|
969
|
+
} | {
|
|
970
|
+
adapter: 'HEADLESS';
|
|
971
|
+
zone: 'PDC';
|
|
972
|
+
products: (ProductType_PDC & ProductMeta)[];
|
|
973
|
+
} | {
|
|
974
|
+
adapter: 'HEADLESS';
|
|
975
|
+
zone: 'Minicart';
|
|
976
|
+
products: (ProductType_Minicart & ProductMeta)[];
|
|
977
|
+
} | {
|
|
978
|
+
adapter: 'DECO';
|
|
979
|
+
products: (Product & ProductMeta)[];
|
|
980
|
+
};
|
|
981
|
+
interface TrackMeta {
|
|
982
|
+
region?: string;
|
|
983
|
+
pre_filled?: boolean;
|
|
984
|
+
method?: string;
|
|
985
|
+
type?: string;
|
|
986
|
+
item_ref?: string;
|
|
987
|
+
size?: string;
|
|
988
|
+
search_term?: string;
|
|
989
|
+
search_found?: boolean;
|
|
990
|
+
search_quantity?: number;
|
|
991
|
+
zip_code?: string;
|
|
992
|
+
promotion_name?: string;
|
|
993
|
+
creative_name?: string;
|
|
994
|
+
creative_slot?: string;
|
|
995
|
+
coupon_code?: string;
|
|
996
|
+
currency?: string;
|
|
997
|
+
}
|
|
998
|
+
type RequiredMetaKeys<E extends EventName> = Extract<RequiredParamsOf<E>, keyof TrackMeta>;
|
|
999
|
+
type MetaForEvent<E extends EventName> = Required<Pick<TrackMeta, RequiredMetaKeys<E>>> & Omit<TrackMeta, RequiredMetaKeys<E>>;
|
|
173
1000
|
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
* @param context - Optional context used to build event parameters; may include a `window` property that will be attached to the dispatched payload.
|
|
179
|
-
* @returns The result returned by `dispatchTrackEvent` when the event is sent successfully, or the value returned by `console.error` (`undefined`) if an error occurs.
|
|
180
|
-
*/
|
|
181
|
-
declare function trackWebEvent(event: EventName, context?: EventContext): Promise<void>;
|
|
1001
|
+
declare function trackWebEvent<E extends EventName>(event: E, context: AdapterPayload & {
|
|
1002
|
+
meta: MetaForEvent<E>;
|
|
1003
|
+
window?: unknown;
|
|
1004
|
+
}): Promise<void>;
|
|
182
1005
|
|
|
183
1006
|
declare const _default: {
|
|
184
1007
|
trackWebEvent: typeof trackWebEvent;
|
|
185
1008
|
EVENTS: {
|
|
186
1009
|
CUSTOM_VIEW_CART: {
|
|
187
|
-
name:
|
|
188
|
-
hasEcommerce:
|
|
189
|
-
destinations:
|
|
190
|
-
requiredParams:
|
|
1010
|
+
readonly name: "custom_view_cart";
|
|
1011
|
+
readonly hasEcommerce: true;
|
|
1012
|
+
readonly destinations: readonly ["DataLayer"];
|
|
1013
|
+
readonly requiredParams: readonly ["brand", "region", "line_items", "currency", "value", "total_discount", "subtotal", "items"];
|
|
191
1014
|
};
|
|
192
1015
|
ADD_TO_WISHLIST: {
|
|
193
|
-
name:
|
|
194
|
-
hasEcommerce:
|
|
195
|
-
destinations:
|
|
196
|
-
requiredParams:
|
|
1016
|
+
readonly name: "add_to_wishlist";
|
|
1017
|
+
readonly hasEcommerce: true;
|
|
1018
|
+
readonly destinations: readonly ["DataLayer"];
|
|
1019
|
+
readonly requiredParams: readonly ["brand", "region", "line_items", "currency", "value", "items"];
|
|
197
1020
|
};
|
|
198
1021
|
CUSTOM_ADD_TO_CART: {
|
|
199
|
-
name:
|
|
200
|
-
hasEcommerce:
|
|
201
|
-
destinations:
|
|
202
|
-
requiredParams:
|
|
1022
|
+
readonly name: "custom_add_to_cart";
|
|
1023
|
+
readonly hasEcommerce: true;
|
|
1024
|
+
readonly destinations: readonly ["DataLayer"];
|
|
1025
|
+
readonly requiredParams: readonly ["brand", "region", "line_items", "currency", "value", "items"];
|
|
203
1026
|
};
|
|
204
1027
|
CUSTOM_REMOVE_FROM_CART: {
|
|
205
|
-
name:
|
|
206
|
-
hasEcommerce:
|
|
207
|
-
destinations:
|
|
208
|
-
requiredParams:
|
|
1028
|
+
readonly name: "custom_remove_from_cart";
|
|
1029
|
+
readonly hasEcommerce: true;
|
|
1030
|
+
readonly destinations: readonly ["DataLayer"];
|
|
1031
|
+
readonly requiredParams: readonly ["brand", "region", "line_items", "currency", "value", "items"];
|
|
209
1032
|
};
|
|
210
1033
|
ADD_TO_CART: {
|
|
211
|
-
name:
|
|
212
|
-
hasEcommerce:
|
|
213
|
-
destinations:
|
|
214
|
-
requiredParams:
|
|
1034
|
+
readonly name: "add_to_cart";
|
|
1035
|
+
readonly hasEcommerce: true;
|
|
1036
|
+
readonly destinations: readonly ["DataLayer"];
|
|
1037
|
+
readonly requiredParams: readonly ["brand", "region", "line_items", "currency", "value", "items"];
|
|
215
1038
|
};
|
|
216
1039
|
REMOVE_FROM_CART: {
|
|
217
|
-
name:
|
|
218
|
-
hasEcommerce:
|
|
219
|
-
destinations:
|
|
220
|
-
requiredParams:
|
|
1040
|
+
readonly name: "remove_from_cart";
|
|
1041
|
+
readonly hasEcommerce: true;
|
|
1042
|
+
readonly destinations: readonly ["DataLayer"];
|
|
1043
|
+
readonly requiredParams: readonly ["brand", "region", "line_items", "currency", "value", "items"];
|
|
221
1044
|
};
|
|
222
1045
|
ADD_COUPON: {
|
|
223
|
-
name:
|
|
224
|
-
hasEcommerce:
|
|
225
|
-
destinations:
|
|
226
|
-
requiredParams:
|
|
1046
|
+
readonly name: "add_coupon";
|
|
1047
|
+
readonly hasEcommerce: true;
|
|
1048
|
+
readonly destinations: readonly ["DataLayer"];
|
|
1049
|
+
readonly requiredParams: readonly ["brand", "region", "coupon", "coupon_message", "seller_cod_name"];
|
|
227
1050
|
};
|
|
228
1051
|
SEARCH: {
|
|
229
|
-
name:
|
|
230
|
-
hasEcommerce:
|
|
231
|
-
destinations:
|
|
232
|
-
requiredParams:
|
|
1052
|
+
readonly name: "search";
|
|
1053
|
+
readonly hasEcommerce: false;
|
|
1054
|
+
readonly destinations: readonly ["DataLayer"];
|
|
1055
|
+
readonly requiredParams: readonly ["brand", "search_term", "search_found", "search_quantity"];
|
|
233
1056
|
};
|
|
234
1057
|
SEARCH_ZIPCODE: {
|
|
235
|
-
name:
|
|
236
|
-
hasEcommerce:
|
|
237
|
-
destinations:
|
|
238
|
-
requiredParams:
|
|
1058
|
+
readonly name: "search_zipcode";
|
|
1059
|
+
readonly hasEcommerce: false;
|
|
1060
|
+
readonly destinations: readonly ["DataLayer"];
|
|
1061
|
+
readonly requiredParams: readonly ["brand", "region", "shippings", "zipcode", "flag_pickup"];
|
|
239
1062
|
};
|
|
240
1063
|
VIEW_PROMOTION: {
|
|
241
|
-
name:
|
|
242
|
-
hasEcommerce:
|
|
243
|
-
destinations:
|
|
244
|
-
requiredParams:
|
|
1064
|
+
readonly name: "view_promotion";
|
|
1065
|
+
readonly hasEcommerce: true;
|
|
1066
|
+
readonly destinations: readonly ["DataLayer"];
|
|
1067
|
+
readonly requiredParams: readonly ["brand", "region", "currency", "promotion_name", "creative_slot", "creative_name"];
|
|
245
1068
|
};
|
|
246
1069
|
SELECT_PROMOTION: {
|
|
247
|
-
name:
|
|
248
|
-
hasEcommerce:
|
|
249
|
-
destinations:
|
|
250
|
-
requiredParams:
|
|
1070
|
+
readonly name: "select_promotion";
|
|
1071
|
+
readonly hasEcommerce: true;
|
|
1072
|
+
readonly destinations: readonly ["DataLayer"];
|
|
1073
|
+
readonly requiredParams: readonly ["brand", "region", "currency", "promotion_name", "creative_slot", "creative_name"];
|
|
251
1074
|
};
|
|
252
1075
|
SELECT_CONTENT: {
|
|
253
|
-
name:
|
|
254
|
-
hasEcommerce:
|
|
255
|
-
destinations:
|
|
256
|
-
requiredParams:
|
|
1076
|
+
readonly name: "select_content";
|
|
1077
|
+
readonly hasEcommerce: false;
|
|
1078
|
+
readonly destinations: readonly ["DataLayer"];
|
|
1079
|
+
readonly requiredParams: readonly ["brand", "content_type"];
|
|
257
1080
|
};
|
|
258
1081
|
SELECT_ITEM: {
|
|
259
|
-
name:
|
|
260
|
-
hasEcommerce:
|
|
261
|
-
destinations:
|
|
262
|
-
requiredParams:
|
|
1082
|
+
readonly name: "select_item";
|
|
1083
|
+
readonly hasEcommerce: true;
|
|
1084
|
+
readonly destinations: readonly ["DataLayer"];
|
|
1085
|
+
readonly requiredParams: readonly ["brand", "region", "items", "line_items"];
|
|
263
1086
|
};
|
|
264
1087
|
VIEW_ITEM: {
|
|
265
|
-
name:
|
|
266
|
-
hasEcommerce:
|
|
267
|
-
destinations:
|
|
268
|
-
requiredParams:
|
|
1088
|
+
readonly name: "view_item";
|
|
1089
|
+
readonly hasEcommerce: true;
|
|
1090
|
+
readonly destinations: readonly ["DataLayer"];
|
|
1091
|
+
readonly requiredParams: readonly ["brand", "line_items", "currency", "value", "available_grid", "items"];
|
|
269
1092
|
};
|
|
270
1093
|
CUSTOM_VIEW_ITEM: {
|
|
271
|
-
name:
|
|
272
|
-
hasEcommerce:
|
|
273
|
-
destinations:
|
|
274
|
-
requiredParams:
|
|
1094
|
+
readonly name: "custom_view_item";
|
|
1095
|
+
readonly hasEcommerce: true;
|
|
1096
|
+
readonly destinations: readonly ["DataLayer"];
|
|
1097
|
+
readonly requiredParams: readonly ["brand", "line_items", "currency", "value", "available_grid", "items"];
|
|
275
1098
|
};
|
|
276
1099
|
VIEW_ITEM_LIST: {
|
|
277
|
-
name:
|
|
278
|
-
hasEcommerce:
|
|
279
|
-
destinations:
|
|
280
|
-
requiredParams:
|
|
1100
|
+
readonly name: "view_item_list";
|
|
1101
|
+
readonly hasEcommerce: true;
|
|
1102
|
+
readonly destinations: readonly ["DataLayer"];
|
|
1103
|
+
readonly requiredParams: readonly ["region", "brand", "line_items", "items"];
|
|
281
1104
|
};
|
|
282
1105
|
BEGIN_CHECKOUT: {
|
|
283
|
-
name:
|
|
284
|
-
hasEcommerce:
|
|
285
|
-
destinations:
|
|
286
|
-
requiredParams:
|
|
1106
|
+
readonly name: "begin_checkout";
|
|
1107
|
+
readonly hasEcommerce: true;
|
|
1108
|
+
readonly destinations: readonly ["DataLayer"];
|
|
1109
|
+
readonly requiredParams: readonly ["brand", "line_items", "currency", "value", "total_discount", "subtotal", "items"];
|
|
287
1110
|
};
|
|
288
1111
|
CUSTOM_BEGIN_CHECKOUT: {
|
|
289
|
-
name:
|
|
290
|
-
hasEcommerce:
|
|
291
|
-
destinations:
|
|
292
|
-
requiredParams:
|
|
1112
|
+
readonly name: "custom_begin_checkout";
|
|
1113
|
+
readonly hasEcommerce: true;
|
|
1114
|
+
readonly destinations: readonly ["DataLayer"];
|
|
1115
|
+
readonly requiredParams: readonly ["brand", "line_items", "currency", "value", "total_discount", "subtotal", "items"];
|
|
293
1116
|
};
|
|
294
1117
|
AUTH_ACTION: {
|
|
295
|
-
name:
|
|
296
|
-
hasEcommerce:
|
|
297
|
-
requiredParams:
|
|
298
|
-
destinations:
|
|
1118
|
+
readonly name: "auth_action";
|
|
1119
|
+
readonly hasEcommerce: false;
|
|
1120
|
+
readonly requiredParams: readonly ["region", "method", "type", "brand"];
|
|
1121
|
+
readonly destinations: readonly ["DataLayer"];
|
|
299
1122
|
};
|
|
300
1123
|
ADD_PERSONAL_INFO: {
|
|
301
|
-
name:
|
|
302
|
-
hasEcommerce:
|
|
303
|
-
destinations:
|
|
304
|
-
requiredParams:
|
|
1124
|
+
readonly name: "add_personal_info";
|
|
1125
|
+
readonly hasEcommerce: true;
|
|
1126
|
+
readonly destinations: readonly ["DataLayer"];
|
|
1127
|
+
readonly requiredParams: readonly ["brand", "pre_filled", "line_items", "currency", "value", "total_discount", "subtotal"];
|
|
305
1128
|
};
|
|
306
1129
|
CUSTOM_ADD_SHIPPING_INFO: {
|
|
307
|
-
name:
|
|
308
|
-
hasEcommerce:
|
|
309
|
-
destinations:
|
|
310
|
-
requiredParams:
|
|
1130
|
+
readonly name: "add_shipping_info";
|
|
1131
|
+
readonly hasEcommerce: true;
|
|
1132
|
+
readonly destinations: readonly ["DataLayer"];
|
|
1133
|
+
readonly requiredParams: readonly ["brand", "pre_filled", "shipping", "shipping_tier", "line_items", "currency", "value", "total_discount", "subtotal", "items"];
|
|
311
1134
|
};
|
|
312
1135
|
CUSTOM_ADD_PAYMENT_INFO: {
|
|
313
|
-
name:
|
|
314
|
-
hasEcommerce:
|
|
315
|
-
destinations:
|
|
316
|
-
requiredParams:
|
|
1136
|
+
readonly name: "add_payment_info";
|
|
1137
|
+
readonly hasEcommerce: true;
|
|
1138
|
+
readonly destinations: readonly ["DataLayer"];
|
|
1139
|
+
readonly requiredParams: readonly ["brand", "pre_filled", "line_items", "currency", "value", "total_discount", "payment_type", "subtotal", "items"];
|
|
317
1140
|
};
|
|
318
1141
|
ORDER_REVIEWED: {
|
|
319
|
-
name:
|
|
320
|
-
hasEcommerce:
|
|
321
|
-
destinations:
|
|
322
|
-
requiredParams:
|
|
1142
|
+
readonly name: "order_reviewed";
|
|
1143
|
+
readonly hasEcommerce: true;
|
|
1144
|
+
readonly destinations: readonly ["DataLayer"];
|
|
1145
|
+
readonly requiredParams: readonly ["brand", "line_items", "currency", "value", "total_discount", "subtotal", "payment_type"];
|
|
323
1146
|
};
|
|
324
1147
|
PURCHASE: {
|
|
325
|
-
name:
|
|
326
|
-
hasEcommerce:
|
|
327
|
-
destinations:
|
|
328
|
-
requiredParams:
|
|
1148
|
+
readonly name: "purchase";
|
|
1149
|
+
readonly hasEcommerce: true;
|
|
1150
|
+
readonly destinations: readonly ["DataLayer"];
|
|
1151
|
+
readonly requiredParams: readonly ["brand", "shipping_tier", "line_items", "currency", "value", "shipping", "transaction_id", "total_discount", "payment_type", "seller_cod_name", "subtotal", "coupon", "items"];
|
|
329
1152
|
};
|
|
330
1153
|
CUSTOM_PURCHASE: {
|
|
331
|
-
name:
|
|
332
|
-
hasEcommerce:
|
|
333
|
-
destinations:
|
|
334
|
-
requiredParams:
|
|
1154
|
+
readonly name: "custom_purchase";
|
|
1155
|
+
readonly hasEcommerce: true;
|
|
1156
|
+
readonly destinations: readonly ["DataLayer"];
|
|
1157
|
+
readonly requiredParams: readonly ["brand", "shipping_tier", "line_items", "currency", "value", "shipping", "transaction_id", "total_discount", "payment_type", "seller_cod_name", "subtotal", "coupon", "items"];
|
|
335
1158
|
};
|
|
336
1159
|
CUSTOM_USER_INFO: {
|
|
337
|
-
name:
|
|
338
|
-
hasEcommerce:
|
|
339
|
-
destinations:
|
|
340
|
-
requiredParams:
|
|
1160
|
+
readonly name: "custom_user_info";
|
|
1161
|
+
readonly hasEcommerce: false;
|
|
1162
|
+
readonly destinations: readonly ["DataLayer"];
|
|
1163
|
+
readonly requiredParams: readonly ["user_info"];
|
|
341
1164
|
};
|
|
342
1165
|
NOTIFY_ME: {
|
|
343
1166
|
name: string;
|
|
@@ -345,6 +1168,18 @@ declare const _default: {
|
|
|
345
1168
|
destinations: string[];
|
|
346
1169
|
requiredParams: string[];
|
|
347
1170
|
};
|
|
1171
|
+
REFINE_RESULTS: {
|
|
1172
|
+
readonly name: "refine_results";
|
|
1173
|
+
readonly hasEcommerce: false;
|
|
1174
|
+
readonly destinations: readonly ["DataLayer"];
|
|
1175
|
+
readonly requiredParams: readonly ["brand", "region", "color", "price_range", "size", "category", "ordering"];
|
|
1176
|
+
};
|
|
1177
|
+
GRID_SIZE: {
|
|
1178
|
+
readonly name: "grid_size";
|
|
1179
|
+
readonly hasEcommerce: false;
|
|
1180
|
+
readonly destinations: readonly ["DataLayer"];
|
|
1181
|
+
readonly requiredParams: readonly ["brand", "slot_per_line"];
|
|
1182
|
+
};
|
|
348
1183
|
};
|
|
349
1184
|
};
|
|
350
1185
|
|