create-instantsearch-app 7.2.0 → 7.3.0

package/README.md

@@ -50,6 +50,10 @@ cd my-app
 yarn start
 ```
 
+> **Important**
+> Selecting 'Y' when being prompted to ‘Enable user events’ activates the [`insights`](https://www.algolia.com/doc/api-reference/widgets/instantsearch/js/#widget-param-insights) option for compatible templates, allowing Algolia to process your user Events. Events can unlock powerful features, enhancing your application's effectiveness and we encourage you to consider enabling this valuable functionality. Please review our [API reference](https://www.algolia.com/doc/api-reference/widgets/instantsearch/js/#widget-param-insights) for more details about Events collection and settings.
+
+
 ## Usage
 
 This package comes with the module `createInstantSearchApp(path, options?)` and the command-line tool `create-instantsearch-app`.
@@ -110,7 +114,8 @@ The `config` flag is handy to automate app generations.
   "indexName": "MY_INDEX_NAME",
   "searchPlaceholder": "Search",
   "attributesToDisplay": ["name", "description"],
-  "attributesForFaceting": ["brand", "location"]
+  "attributesForFaceting": ["brand", "location"],
+  "enableInsights": true
 }
 ```
 
@@ -132,6 +137,7 @@ const app = createInstantSearchApp('~/lab/my-app', {
   libraryVersion: '2.0.0',
   attributesToDisplay: ['name', 'description'],
   attributesForFaceting: ['keywords'],
+  enableInsights: true,
 });
 
 app.create().then(() => console.log('App generated!'));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-instantsearch-app",
-  "version": "7.2.0",
+  "version": "7.3.0",
   "license": "MIT",
   "description": "⚡️ Build InstantSearch apps at the speed of thought",
   "keywords": [
@@ -49,9 +49,9 @@
     "validate-npm-package-name": "3.0.0"
   },
   "devDependencies": {
-    "@instantsearch/testutils": "1.15.0",
+    "@instantsearch/testutils": "1.17.0",
     "jest-image-snapshot": "2.12.0",
     "walk-sync": "2.0.2"
   },
-  "gitHead": "c59c53cab5f6caddf44fca51e32063d737a96bce"
+  "gitHead": "1501fae54fbdb280ae4747bf68fbacc915ddc1a3"
 }

package/src/cli/__tests__/postProcessAnswers.js

@@ -131,7 +131,7 @@ describe('flags', () => {
   });
 
   describe('insights', () => {
-    test('with a valid version', async () => {
+    test('with a valid version and user consent', async () => {
       utils.fetchLibraryVersions.mockImplementationOnce(() =>
         Promise.resolve(['1.2.0'])
       );
@@ -139,7 +139,7 @@ describe('flags', () => {
       expect(
         (
           await postProcessAnswers({
-            configuration: {},
+            configuration: { enableInsights: true },
             templateConfig: {
               libraryName: 'instantsearch.js',
               flags: {
@@ -152,6 +152,27 @@ describe('flags', () => {
       ).toEqual(expect.objectContaining({ insights: true }));
     });
 
+    test('with a valid version and no user consent', async () => {
+      utils.fetchLibraryVersions.mockImplementationOnce(() =>
+        Promise.resolve(['1.2.0'])
+      );
+
+      expect(
+        (
+          await postProcessAnswers({
+            configuration: { enableInsights: false },
+            templateConfig: {
+              libraryName: 'instantsearch.js',
+              flags: {
+                insights: '>= 1',
+              },
+            },
+            optionsFromArguments: {},
+          })
+        ).flags
+      ).toEqual(expect.objectContaining({ insights: false }));
+    });
+
     test('with an invalid version', async () => {
       utils.fetchLibraryVersions.mockImplementationOnce(() =>
         Promise.resolve(['1.2.0'])

package/src/cli/index.js

@@ -286,6 +286,35 @@ const getQuestions = ({ appName }) => ({
       },
       when: ({ searchInputType }) => searchInputType === 'autocomplete',
     },
+    {
+      type: 'confirm',
+      name: 'enableInsights',
+      message: 'Enable user events',
+      default: true,
+      suffix: `${chalk.gray(`
+  Selecting 'Y' enables the \`insights\` option.
+  By doing this, you instruct Algolia to process your user Events.
+  Please review our API reference at ${chalk.bold(
+    chalk.underline('https://alg.li/instantsearch-insights')
+  )}
+  for more details about Events collection and settings.`)}`,
+      when: ({ libraryVersion, template }) => {
+        const templatePath = getTemplatePath(template);
+        const templateConfig = getAppTemplateConfig(templatePath);
+
+        const selectedLibraryVersion = libraryVersion;
+        const requiredLibraryVersion =
+          templateConfig.flags && templateConfig.flags.insights;
+        const supportsInsights =
+          selectedLibraryVersion &&
+          requiredLibraryVersion &&
+          semver.satisfies(selectedLibraryVersion, requiredLibraryVersion, {
+            includePrerelease: true,
+          });
+
+        return supportsInsights;
+      },
+    },
   ],
   widget: [
     {

package/src/cli/postProcessAnswers.js

@@ -76,7 +76,7 @@ async function postProcessAnswers({
         combinedAnswers.attributesForFaceting.includes('ais.dynamicWidgets'),
       insights:
         Boolean(templateConfig.flags && templateConfig.flags.insights) &&
-        semver.satisfies(libraryVersion, templateConfig.flags.insights),
+        combinedAnswers.enableInsights === true,
       autocomplete:
         Boolean(templateConfig.flags && templateConfig.flags.autocomplete) &&
         combinedAnswers.searchInputType === 'autocomplete',

package/src/templates/InstantSearch.js/src/app.js.hbs

@@ -14,6 +14,7 @@ const searchClient = algoliasearch('{{appId}}', '{{apiKey}}');
 const search = instantsearch({
   indexName: '{{indexName}}',
   searchClient,
+  future: { preserveSharedStateOnUnmount: true },
   {{#if flags.insights}}insights: true,{{/if}}
 });
 

package/src/templates/React InstantSearch/src/App.tsx.hbs

@@ -31,6 +31,8 @@ const searchClient = algoliasearch(
   '{{apiKey}}'
 );
 
+const future = { preserveSharedStateOnUnmount: true };
+
 export function App() {
   return (
     <div>
@@ -47,7 +49,7 @@ export function App() {
       </header>
 
       <div className="container">
-        <InstantSearch searchClient={searchClient} indexName="{{indexName}}" {{#if flags.insights}}insights{{/if}}>
+        <InstantSearch searchClient={searchClient} indexName="{{indexName}}" future={future} {{#if flags.insights}}insights{{/if}}>
           <Configure hitsPerPage={8} />
           <div className="search-panel">
             <div className="search-panel__filters">

package/src/templates/Vue InstantSearch with Vue 3/src/App.vue

@@ -16,6 +16,7 @@
       <ais-instant-search
         :search-client="searchClient"
         index-name="{{indexName}}"
+        :future="future"
         {{#if flags.insights}}insights{{/if}}
       >
         <ais-configure :hits-per-page.camel="8" />
@@ -85,6 +86,7 @@ export default {
   data() {
     return {
       searchClient: algoliasearch('{{appId}}', '{{apiKey}}'),
+      future: { preserveSharedStateOnUnmount: true },
     };
   },
 };