@ordergroove/offers 2.26.3-alpha-PR-593-70.98 → 2.26.3-alpha-PR-615-3.53

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/README.md CHANGED
@@ -50,42 +50,8 @@ The state of the offer is maintained for all products. If you set the product at
50
50
 
51
51
  The state of opted-in products is stored in local storage, with the key `OG_STATE`. On page load, the offer element reads from local storage to recreate state for opted-in products. For example, if a user opts in to a product on a given page, offers for that same product will appear as opted in on all other pages.
52
52
 
53
-
54
- ### DOM Events
55
-
56
- |Event | Description | common scenarios |
57
- |-|-|-|
58
- | og-receive-offer | offers is ready to be rendered in the UI | Initialize custom UI logic when offer shows up |
59
- | og-optout-product | user has opted out the product |
60
- | og-optin-product | user has opted in the product |
61
- | og-product-change-frequency | user has changed the delivery frequency |
62
- | og-cart-updated | offer in the cart page has been changed | Perform side effect such as update the subtotal or total fields |
63
-
64
-
65
- ```js
66
-
67
- document.addEventListener('og-receive-offer', ev => {
68
- // ocurs when offers is ready to be rendered in the UI
69
- // initialize custom UI, style shadow dom
70
- const offer = ev.target;
71
- })
72
-
73
- document.addEventListener('og-optout-product', ev => {
74
- // perform a side-effect when OPTOUT_PRODUCT action happens
75
- })
76
-
77
- document.addEventListener('og-optin-product', ev => {
78
- // perform a side-effect when OPTIN_PRODUCT action happens
79
- })
80
-
81
- document.addEventListener('og-product-change-frequency', ev => {
82
- // perform a side-effect when PRODUCT_CHANGE_FREQUENCY action happens
83
- })
84
-
85
- ```
86
53
  ### Features
87
54
 
88
-
89
55
  #### Default optin by product
90
56
 
91
57
  The library supports the notion of default optin on a product-by-product basis. If a product is marked as optedin by default, the offer will appear as opted in upon initial load and for as long as the user has not explictly opted out. If a user explicitly opts out, the opt-out selection will be remembered for all offers across all pages for that same product.
@@ -4,59 +4,59 @@
4
4
  │ └ examples/index.js
5
5
  └ examples/index.js ───────────────────────────────────────── 8.3kb ─── 3.3%
6
6
 
7
- dist/offers.js ───────────────────────────────────────────── 119.9kb ─ 100.0%
8
- ├ src/components/Offer.js ─────────────────────────────────── 8.1kb ─── 6.7%
7
+ dist/offers.js ───────────────────────────────────────────── 116.1kb ─ 100.0%
8
+ ├ src/components/Offer.js ─────────────────────────────────── 8.0kb ─── 6.9%
9
9
  │ └ src/make-api.js
10
10
  │ └ src/index.js
11
- ├ node_modules/redux/es/redux.js ──────────────────────────── 6.7kb ─── 5.6%
11
+ ├ node_modules/redux/es/redux.js ──────────────────────────── 6.7kb ─── 5.8%
12
12
  │ └ src/shopify/shopifyReducer.js
13
13
  │ └ src/index.js
14
- ├ src/core/reducer.js ─────────────────────────────────────── 6.1kb ─── 5.1%
14
+ ├ src/core/reducer.js ─────────────────────────────────────── 6.1kb ─── 5.2%
15
15
  │ └ src/index.js
16
- ├ src/components/TestWizard.js ────────────────────────────── 5.5kb ─── 4.5%
16
+ ├ src/components/TestWizard.js ────────────────────────────── 5.5kb ─── 4.7%
17
17
  │ └ src/run-tests.js
18
18
  │ └ src/test-mode.js
19
19
  │ └ src/make-api.js
20
20
  │ └ src/index.js
21
- ├ node_modules/lit-element/lib/updating-element.js ────────── 5.4kb ─── 4.5%
21
+ ├ node_modules/lit-element/lib/updating-element.js ────────── 5.4kb ─── 4.6%
22
22
  │ └ node_modules/lit-element/lit-element.js
23
23
  │ └ src/components/Price.js
24
24
  │ └ src/make-api.js
25
25
  │ └ src/index.js
26
- ├ node_modules/lit-html/lib/parts.js ──────────────────────── 5.0kb ─── 4.1%
26
+ ├ node_modules/lit-html/lib/parts.js ──────────────────────── 5.0kb ─── 4.3%
27
27
  │ └ node_modules/lit-html/lit-html.js
28
28
  │ └ node_modules/lit-element/lit-element.js
29
29
  │ └ src/components/Price.js
30
30
  │ └ src/make-api.js
