@saasquatch/squatch-js 2.5.1-9 → 2.6.0-0

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.
Files changed (70) hide show
  1. package/.github/workflows/size-limit.yml +15 -0
  2. package/CHANGELOG.md +326 -334
  3. package/LICENSE +20 -20
  4. package/README.md +180 -145
  5. package/babel.config.js +8 -0
  6. package/coverage/clover.xml +888 -0
  7. package/coverage/coverage-final.json +23 -0
  8. package/coverage/lcov-report/api/AnalyticsApi.ts.html +304 -0
  9. package/coverage/lcov-report/api/WidgetApi.ts.html +628 -0
  10. package/coverage/lcov-report/api/graphql.ts.html +130 -0
  11. package/coverage/lcov-report/base.css +224 -0
  12. package/coverage/lcov-report/block-navigation.js +87 -0
  13. package/coverage/lcov-report/favicon.png +0 -0
  14. package/coverage/lcov-report/prettify.css +1 -0
  15. package/coverage/lcov-report/prettify.js +2 -0
  16. package/coverage/lcov-report/sort-arrow-sprite.png +0 -0
  17. package/coverage/lcov-report/sorter.js +196 -0
  18. package/coverage/lcov-report/utils/cookieUtils.ts.html +415 -0
  19. package/coverage/lcov-report/utils/decodeUserJwt.ts.html +133 -0
  20. package/coverage/lcov-report/utils/domready.ts.html +160 -0
  21. package/coverage/lcov-report/utils/io.ts.html +385 -0
  22. package/coverage/lcov-report/utils/utmUtils.ts.html +277 -0
  23. package/coverage/lcov-report/utils/validate.ts.html +268 -0
  24. package/coverage/lcov-report/validate.ts.html +268 -0
  25. package/coverage/lcov-report/widgets/EmbedWidget.ts.html +436 -0
  26. package/coverage/lcov-report/widgets/PopupWidget.ts.html +625 -0
  27. package/coverage/lcov-report/widgets/Widget.ts.html +1108 -0
  28. package/coverage/lcov-report/widgets/declarative/DeclarativeWidget.ts.html +499 -0
  29. package/coverage/lcov.info +1628 -0
  30. package/demo/sandbox.ts +124 -124
  31. package/demo/toolbar.tsx +526 -526
  32. package/dist/api/AnalyticsApi.d.ts +32 -32
  33. package/dist/api/EventsApi.d.ts +52 -52
  34. package/dist/api/WidgetApi.d.ts +63 -80
  35. package/dist/api/graphql.d.ts +1 -1
  36. package/dist/async.d.ts +15 -11
  37. package/dist/docs.d.ts +1 -1
  38. package/dist/squatch.d.ts +108 -108
  39. package/dist/squatch.esm.js +1105 -1417
  40. package/dist/squatch.esm.js.map +1 -1
  41. package/dist/squatch.js +1105 -1438
  42. package/dist/squatch.js.map +1 -1
  43. package/dist/squatch.min.js +2 -13
  44. package/dist/squatch.min.js.LICENSE.txt +6 -0
  45. package/dist/squatch.min.js.map +1 -1
  46. package/dist/squatch.modern.js +1 -1
  47. package/dist/squatch.modern.js.map +1 -1
  48. package/dist/stats.html +1 -1
  49. package/dist/types.d.ts +107 -106
  50. package/dist/utils/cookieUtils.d.ts +2 -2
  51. package/dist/utils/decodeUserJwt.d.ts +2 -0
  52. package/dist/utils/domUtils.d.ts +1 -0
  53. package/dist/utils/domready.d.ts +6 -6
  54. package/dist/utils/io.d.ts +5 -13
  55. package/dist/utils/loadEvent.d.ts +2 -0
  56. package/dist/utils/utmUtils.d.ts +14 -14
  57. package/dist/utils/validate.d.ts +12 -16
  58. package/dist/widgets/EmbedWidget.d.ts +16 -15
  59. package/dist/widgets/IREmbedWidget.d.ts +29 -0
  60. package/dist/widgets/IRPopupWidget.d.ts +32 -0
  61. package/dist/widgets/PopupWidget.d.ts +25 -23
  62. package/dist/widgets/Widget.d.ts +53 -33
  63. package/dist/widgets/Widgets.d.ts +108 -116
  64. package/dist/widgets/declarative/DeclarativeEmbedWidget.d.ts +12 -0
  65. package/dist/widgets/declarative/DeclarativeWidget.d.ts +32 -0
  66. package/dist/widgets/declarative/DeclarativeWidgets.d.ts +13 -0
  67. package/jest.config.ts +202 -0
  68. package/package.json +123 -105
  69. package/stats.json +1 -0
  70. package/tsconfig.json +2 -2
