update types

Author: v-i-s-h-n-u-ps

.github/workflows/codeql-analysis.yml

@@ -42,7 +42,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
+      uses: github/codeql-action/init@v3
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -53,7 +53,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
+      uses: github/codeql-action/autobuild@v3
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -67,4 +67,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      uses: github/codeql-action/analyze@v3

.github/workflows/dependabot-alerts-to-slack.yml

@@ -0,0 +1,15 @@
+name: 'Check for Dependabot alerts & send them to Slack'
+
+on:
+  schedule:
+    - cron: '30 16 * * *' # every day at 9:30 am PST
+  workflow_dispatch: # to have the option to run this ad-hoc
+
+jobs:
+  main:
+    uses: Constructor-io/customer-integrations-public-github-workflows/.github/workflows/dependabot-alerts-to-slack.yml@main
+    secrets:
+      github-app-id: ${{ vars.DEPENDABOT_ACCESS_APP_ID }}
+      github-app-private-key: ${{ secrets.DEPENDABOT_ACCESS_PRIVATE_KEY }}
+      slack-webhook: ${{ secrets.CUSTOMER_INTEGRATIONS_SLACK_WEBHOOK }}
+

.github/workflows/run-tests-bundled.yml

@@ -0,0 +1,28 @@
+name: Run tests - Bundled
+on:
+  pull_request:
+    branches:
+      - "**"
+concurrency:
+  group: run-tests-bundled-${{ github.head_ref }}
+  cancel-in-progress: true
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node: ["18.13.0"]
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v2
+      - name: Set up node
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node }}
+      - name: Install dependencies
+        run: npm install
+      - name: Run tests
+        run: npm run test:bundled:parallel
+        env:
+          TEST_REQUEST_API_KEY: ${{ secrets.TEST_REQUEST_API_KEY }}
+          SKIP_NETWORK_TIMEOUT_TESTS: true

.github/workflows/run-tests.yml

@@ -22,7 +22,7 @@ jobs:
       - name: Install dependencies
         run: npm install
       - name: Run tests
-        run: npm run test:all:parallel
+        run: npm run test:parallel
         env:
           TEST_REQUEST_API_KEY: ${{ secrets.TEST_REQUEST_API_KEY }}
           SKIP_NETWORK_TIMEOUT_TESTS: true

.github/workflows/spell-check.yml

@@ -27,4 +27,4 @@ jobs:
           node-version: ${{ matrix.node }}
 
       - name: Spell check
-        run: npx cspell "**/*.js"
+        run: npx cspell@v8.19.4 "**/*.js"

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Constructor.io
+Copyright (c) 2019 Constructor.io Corporation
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

cspell.json

@@ -46,5 +46,7 @@
     "reranker",
     "rerank",
     "atcs",
+    "testdata",
+    "Bytespider"
   ]
 }

dist/constructorio-client-javascript-2.37.2.js