31
31
  │ └ src/index.js
32
- ├ src/components/Modal.js ─────────────────────────────────── 4.7kb ─── 4.0%
32
+ ├ src/components/Modal.js ─────────────────────────────────── 4.7kb ─── 4.1%
33
33
  │ └ src/make-api.js
34
34
  │ └ src/index.js
35
- ├ src/shopify/shopifyMiddleware.ts ────────────────────────── 4.6kb ─── 3.8%
36
- │ └ src/index.js
37
- ├ src/components/Tooltip.js ───────────────────────────────── 4.4kb ─── 3.6%
35
+ ├ src/components/Tooltip.js ───────────────────────────────── 4.4kb ─── 3.8%
38
36
  │ └ src/make-api.js
39
37
  │ └ src/index.js
40
- ├ node_modules/lodash.memoize/index.js ────────────────────── 4.0kb ─── 3.3%
38
+ ├ node_modules/lodash.memoize/index.js ────────────────────── 4.0kb ─── 3.4%
41
39
  │ └ src/shopify/shopifyMiddleware.ts
42
40
  │ └ src/index.js
43
- ├ src/core/actions.js ─────────────────────────────────────── 3.7kb ─── 3.1%
44
- │ └ src/shopify/shopifyBootstrap.ts
41
+ ├ src/core/actions.js ─────────────────────────────────────── 3.7kb ─── 3.2%
42
+ │ └ src/make-api.js
45
43
  │ └ src/index.js
46
- ├ src/shopify/shopifyReducer.js ───────────────────────────── 3.4kb ─── 2.9%
44
+ ├ src/shopify/shopifyMiddleware.ts ────────────────────────── 3.6kb ─── 3.1%
47
45
  │ └ src/index.js
48
- ├ src/make-api.js ─────────────────────────────────────────── 2.6kb ─── 2.2%
46
+ ├ src/shopify/shopifyReducer.js ───────────────────────────── 3.1kb ─── 2.7%
49
47
  │ └ src/index.js
50
- ├ src/core/api.js ─────────────────────────────────────────── 2.5kb ─── 2.1%
48
+ ├ src/core/api.js ─────────────────────────────────────────── 2.5kb ─── 2.2%
51
49
  │ └ src/core/reducer.js
52
50
  │ └ src/index.js
53
- ├ src/components/UpsellModal.js ───────────────────────────── 2.4kb ─── 2.0%
51
+ ├ src/make-api.js ─────────────────────────────────────────── 2.5kb ─── 2.2%
52
+ │ └ src/index.js
53
+ ├ src/components/UpsellModal.js ───────────────────────────── 2.4kb ─── 2.1%
54
54
  │ └ src/make-api.js
55
55
  │ └ src/index.js
56
56
  ├ src/components/OptinStatus.js ───────────────────────────── 2.2kb ─── 1.9%
57
57
  │ └ src/make-api.js
58
58
  │ └ src/index.js
59
- ├ src/core/actions-preview.js ─────────────────────────────── 2.2kb ─── 1.8%
59
+ ├ src/core/actions-preview.js ─────────────────────────────── 2.2kb ─── 1.9%
60
60
  │ └ src/components/Offer.js
61
61
  │ └ src/make-api.js
62
62
  │ └ src/index.js
@@ -65,10 +65,10 @@
65
65
  │ └ src/components/Price.js
66
66
  │ └ src/make-api.js
67
67
  │ └ src/index.js
68
- ├ src/components/IncentiveText.js ─────────────────────────── 2.0kb ─── 1.6%
68
+ ├ src/components/IncentiveText.js ─────────────────────────── 1.9kb ─── 1.6%
69
69
  │ └ src/make-api.js
70
70
  │ └ src/index.js
71
- ├ node_modules/lit-html/lib/template.js ───────────────────── 1.8kb ─── 1.5%
71
+ ├ node_modules/lit-html/lib/template.js ───────────────────── 1.8kb ─── 1.6%
72
72
  │ └ node_modules/lit-html/lit-html.js
73
73
  │ └ node_modules/lit-element/lit-element.js
74
74
  │ └ src/components/Price.js
@@ -78,7 +78,7 @@
78
78
  │ └ src/components/Price.js
79
79
  │ └ src/make-api.js
80
80
  │ └ src/index.js
81
- ├ src/components/SelectFrequency.js ───────────────────────── 1.7kb ─── 1.4%
81
+ ├ src/components/SelectFrequency.js ───────────────────────── 1.7kb ─── 1.5%
82
82
  │ └ src/make-api.js
83
83
  │ └ src/index.js
84
84
  ├ src/components/Select.js ────────────────────────────────── 1.6kb ─── 1.4%
