algoliasearch.zendesk-hc 2.30.0 → 2.31.0

package/README.md

@@ -1,11 +1,6 @@
 # JavaScript library: `algoliasearchZendeskHC`
 
 [![npm](https://img.shields.io/npm/v/algoliasearch.zendesk-hc.png)](https://www.npmjs.com/package/algoliasearch.zendesk-hc)
-
-[![Dependency Status](https://david-dm.org/algolia/algoliasearch-zendesk.png?path=app)](https://david-dm.org/algolia/algoliasearch-zendesk?path=app)
-[![devDependency Status](https://david-dm.org/algolia/algoliasearch-zendesk/dev-status.png?path=app)](https://david-dm.org/algolia/algoliasearch-zendesk?path=app#info=devDependencies)
-[![peerDependency Status](https://david-dm.org/algolia/algoliasearch-zendesk/peer-status.png?path=app)](https://david-dm.org/algolia/algoliasearch-zendesk?path=app#info=peerDependencies)
-
 [![GitHub license](https://img.shields.io/github/license/algolia/algoliasearch-zendesk.png)](../LICENSE)
 
 This JavaScript library allows you to replace the default search of your Zendesk Help Center by Algolia. [Algolia](https://www.algolia.com) is a hosted full-text, numerical, and faceted search engine capable of delivering realtime results from the first keystroke.
@@ -22,7 +17,7 @@ To browse through the crawler, visit the [crawler/](../crawler/) folder.
 ### Synchronize Algolia with your Help Center
 
 <div align="center">
-  <img src="https://community.algolia.com/zendesk/img/algolia-zendesk.svg" alt="Data connection visualization" />
+  <img src="https://www.algolia.com/_next/image/?url=https%3A%2F%2Fres.cloudinary.com%2Fhilnmyskv%2Fimage%2Fupload%2Fv1671027406%2FAlgolia_com_Website_assets%2Fimages%2Fzendesk%2FZendesk-algolia.png&w=1200&q=75" alt="Data connection visualization" />
 </div>
 
 1. Create an [Algolia account](https://www.algolia.com/users/sign_up).
@@ -36,8 +31,8 @@ You can access it with the left sidebar in your dashboard.
 This connector will every day take your public Help Center articles and put them inside an Algolia index.
 In most cases, this should be enough to have an up-to-date search.
 
-However, if you'd rather have it updated right now, like when you add a lot of support articles, you can manually trigger a full reindex.
-On this page, just click the "Reindex" button in the bottom right corner. A few minutes later, your search index will be updated.
+However, if you'd rather have it updated sooner, you can manually trigger a full reindex.
+On your [Connectors](https://dashboard.algolia.com/connectors/tasks) page, click the "Run task" button on the right of your task.
 
 ### Updating your Help Center theme
 
@@ -76,11 +71,11 @@ Here is a full breakdown of the available options for the JavaScript library:
     applicationId: '<YOUR APPLICATION_ID>',
     apiKey: '<YOUR SEARCH ONLY API KEY>',
     subdomain: '<YOUR ZENDESK APPLICATION NAME>',
+    indexName: '<YOUR ALGOLIA INDEX NAME>',
 
     //
     // Optional configuration:
     //
-    indexPrefix: 'zendesk_',              // or your custom <INDEX_PREFIX>
     analytics: true,                      // should queries be processed by Algolia analytics
     baseUrl: '/hc/',                      // the base URL of your Help Center
     poweredBy: true,                      // show the "Search by Algolia" link (required if you're on Algolia's FREE plan)
@@ -105,6 +100,7 @@ Here is a full breakdown of the available options for the JavaScript library:
       useEditedAt: false                  // show edited_at timestamp in search results
     },
     instantsearchPage,                    // function to check if we're on the search page
+    indexPrefix: 'zendesk_',              // @deprecated use `indexName` instead
     templates: {                          // template objects (see the templates section)
       autocomplete: {},
       instantsearch: {}
@@ -363,9 +359,8 @@ Also, some templates are using a `compile` function in this file. This function
 
 In case you're using Zendesk's [IP restrictions feature](https://support.zendesk.com/hc/en-us/articles/203663706-Restricting-access-to-Zendesk-Support-and-your-Help-Center-using-IP-restrictions), you'll need to whitelist our IPs for our indexing to work.
 Here are those IPs:
-- `3.221.200.5`
-- `52.204.20.39`
-- `52.22.248.248`
+- `104.196.103.173`
+- `35.234.69.129`
 
 ## Development
 
@@ -430,6 +425,7 @@ When running, you can then add this custom script to your Help Center, inside th
     applicationId: 'FIXME',
     apiKey: 'FIXME',
     subdomain: 'FIXME',
+    indexName: 'FIXME',
   })
 </script>
 ```

package/dist/algoliasearch.zendesk-hc.css

@@ -1,7 +1,7 @@
 /*!
-* Algolia Search for Zendesk's Help Center v2.30.0
+* Algolia Search for Zendesk's Help Center v2.31.0
 * https://github.com/algolia/algoliasearch-zendesk
-* Copyright 2021 Algolia <support@algolia.com>; Licensed MIT
+* Copyright 2023 Algolia <support@algolia.com>; Licensed MIT
 */
 @charset "UTF-8";
 /* Search by */