@@ -31,7 +31,7 @@
     <input type="text" id="nav-search" placeholder="Search" />
 
 
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="ConstructorIO.html">ConstructorIO</a><ul class='methods'><li data-type='method'><a href="ConstructorIO.html#setClientOptions">setClientOptions</a></li></ul></li></ul><h3>Modules</h3><ul><li><a href="module-autocomplete.html">autocomplete</a><ul class='methods'><li data-type='method'><a href="module-autocomplete.html#~getAutocompleteResults">getAutocompleteResults</a></li></ul></li><li><a href="module-browse.html">browse</a><ul class='methods'><li data-type='method'><a href="module-browse.html#~getBrowseFacetOptions">getBrowseFacetOptions</a></li><li data-type='method'><a href="module-browse.html#~getBrowseFacets">getBrowseFacets</a></li><li data-type='method'><a href="module-browse.html#~getBrowseGroups">getBrowseGroups</a></li><li data-type='method'><a href="module-browse.html#~getBrowseResults">getBrowseResults</a></li><li data-type='method'><a href="module-browse.html#~getBrowseResultsForItemIds">getBrowseResultsForItemIds</a></li></ul></li><li><a href="module-quizzes.html">quizzes</a><ul class='methods'><li data-type='method'><a href="module-quizzes.html#~getQuizNextQuestion">getQuizNextQuestion</a></li><li data-type='method'><a href="module-quizzes.html#~getQuizResults">getQuizResults</a></li></ul></li><li><a href="module-recommendations.html">recommendations</a><ul class='methods'><li data-type='method'><a href="module-recommendations.html#~getRecommendations">getRecommendations</a></li></ul></li><li><a href="module-search.html">search</a><ul class='methods'><li data-type='method'><a href="module-search.html#~getSearchResults">getSearchResults</a></li><li data-type='method'><a href="module-search.html#~getVoiceSearchResults">getVoiceSearchResults</a></li></ul></li><li><a href="module-tracker.html">tracker</a><ul class='methods'><li data-type='method'><a href="module-tracker.html#~on">on</a></li><li data-type='method'><a href="module-tracker.html#~trackAutocompleteSelect">trackAutocompleteSelect</a></li><li data-type='method'><a href="module-tracker.html#~trackBrowseResultClick">trackBrowseResultClick</a></li><li data-type='method'><a href="module-tracker.html#~trackBrowseResultsLoaded">trackBrowseResultsLoaded</a></li><li data-type='method'><a href="module-tracker.html#~trackConversion">trackConversion</a></li><li data-type='method'><a href="module-tracker.html#~trackGenericResultClick">trackGenericResultClick</a></li><li data-type='method'><a href="module-tracker.html#~trackInputFocus">trackInputFocus</a></li><li data-type='method'><a href="module-tracker.html#~trackItemDetailLoad">trackItemDetailLoad</a></li><li data-type='method'><a href="module-tracker.html#~trackPurchase">trackPurchase</a></li><li data-type='method'><a href="module-tracker.html#~trackQuizConversion">trackQuizConversion</a></li><li data-type='method'><a href="module-tracker.html#~trackQuizResultClick">trackQuizResultClick</a></li><li data-type='method'><a href="module-tracker.html#~trackQuizResultsLoaded">trackQuizResultsLoaded</a></li><li data-type='method'><a href="module-tracker.html#~trackRecommendationClick">trackRecommendationClick</a></li><li data-type='method'><a href="module-tracker.html#~trackRecommendationView">trackRecommendationView</a></li><li data-type='method'><a href="module-tracker.html#~trackSearchResultClick">trackSearchResultClick</a></li><li data-type='method'><a href="module-tracker.html#~trackSearchResultsLoaded">trackSearchResultsLoaded</a></li><li data-type='method'><a href="module-tracker.html#~trackSearchSubmit">trackSearchSubmit</a></li><li data-type='method'><a href="module-tracker.html#~trackSessionStart">trackSessionStart</a></li></ul></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="ConstructorIO.html">ConstructorIO</a><ul class='methods'><li data-type='method'><a href="ConstructorIO.html#setClientOptions">setClientOptions</a></li></ul></li></ul><h3>Modules</h3><ul><li><a href="module-assistant.html">assistant</a><ul class='methods'><li data-type='method'><a href="module-assistant.html#~getAssistantResultsStream">getAssistantResultsStream</a></li></ul></li><li><a href="module-autocomplete.html">autocomplete</a><ul class='methods'><li data-type='method'><a href="module-autocomplete.html#~getAutocompleteResults">getAutocompleteResults</a></li></ul></li><li><a href="module-browse.html">browse</a><ul class='methods'><li data-type='method'><a href="module-browse.html#~getBrowseFacetOptions">getBrowseFacetOptions</a></li><li data-type='method'><a href="module-browse.html#~getBrowseFacets">getBrowseFacets</a></li><li data-type='method'><a href="module-browse.html#~getBrowseGroups">getBrowseGroups</a></li><li data-type='method'><a href="module-browse.html#~getBrowseResults">getBrowseResults</a></li><li data-type='method'><a href="module-browse.html#~getBrowseResultsForItemIds">getBrowseResultsForItemIds</a></li></ul></li><li><a href="module-quizzes.html">quizzes</a><ul class='methods'><li data-type='method'><a href="module-quizzes.html#~getQuizNextQuestion">getQuizNextQuestion</a></li><li data-type='method'><a href="module-quizzes.html#~getQuizResults">getQuizResults</a></li><li data-type='method'><a href="module-quizzes.html#~getQuizResultsConfig">getQuizResultsConfig</a></li></ul></li><li><a href="module-recommendations.html">recommendations</a><ul class='methods'><li data-type='method'><a href="module-recommendations.html#~getRecommendations">getRecommendations</a></li></ul></li><li><a href="module-search.html">search</a><ul class='methods'><li data-type='method'><a href="module-search.html#~getSearchResults">getSearchResults</a></li><li data-type='method'><a href="module-search.html#~getVoiceSearchResults">getVoiceSearchResults</a></li></ul></li><li><a href="module-tracker.html">tracker</a><ul class='methods'><li data-type='method'><a href="module-tracker.html#~on">on</a></li><li data-type='method'><a href="module-tracker.html#~trackAssistantResultClick">trackAssistantResultClick</a></li><li data-type='method'><a href="module-tracker.html#~trackAssistantResultLoadFinished">trackAssistantResultLoadFinished</a></li><li data-type='method'><a href="module-tracker.html#~trackAssistantResultLoadStarted">trackAssistantResultLoadStarted</a></li><li data-type='method'><a href="module-tracker.html#~trackAssistantResultView">trackAssistantResultView</a></li><li data-type='method'><a href="module-tracker.html#~trackAssistantSearchSubmit">trackAssistantSearchSubmit</a></li><li data-type='method'><a href="module-tracker.html#~trackAssistantSubmit">trackAssistantSubmit</a></li><li data-type='method'><a href="module-tracker.html#~trackAutocompleteSelect">trackAutocompleteSelect</a></li><li data-type='method'><a href="module-tracker.html#~trackBrowseResultClick">trackBrowseResultClick</a></li><li data-type='method'><a href="module-tracker.html#~trackBrowseResultsLoaded">trackBrowseResultsLoaded</a></li><li data-type='method'><a href="module-tracker.html#~trackConversion">trackConversion</a></li><li data-type='method'><a href="module-tracker.html#~trackGenericResultClick">trackGenericResultClick</a></li><li data-type='method'><a href="module-tracker.html#~trackInputFocus">trackInputFocus</a></li><li data-type='method'><a href="module-tracker.html#~trackItemDetailLoad">trackItemDetailLoad</a></li><li data-type='method'><a href="module-tracker.html#~trackPurchase">trackPurchase</a></li><li data-type='method'><a href="module-tracker.html#~trackQuizConversion">trackQuizConversion</a></li><li data-type='method'><a href="module-tracker.html#~trackQuizResultClick">trackQuizResultClick</a></li><li data-type='method'><a href="module-tracker.html#~trackQuizResultsLoaded">trackQuizResultsLoaded</a></li><li data-type='method'><a href="module-tracker.html#~trackRecommendationClick">trackRecommendationClick</a></li><li data-type='method'><a href="module-tracker.html#~trackRecommendationView">trackRecommendationView</a></li><li data-type='method'><a href="module-tracker.html#~trackSearchResultClick">trackSearchResultClick</a></li><li data-type='method'><a href="module-tracker.html#~trackSearchResultsLoaded">trackSearchResultsLoaded</a></li><li data-type='method'><a href="module-tracker.html#~trackSearchSubmit">trackSearchSubmit</a></li><li data-type='method'><a href="module-tracker.html#~trackSessionStart">trackSessionStart</a></li></ul></li></ul>
 
 </nav>
 