@@ -87,6 +87,7 @@
87
87
  ├ src/components/FrequencyStatus.js ───────────────────────── 1.5kb ─── 1.3%
88
88
  │ └ src/make-api.js
89
89
  │ └ src/index.js
90
+ ├ src/index.js ────────────────────────────────────────────── 1.3kb ─── 1.1%
90
91
  ├ src/core/selectors.js ───────────────────────────────────── 1.3kb ─── 1.1%
91
92
  │ └ src/shopify/shopifyMiddleware.ts
92
93
  │ └ src/index.js
@@ -105,34 +106,31 @@
105
106
  │ └ src/components/When.js
106
107
  │ └ src/make-api.js
107
108
  │ └ src/index.js
108
- ├ src/shopify/shopifyBootstrap.ts ─────────────────────────── 1.1kb ─── 0.9%
109
- │ └ src/index.js
110
- ├ src/core/constants.js ───────────────────────────────────── 1.1kb ─── 0.9%
111
- │ └ src/core/utils.ts
112
- │ └ src/index.js
113
109
  ├ src/components/UpsellButton.js ──────────────────────────── 1.1kb ─── 0.9%
114
110
  │ └ src/make-api.js
115
111
  │ └ src/index.js
116
- ├ src/index.js ────────────────────────────────────────────── 1.1kb ─── 0.9%
117
112
  ├ node_modules/lit-html/lib/modify-template.js ────────────── 1.0kb ─── 0.9%
118
113
  │ └ node_modules/lit-html/lib/shady-render.js
119
114
  │ └ node_modules/lit-element/lit-element.js
120
115
  │ └ src/components/Price.js
121
116
  │ └ src/make-api.js
122
117
  │ └ src/index.js
123
- ├ node_modules/logical-expression-parser/node.js ──────────── 1.0kb ─── 0.8%
118
+ ├ node_modules/logical-expression-parser/node.js ──────────── 1.0kb ─── 0.9%
124
119
  │ └ node_modules/logical-expression-parser/index.js
125
120
  │ └ src/components/When.js
126
121
  │ └ src/make-api.js
127
122
  │ └ src/index.js
128
- ├ ../auth/dist/auth.js ───────────────────────────────────── 1021b ──── 0.8%
123
+ ├ ../auth/dist/auth.js ───────────────────────────────────── 1021b ──── 0.9%
129
124
  │ └ src/core/actions.js
130
- │ └ src/shopify/shopifyBootstrap.ts
125
+ │ └ src/make-api.js
131
126
  │ └ src/index.js
132
- ├ src/core/base.js ───────────────────────────────────────── 1011b ──── 0.8%
127
+ ├ src/core/base.js ───────────────────────────────────────── 1011b ──── 0.9%
133
128
  │ └ src/components/Price.js
134
129
  │ └ src/make-api.js
135
130
  │ └ src/index.js
131
+ ├ src/core/constants.js ──────────────────────────────────── 1009b ──── 0.8%
132
+ │ └ src/shopify/shopifyMiddleware.ts
133
+ │ └ src/index.js
136
134
  ├ node_modules/lit-html/lib/template-instance.js ─────────── 1008b ──── 0.8%
137
135
  │ └ node_modules/lit-html/lit-html.js
138
136
  │ └ node_modules/lit-element/lit-element.js
@@ -144,14 +142,10 @@
144
142
  │ └ src/components/Price.js
145
143
  │ └ src/make-api.js
146
144
  │ └ src/index.js
147
- ├ src/core/middleware.js ──────────────────────────────────── 951b ──── 0.8%
148
- │ └ src/core/store.js
149
- │ └ src/index.js
150
- ├ src/core/utils.ts ───────────────────────────────────────── 945b ──── 0.8%
151
- │ └ src/index.js
152
145
  ├ node_modules/throttle-debounce/index.umd.js ─────────────── 880b ──── 0.7%
153
- │ └ src/shopify/shopifyMiddleware.ts
154
- │ └ src/index.js
146
+ │ └ src/core/localStorage.js
147
+ │ └ src/make-api.js
148
+ │ └ src/index.js
155
149
  ├ src/components/Text.js ──────────────────────────────────── 862b ──── 0.7%
156
150
  │ └ src/make-api.js
157
151
  │ └ src/index.js
@@ -161,10 +155,10 @@
161
155
  ├ src/components/Price.js ─────────────────────────────────── 847b ──── 0.7%
162
156
  │ └ src/make-api.js
163
157
  │ └ src/index.js
164
- ├ src/core/localStorage.js ────────────────────────────────── 810b ──── 0.7%
158
+ ├ src/core/localStorage.js ────────────────────────────────── 809b ──── 0.7%
165
159
  │ └ src/make-api.js