package/coverage/lcov-report/api/AnalyticsApi.ts.html ADDED
@@ -0,0 +1,304 @@
1
+
2
+ <!doctype html>
3
+ <html lang="en">
4
+
5
+ <head>
6
+ <title>Code coverage report for api/AnalyticsApi.ts</title>
7
+ <meta charset="utf-8" />
8
+ <link rel="stylesheet" href="../prettify.css" />
9
+ <link rel="stylesheet" href="../base.css" />
10
+ <link rel="shortcut icon" type="image/x-icon" href="../favicon.png" />
11
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
12
+ <style type='text/css'>
13
+ .coverage-summary .sorter {
14
+ background-image: url(../sort-arrow-sprite.png);
15
+ }
16
+ </style>
17
+ </head>
18
+
19
+ <body>
20
+ <div class='wrapper'>
21
+ <div class='pad1'>
22
+ <h1><a href="../index.html">All files</a> / <a href="index.html">api</a> AnalyticsApi.ts</h1>
23
+ <div class='clearfix'>
24
+
25
+ <div class='fl pad1y space-right2'>
26
+ <span class="strong">11.11% </span>
27
+ <span class="quiet">Statements</span>
28
+ <span class='fraction'>3/27</span>
29
+ </div>
30
+
31
+
32
+ <div class='fl pad1y space-right2'>
33
+ <span class="strong">0% </span>
34
+ <span class="quiet">Branches</span>
35
+ <span class='fraction'>0/9</span>
36
+ </div>
37
+
38
+
39
+ <div class='fl pad1y space-right2'>
40
+ <span class="strong">0% </span>
41
+ <span class="quiet">Functions</span>
42
+ <span class='fraction'>0/4</span>
43
+ </div>
44
+
45
+
46
+ <div class='fl pad1y space-right2'>
47
+ <span class="strong">12% </span>
48
+ <span class="quiet">Lines</span>
49
+ <span class='fraction'>3/25</span>
50
+ </div>
51
+
52
+
53
+ </div>
54
+ <p class="quiet">
55
+ Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
56
+ </p>
57
+ <template id="filterTemplate">
58
+ <div class="quiet">
59
+ Filter:
60
+ <input oninput="onInput()" type="search" id="fileSearch">
61
+ </div>
62
+ </template>
63
+ </div>
64
+ <div class='status-line low'></div>
65
+ <pre><table class="coverage">
66
+ <tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a>
67
+ <a name='L2'></a><a href='#L2'>2</a>
68
+ <a name='L3'></a><a href='#L3'>3</a>
69
+ <a name='L4'></a><a href='#L4'>4</a>
70
+ <a name='L5'></a><a href='#L5'>5</a>
71
+ <a name='L6'></a><a href='#L6'>6</a>
72
+ <a name='L7'></a><a href='#L7'>7</a>
73
+ <a name='L8'></a><a href='#L8'>8</a>
74
+ <a name='L9'></a><a href='#L9'>9</a>
75
+ <a name='L10'></a><a href='#L10'>10</a>
76
+ <a name='L11'></a><a href='#L11'>11</a>
77
+ <a name='L12'></a><a href='#L12'>12</a>
78
+ <a name='L13'></a><a href='#L13'>13</a>
79
+ <a name='L14'></a><a href='#L14'>14</a>
80
+ <a name='L15'></a><a href='#L15'>15</a>
81
+ <a name='L16'></a><a href='#L16'>16</a>
82
+ <a name='L17'></a><a href='#L17'>17</a>
83
+ <a name='L18'></a><a href='#L18'>18</a>
84
+ <a name='L19'></a><a href='#L19'>19</a>
85
+ <a name='L20'></a><a href='#L20'>20</a>
86
+ <a name='L21'></a><a href='#L21'>21</a>
87
+ <a name='L22'></a><a href='#L22'>22</a>
88
+ <a name='L23'></a><a href='#L23'>23</a>
89
+ <a name='L24'></a><a href='#L24'>24</a>
90
+ <a name='L25'></a><a href='#L25'>25</a>
91
+ <a name='L26'></a><a href='#L26'>26</a>
92
+ <a name='L27'></a><a href='#L27'>27</a>
93
+ <a name='L28'></a><a href='#L28'>28</a>
94
+ <a name='L29'></a><a href='#L29'>29</a>
95
+ <a name='L30'></a><a href='#L30'>30</a>
96
+ <a name='L31'></a><a href='#L31'>31</a>
97
+ <a name='L32'></a><a href='#L32'>32</a>
98
+ <a name='L33'></a><a href='#L33'>33</a>
99
+ <a name='L34'></a><a href='#L34'>34</a>
100
+ <a name='L35'></a><a href='#L35'>35</a>
101
+ <a name='L36'></a><a href='#L36'>36</a>
102
+ <a name='L37'></a><a href='#L37'>37</a>
103
+ <a name='L38'></a><a href='#L38'>38</a>
104
+ <a name='L39'></a><a href='#L39'>39</a>
105
+ <a name='L40'></a><a href='#L40'>40</a>
106
+ <a name='L41'></a><a href='#L41'>41</a>
107
+ <a name='L42'></a><a href='#L42'>42</a>
108
+ <a name='L43'></a><a href='#L43'>43</a>
109
+ <a name='L44'></a><a href='#L44'>44</a>
110
+ <a name='L45'></a><a href='#L45'>45</a>
111
+ <a name='L46'></a><a href='#L46'>46</a>
112
+ <a name='L47'></a><a href='#L47'>47</a>
113
+ <a name='L48'></a><a href='#L48'>48</a>
114
+ <a name='L49'></a><a href='#L49'>49</a>
115
+ <a name='L50'></a><a href='#L50'>50</a>
116
+ <a name='L51'></a><a href='#L51'>51</a>
117
+ <a name='L52'></a><a href='#L52'>52</a>
118
+ <a name='L53'></a><a href='#L53'>53</a>
119
+ <a name='L54'></a><a href='#L54'>54</a>
120
+ <a name='L55'></a><a href='#L55'>55</a>
121
+ <a name='L56'></a><a href='#L56'>56</a>
122
+ <a name='L57'></a><a href='#L57'>57</a>
123
+ <a name='L58'></a><a href='#L58'>58</a>
124
+ <a name='L59'></a><a href='#L59'>59</a>
125
+ <a name='L60'></a><a href='#L60'>60</a>
126
+ <a name='L61'></a><a href='#L61'>61</a>
127
+ <a name='L62'></a><a href='#L62'>62</a>
128
+ <a name='L63'></a><a href='#L63'>63</a>
129
+ <a name='L64'></a><a href='#L64'>64</a>
130
+ <a name='L65'></a><a href='#L65'>65</a>
131
+ <a name='L66'></a><a href='#L66'>66</a>
132
+ <a name='L67'></a><a href='#L67'>67</a>
133
+ <a name='L68'></a><a href='#L68'>68</a>
134
+ <a name='L69'></a><a href='#L69'>69</a>
135
+ <a name='L70'></a><a href='#L70'>70</a>
136
+ <a name='L71'></a><a href='#L71'>71</a>
137
+ <a name='L72'></a><a href='#L72'>72</a>
138
+ <a name='L73'></a><a href='#L73'>73</a>
139
+ <a name='L74'></a><a href='#L74'>74</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
140
+ <span class="cline-any cline-yes">1x</span>
141
+ <span class="cline-any cline-neutral">&nbsp;</span>
142
+ <span class="cline-any cline-yes">1x</span>
143
+ <span class="cline-any cline-neutral">&nbsp;</span>
144
+ <span class="cline-any cline-neutral">&nbsp;</span>
145
+ <span class="cline-any cline-neutral">&nbsp;</span>
146
+ <span class="cline-any cline-neutral">&nbsp;</span>
147
+ <span class="cline-any cline-neutral">&nbsp;</span>
148
+ <span class="cline-any cline-neutral">&nbsp;</span>
149
+ <span class="cline-any cline-neutral">&nbsp;</span>
150
+ <span class="cline-any cline-neutral">&nbsp;</span>
151
+ <span class="cline-any cline-yes">1x</span>
152
+ <span class="cline-any cline-neutral">&nbsp;</span>
153
+ <span class="cline-any cline-neutral">&nbsp;</span>
154
+ <span class="cline-any cline-neutral">&nbsp;</span>
155
+ <span class="cline-any cline-neutral">&nbsp;</span>
156
+ <span class="cline-any cline-neutral">&nbsp;</span>
157
+ <span class="cline-any cline-neutral">&nbsp;</span>
158
+ <span class="cline-any cline-neutral">&nbsp;</span>
159
+ <span class="cline-any cline-neutral">&nbsp;</span>
160
+ <span class="cline-any cline-neutral">&nbsp;</span>
161
+ <span class="cline-any cline-no">&nbsp;</span>
162
+ <span class="cline-any cline-no">&nbsp;</span>
163
+ <span class="cline-any cline-no">&nbsp;</span>
164
+ <span class="cline-any cline-neutral">&nbsp;</span>
165
+ <span class="cline-any cline-neutral">&nbsp;</span>
166
+ <span class="cline-any cline-neutral">&nbsp;</span>
167
+ <span class="cline-any cline-neutral">&nbsp;</span>
168
+ <span class="cline-any cline-no">&nbsp;</span>
169
+ <span class="cline-any cline-neutral">&nbsp;</span>
170
+ <span class="cline-any cline-no">&nbsp;</span>
171
+ <span class="cline-any cline-no">&nbsp;</span>
172
+ <span class="cline-any cline-no">&nbsp;</span>
173
+ <span class="cline-any cline-no">&nbsp;</span>
174
+ <span class="cline-any cline-no">&nbsp;</span>
175
+ <span class="cline-any cline-neutral">&nbsp;</span>
176
+ <span class="cline-any cline-neutral">&nbsp;</span>
177
+ <span class="cline-any cline-neutral">&nbsp;</span>
178
+ <span class="cline-any cline-no">&nbsp;</span>
179
+ <span class="cline-any cline-no">&nbsp;</span>
180
+ <span class="cline-any cline-neutral">&nbsp;</span>
181
+ <span class="cline-any cline-no">&nbsp;</span>
182
+ <span class="cline-any cline-neutral">&nbsp;</span>
183
+ <span class="cline-any cline-neutral">&nbsp;</span>
184
+ <span class="cline-any cline-neutral">&nbsp;</span>
185
+ <span class="cline-any cline-no">&nbsp;</span>
186
+ <span class="cline-any cline-no">&nbsp;</span>
187
+ <span class="cline-any cline-no">&nbsp;</span>
188
+ <span class="cline-any cline-no">&nbsp;</span>
189
+ <span class="cline-any cline-no">&nbsp;</span>
190
+ <span class="cline-any cline-neutral">&nbsp;</span>
191
+ <span class="cline-any cline-no">&nbsp;</span>
192
+ <span class="cline-any cline-no">&nbsp;</span>
193
+ <span class="cline-any cline-neutral">&nbsp;</span>
194
+ <span class="cline-any cline-no">&nbsp;</span>
195
+ <span class="cline-any cline-neutral">&nbsp;</span>
196
+ <span class="cline-any cline-neutral">&nbsp;</span>
197
+ <span class="cline-any cline-neutral">&nbsp;</span>
198
+ <span class="cline-any cline-neutral">&nbsp;</span>
199
+ <span class="cline-any cline-neutral">&nbsp;</span>
200
+ <span class="cline-any cline-neutral">&nbsp;</span>
201
+ <span class="cline-any cline-no">&nbsp;</span>
202
+ <span class="cline-any cline-no">&nbsp;</span>
203
+ <span class="cline-any cline-neutral">&nbsp;</span>
204
+ <span class="cline-any cline-neutral">&nbsp;</span>
205
+ <span class="cline-any cline-neutral">&nbsp;</span>
206
+ <span class="cline-any cline-neutral">&nbsp;</span>
207
+ <span class="cline-any cline-neutral">&nbsp;</span>
208
+ <span class="cline-any cline-neutral">&nbsp;</span>
209
+ <span class="cline-any cline-neutral">&nbsp;</span>
210
+ <span class="cline-any cline-neutral">&nbsp;</span>
211
+ <span class="cline-any cline-neutral">&nbsp;</span>
212
+ <span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">// @ts-check
213
+ import { doPost } from "../utils/io";
214
+ import { EngagementMedium } from "../types";
215
+ import { DEFAULT_DOMAIN, isObject } from "../utils/validate";
216
+ &nbsp;
217
+ /**
218
+ *
219
+ * The AnalyticsApi class is a wrapper around the Analytics Endpoints of
220
+ * the SaaSquatch REST API. Used to record Widget events.
221
+ *
222
+ * @hidden
223
+ */
224
+ export default class AnalyticsApi {
225
+ domain: string;
226
+ /**
227
+ * Initialize a new {@link AnalyticsApi} instance.
228
+ *
229
+ * @param {Object} config Config details
230
+ * @param {string} [config.domain='https://app.referralsaasquatch.com'] The server domain.
231
+ *
232
+ */
233
+ <span class="fstat-no" title="function not covered" > constructor(c</span>onfig: { domain: string }) {
234
+ const raw = <span class="cstat-no" title="statement not covered" >config as unknown | undefined;</span>
235
+ const clean = <span class="cstat-no" title="statement not covered" >_validateAnalyticsConfig(raw);</span>
236
+ <span class="cstat-no" title="statement not covered" > this.domain =</span>
237
+ clean?.["domain"] || window.squatchConfig?.domain || DEFAULT_DOMAIN;
238
+ }
239
+ &nbsp;
240
+ <span class="fstat-no" title="function not covered" > pushAnalyticsLoadEvent(</span>params: SQHDetails) {
241
+ <span class="cstat-no" title="statement not covered" > <span class="missing-if-branch" title="if path not taken" >I</span>if (!params.externalUserId || !params.externalAccountId) <span class="cstat-no" title="statement not covered" >return;</span></span>
242
+ &nbsp;
243
+ const tenantAlias = <span class="cstat-no" title="statement not covered" >encodeURIComponent(params.tenantAlias);</span>
244
+ const accountId = <span class="cstat-no" title="statement not covered" >encodeURIComponent(params.externalAccountId);</span>
245
+ const userId = <span class="cstat-no" title="statement not covered" >encodeURIComponent(params.externalUserId);</span>
246
+ const engagementMedium = <span class="cstat-no" title="statement not covered" >encodeURIComponent(params.engagementMedium);</span>
247
+ const programId = <span class="cstat-no" title="statement not covered" >params.programId</span>
248
+ ? `&amp;programId=${encodeURIComponent(params.programId)}`
249
+ : ``;
250
+ &nbsp;
251
+ const path = <span class="cstat-no" title="statement not covered" >`/a/${tenantAlias}/widgets/analytics/loaded?externalAccountId=${accountId}&amp;externalUserId=${userId}&amp;engagementMedium=${engagementMedium}${programId}`;</span>
252
+ const url = <span class="cstat-no" title="statement not covered" >this.domain + path;</span>
253
+ &nbsp;
254
+ <span class="cstat-no" title="statement not covered" > return doPost(url, JSON.stringify({}));</span>
255
+ }
256
+ &nbsp;
257
+ <span class="fstat-no" title="function not covered" > pushAnalyticsShareClickedEvent(</span>params: SQHDetails &amp; { shareMedium: string }) {
258
+ const tenantAlias = <span class="cstat-no" title="statement not covered" >encodeURIComponent(params.tenantAlias);</span>
259
+ const accountId = <span class="cstat-no" title="statement not covered" >encodeURIComponent(params.externalAccountId);</span>
260
+ const userId = <span class="cstat-no" title="statement not covered" >encodeURIComponent(params.externalUserId);</span>
261
+ const engagementMedium = <span class="cstat-no" title="statement not covered" >encodeURIComponent(params.engagementMedium);</span>
262
+ const shareMedium = <span class="cstat-no" title="statement not covered" >encodeURIComponent(params.shareMedium);</span>
263
+ &nbsp;
264
+ const path = <span class="cstat-no" title="statement not covered" >`/a/${tenantAlias}/widgets/analytics/shared?externalAccountId=${accountId}&amp;externalUserId=${userId}&amp;engagementMedium=${engagementMedium}&amp;shareMedium=${shareMedium}`;</span>
265
+ const url = <span class="cstat-no" title="statement not covered" >this.domain + path;</span>
266
+ &nbsp;
267
+ <span class="cstat-no" title="statement not covered" > return doPost(url, JSON.stringify({}));</span>
268
+ }
269
+ }
270
+ &nbsp;
271
+ function <span class="fstat-no" title="function not covered" >_validateAnalyticsConfig(</span>raw: unknown | undefined): {
272
+ domain?: string;
273
+ } {
274
+ <span class="cstat-no" title="statement not covered" > <span class="missing-if-branch" title="if path not taken" >I</span>if (!isObject(raw)) <span class="cstat-no" title="statement not covered" >throw new Error("'options' should be an object");</span></span>
275
+ <span class="cstat-no" title="statement not covered" > return raw as { domain?: string };</span>
276
+ }
277
+ &nbsp;
278
+ export type SQHDetails = {
279
+ tenantAlias: string;
280
+ externalAccountId: string;
281
+ externalUserId: string;
282
+ engagementMedium: EngagementMedium;
283
+ programId?: string;
284
+ };
285
+ &nbsp;</pre></td></tr></table></pre>
286
+
287
+ <div class='push'></div><!-- for sticky footer -->
288
+ </div><!-- /wrapper -->
289
+ <div class='footer quiet pad2 space-top1 center small'>
290
+ Code coverage generated by
291
+ <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
292
+ at 2023-07-03T20:35:44.061Z
293
+ </div>
294
+ <script src="../prettify.js"></script>
295
+ <script>
296
+ window.onload = function () {
297
+ prettyPrint();
298
+ };
299
+ </script>
300
+ <script src="../sorter.js"></script>
301
+ <script src="../block-navigation.js"></script>
302
+ </body>
303
+ </html>
304
+