@@ -287,6 +287,30 @@ <h5 class="subsection-title">Properties:</h5>
         </tr>
 
 
+
+        <tr>
+            
+                <td class="name"><code>assistant</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">object</span>
+
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last">Interface to <a href="module-assistant.html">module:assistant</a></td>
+        </tr>
+
+    
     </tbody>
 </table>
 
@@ -489,6 +513,46 @@ <h6>Properties</h6>
 
 
 
+        <tr>
+            
+                <td class="name"><code>assistantServiceUrl</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">string</span>
+
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+                    &lt;optional><br>
+                
+
+                
+
+                
+                </td>
+            
+
+            
+                <td class="default">
+                
+                    <code>'https://assistant.cnstrc.com'</code>
+                
+                </td>
+            
+
+            <td class="description last">AI Assistant API URL endpoint</td>
+        </tr>
+
+    
+
         <tr>
 
                 <td class="name"><code>segments</code></td>
@@ -1195,7 +1259,7 @@ <h3 class="subsection-title">Methods</h3>
 
 
 
-    <h4 class="name" id="setClientOptions"><span class="type-signature"></span>setClientOptions<span class="signature">(apiKey, segments<span class="signature-attributes">opt</span>, testCells<span class="signature-attributes">opt</span>, userId<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
+    <h4 class="name" id="setClientOptions"><span class="type-signature"></span>setClientOptions<span class="signature">(options)</span><span class="type-signature"></span></h4>
 
 
 
@@ -1211,7 +1275,7 @@ <h4 class="name" id="setClientOptions"><span class="type-signature"></span>setCl
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="constructorio.js.html">constructorio.js</a>, <a href="constructorio.js.html#line147">line 147</a>
+        <a href="constructorio.js.html">constructorio.js</a>, <a href="constructorio.js.html#line156">line 156</a>
     </li></ul></dd>
 
 
@@ -1271,6 +1335,49 @@ <h5 class="h5-parameters">Parameters:</h5>
         <th>Type</th>
 
 
+
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code>options</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">object</span>
+
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last">Client options to update
+                <h6>Properties</h6>
+                
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
         <th>Attributes</th>
 
 
@@ -1301,6 +1408,8 @@ <h5 class="h5-parameters">Parameters:</h5>
 
                 <td class="attributes">
 
+                    &lt;optional><br>
+                
 
 
 
@@ -1383,6 +1492,40 @@ <h5 class="h5-parameters">Parameters:</h5>
 
 
 
+        <tr>
+            
+                <td class="name"><code>sessionId</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">number</span>
+
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+                    &lt;optional><br>
+                
+
+                
+
+                
+                </td>
+            
+
+            
+
+            <td class="description last">Session ID - Will only be set in DOM-less environments</td>
+        </tr>
+
+    
+
         <tr>
 
                 <td class="name"><code>userId</code></td>
@@ -1419,6 +1562,13 @@ <h5 class="h5-parameters">Parameters:</h5>
     </tbody>
 </table>
 
+            </td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
 
 
 
@@ -1457,7 +1607,7 @@ <h5 class="h5-parameters">Parameters:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Thu Nov 02 2023 15:18:34 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Thu May 08 2025 14:58:11 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>