166
160
  │ └ src/index.js
167
- ├ src/core/connect.js ─────────────────────────────────────── 794b ──── 0.6%
161
+ ├ src/core/connect.js ─────────────────────────────────────── 794b ──── 0.7%
168
162
  │ └ src/make-api.js
169
163
  │ └ src/index.js
170
164
  ├ src/components/OptinToggle.js ───────────────────────────── 689b ──── 0.6%
@@ -179,32 +173,35 @@
179
173
  │ └ src/components/Price.js
180
174
  │ └ src/make-api.js
181
175
  │ └ src/index.js
176
+ ├ src/core/middleware.js ──────────────────────────────────── 632b ──── 0.5%
177
+ │ └ src/core/store.js
178
+ │ └ src/index.js
182
179
  ├ node_modules/logical-expression-parser/polish.js ────────── 594b ──── 0.5%
183
180
  │ └ node_modules/logical-expression-parser/index.js
184
181
  │ └ src/components/When.js
185
182
  │ └ src/make-api.js
186
183
  │ └ src/index.js
187
- ├ src/core/adapters.js ────────────────────────────────────── 555b ──── 0.5%
184
+ ├ src/core/adapters.js ────────────────────────────────────── 554b ──── 0.5%
188
185
  │ └ src/make-api.js
189
186
  │ └ src/index.js
190
- ├ src/components/OptoutButton.js ──────────────────────────── 545b ──── 0.4%
187
+ ├ src/components/OptoutButton.js ──────────────────────────── 545b ──── 0.5%
191
188
  │ └ src/make-api.js
192
189
  │ └ src/index.js
193
- ├ src/components/When.js ──────────────────────────────────── 544b ──── 0.4%
190
+ ├ src/components/When.js ──────────────────────────────────── 544b ──── 0.5%
194
191
  │ └ src/make-api.js
195
192
  │ └ src/index.js
196
- ├ src/core/dateUtils.js ───────────────────────────────────── 541b ──── 0.4%
193
+ ├ src/core/dateUtils.js ───────────────────────────────────── 541b ──── 0.5%
197
194
  │ └ src/components/NextUpcomingOrder.js
198
195
  │ └ src/make-api.js
199
196
  │ └ src/index.js
200
- ├ src/core/store.js ───────────────────────────────────────── 391b ──── 0.3%
201
- │ └ src/index.js
202
197
  ├ node_modules/lit-html/lib/template-factory.js ───────────── 388b ──── 0.3%
203
198
  │ └ node_modules/lit-html/lit-html.js
204
199
  │ └ node_modules/lit-element/lit-element.js
205
200
  │ └ src/components/Price.js
206
201
  │ └ src/make-api.js
207
202
  │ └ src/index.js
203
+ ├ src/core/store.js ───────────────────────────────────────── 388b ──── 0.3%
204
+ │ └ src/index.js
208
205
  ├ src/components/NextUpcomingOrder.js ─────────────────────── 381b ──── 0.3%
209
206
  │ └ src/make-api.js
210
207
  │ └ src/index.js
@@ -213,7 +210,7 @@
213
210
  │ └ src/components/When.js
214
211
  │ └ src/make-api.js
215
212
  │ └ src/index.js
216
- ├ src/core/props.js ───────────────────────────────────────── 326b ──── 0.3%
213
+ ├ src/core/props.js ───────────────────────────────────────── 325b ──── 0.3%
217
214
  │ └ src/components/FrequencyStatus.js
218
215
  │ └ src/make-api.js
219
216
  │ └ src/index.js
@@ -252,8 +249,6 @@
252
249
  │ └ src/components/Price.js
253
250
  │ └ src/make-api.js
254
251
  │ └ src/index.js
255
- ├ src/platform.ts ─────────────────────────────────────────── 205b ──── 0.2%
256
- │ └ src/index.js
257
252
  ├ node_modules/logical-expression-parser/index.js ─────────── 196b ──── 0.2%
258
253
  │ └ src/components/When.js
259
254
  │ └ src/make-api.js
@@ -282,6 +277,8 @@
282
277
  │ └ src/components/Price.js
283
278
  │ └ src/make-api.js
284
279
  │ └ src/index.js
280
+ ├ src/platform.ts ──────────────────────────────────────────── 88b ──── 0.1%
281
+ │ └ src/index.js
285
282
  └ node_modules/lit-html/lib/part.js ────────────────────────── 32b ──── 0.0%
286
283
  └ node_modules/lit-html/lit-html.js
287
284
  └ node_modules/lit-element/lit-element.js