create-instantsearch-app 6.3.1 → 6.4.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-instantsearch-app",
-  "version": "6.3.1",
+  "version": "6.4.1",
   "license": "MIT",
   "description": "⚡️ Build InstantSearch apps at the speed of thought",
   "keywords": [
@@ -33,17 +33,16 @@
   },
   "dependencies": {
     "@algolia/cache-in-memory": "4",
+    "@metalsmith/in-place": "4.6.0",
+    "@metalsmith/remove": "1.3.0",
     "algoliasearch": "4",
     "chalk": "3.0.0",
     "commander": "4.1.1",
     "inquirer": "8.0.0",
     "jstransformer-handlebars": "1.1.0",
-    "latest-semver": "2.0.0",
     "load-json-file": "6.2.0",
     "lodash.camelcase": "4.3.0",
-    "metalsmith": "2.3.0",
-    "metalsmith-ignore": "1.0.0",
-    "metalsmith-in-place": "4.4.1",
+    "metalsmith": "2.5.1",
     "metalsmith-rename": "1.0.0",
     "prettier": "1.19.1",
     "semver": "6.1.1",
@@ -53,5 +52,5 @@
     "jest-image-snapshot": "2.12.0",
     "walk-sync": "2.0.2"
   },
-  "gitHead": "c483ae31e1e615be61dffb5d0bc04a4927960a67"
+  "gitHead": "f4acbc0c1106a4fd7c7ad95a3e02de4fdac1ad27"
 }

package/src/api/__tests__/index.test.js

@@ -1,4 +1,5 @@
 const path = require('path');
+
 const createInstantSearchAppFactory = require('../');
 
 let setupSpy;

package/src/api/__tests__/resolve-template.test.js

@@ -1,4 +1,5 @@
 const path = require('path');
+
 const resolveTemplate = require('../resolve-template');
 
 describe('resolveTemplate', () => {

package/src/api/check-config.js

@@ -1,5 +1,6 @@
-const path = require('path');
 const fs = require('fs');
+const path = require('path');
+
 const { checkAppName, checkAppPath } = require('../utils');
 
 function getOptions({ supportedTemplates }) {

package/src/api/index.js

@@ -1,10 +1,12 @@
 const path = require('path');
-const checkConfig = require('./check-config');
-const resolveTemplate = require('./resolve-template');
+
 const buildTask = require('../tasks/common/build');
 const cleanTask = require('../tasks/common/clean');
 const { getAllTemplates } = require('../utils');
 
+const checkConfig = require('./check-config');
+const resolveTemplate = require('./resolve-template');
+
 const supportedTemplates = getAllTemplates();
 
 function noop() {}

package/src/api/resolve-template.js

@@ -1,5 +1,7 @@
 const path = require('path');
+
 const semver = require('semver');
+
 const { getAppTemplateConfig } = require('../utils');
 
 function getTemplateNameByLibraryVersion({

package/src/cli/__tests__/getConfiguration.test.js

@@ -1,4 +1,5 @@
 const loadJsonFile = require('load-json-file');
+
 const getConfiguration = require('../getConfiguration');
 
 jest.mock('load-json-file');

package/src/cli/__tests__/getInformationFromIndex.js

@@ -1,4 +1,5 @@
 const algoliasearch = require('algoliasearch');
+
 const getInformationFromIndex = require('../getInformationFromIndex');
 
 jest.mock('algoliasearch', () => {

package/src/cli/__tests__/postProcessAnswers.js

@@ -1,5 +1,5 @@
-const postProcessAnswers = require('../postProcessAnswers');
 const utils = require('../../utils');
+const postProcessAnswers = require('../postProcessAnswers');
 
 jest.mock('../../utils', () => ({
   ...jest.requireActual('../../utils'),
@@ -80,32 +80,109 @@ test('creates alternative names', async () => {
   );
 });
 
-test('detects dynamic widgets', async () => {
-  expect(
-    await postProcessAnswers({
-      configuration: {},
-      templateConfig: {},
-      optionsFromArguments: {},
-      answers: { attributesForFaceting: ['ais.dynamicWidgets', 'test'] },
-    })
-  ).toEqual(
-    expect.objectContaining({
-      attributesForFaceting: ['test'],
-      flags: { dynamicWidgets: true },
-    })
-  );
+describe('flags', () => {
+  describe('dynamicWidgets', () => {
+    test('with usage of dynamicWidgets in attributesForFaceting', async () => {
+      expect(
+        await postProcessAnswers({
+          configuration: {},
+          templateConfig: {},
+          optionsFromArguments: {},
+          answers: { attributesForFaceting: ['ais.dynamicWidgets', 'test'] },
+        })
+      ).toEqual(
+        expect.objectContaining({
+          attributesForFaceting: ['test'],
+          flags: expect.objectContaining({ dynamicWidgets: true }),
+        })
+      );
+    });
 
-  expect(
-    await postProcessAnswers({
-      configuration: {},
-      templateConfig: {},
-      optionsFromArguments: {},
-      answers: { attributesForFaceting: ['test'] },
-    })
-  ).toEqual(
-    expect.objectContaining({
-      attributesForFaceting: ['test'],
-      flags: { dynamicWidgets: false },
-    })
-  );
+    test('without usage of dynamicWidgets in attributesForFaceting', async () => {
+      expect(
+        await postProcessAnswers({
+          configuration: {},
+          templateConfig: {},
+          optionsFromArguments: {},
+          answers: { attributesForFaceting: ['test'] },
+        })
+      ).toEqual(
+        expect.objectContaining({
+          attributesForFaceting: ['test'],
+          flags: expect.objectContaining({ dynamicWidgets: false }),
+        })
+      );
+    });
+
+    test('without attributes', async () => {
+      expect(
+        await postProcessAnswers({
+          configuration: {},
+          templateConfig: {},
+          optionsFromArguments: {},
+          answers: {},
+        })
+      ).toEqual(
+        expect.objectContaining({
+          flags: expect.objectContaining({ dynamicWidgets: false }),
+        })
+      );
+    });
+  });
+
+  describe('insights', () => {
+    test('with a valid version', async () => {
+      utils.fetchLibraryVersions.mockImplementationOnce(() =>
+        Promise.resolve(['1.2.0'])
+      );
+
+      expect(
+        (
+          await postProcessAnswers({
+            configuration: {},
+            templateConfig: {
+              libraryName: 'instantsearch.js',
+              flags: {
+                insights: '>= 1',
+              },
+            },
+            optionsFromArguments: {},
+          })
+        ).flags
+      ).toEqual(expect.objectContaining({ insights: true }));
+    });
+
+    test('with an invalid version', async () => {
+      utils.fetchLibraryVersions.mockImplementationOnce(() =>
+        Promise.resolve(['1.2.0'])
+      );
+
+      expect(
+        (
+          await postProcessAnswers({
+            configuration: {},
+            templateConfig: {
+              libraryName: 'instantsearch.js',
+              flags: {
+                insights: '>= 1.3',
+              },
+            },
+            optionsFromArguments: {},
+          })
+        ).flags
+      ).toEqual(expect.objectContaining({ insights: false }));
+    });
+
+    test('without config', async () => {
+      expect(
+        (
+          await postProcessAnswers({
+            configuration: {},
+            templateConfig: {},
+            optionsFromArguments: {},
+          })
+        ).flags
+      ).toEqual(expect.objectContaining({ insights: false }));
+    });
+  });
 });

package/src/cli/getInformationFromIndex.js

@@ -1,5 +1,5 @@
-const algoliasearch = require('algoliasearch');
 const { createInMemoryCache } = require('@algolia/cache-in-memory');
+const algoliasearch = require('algoliasearch');
 
 const clients = new Map();
 function getClient(appId, apiKey) {

package/src/cli/index.js

@@ -1,13 +1,14 @@
 #!/usr/bin/env node
+const os = require('os');
 const path = require('path');
 const process = require('process');
-const os = require('os');
+
+const chalk = require('chalk');
 const program = require('commander');
 const inquirer = require('inquirer');
-const chalk = require('chalk');
-const latestSemver = require('latest-semver');
 const semver = require('semver');
 
+const { version } = require('../../package.json');
 const createInstantSearchApp = require('../api');
 const {
   checkAppPath,
@@ -18,13 +19,13 @@ const {
   getTemplatePath,
   splitArray,
 } = require('../utils');
+
+const getAnswersDefaultValues = require('./getAnswersDefaultValues');
 const getAttributesFromIndex = require('./getAttributesFromIndex');
+const getConfiguration = require('./getConfiguration');
 const getFacetsFromIndex = require('./getFacetsFromIndex');
-const getAnswersDefaultValues = require('./getAnswersDefaultValues');
 const isQuestionAsked = require('./isQuestionAsked');
-const getConfiguration = require('./getConfiguration');
 const postProcessAnswers = require('./postProcessAnswers');
-const { version } = require('../../package.json');
 
 let appPathFromArgument;
 
@@ -75,7 +76,9 @@ const getQuestions = ({ appName }) => ({
 
         try {
           const versions = await fetchLibraryVersions(libraryName);
-          const latestStableVersion = latestSemver(versions);
+          const latestStableVersion = semver.maxSatisfying(versions, '*', {
+            includePrerelease: false,
+          });
 
           if (!latestStableVersion) {
             return versions;

package/src/cli/postProcessAnswers.js

@@ -1,5 +1,5 @@
 const camelCase = require('lodash.camelcase');
-const latestSemver = require('latest-semver');
+const semver = require('semver');
 
 const { fetchLibraryVersions } = require('../utils');
 
@@ -24,10 +24,13 @@ async function getLibraryVersion(config, templateConfig) {
 
   if (libraryName && !libraryVersion) {
     const versions = await fetchLibraryVersions(libraryName);
+    const latestStableVersion = semver.maxSatisfying(versions, '*', {
+      includePrerelease: false,
+    });
 
     // Return the latest available version when
     // the stable version is not available
-    return latestSemver(versions) || versions[0];
+    return latestStableVersion || versions[0];
   }
 
   return libraryVersion;
@@ -71,6 +74,9 @@ async function postProcessAnswers({
       dynamicWidgets:
         Array.isArray(combinedAnswers.attributesForFaceting) &&
         combinedAnswers.attributesForFaceting.includes('ais.dynamicWidgets'),
+      insights:
+        Boolean(templateConfig.flags && templateConfig.flags.insights) &&
+        semver.satisfies(libraryVersion, templateConfig.flags.insights),
     },
   };
 }

package/src/tasks/common/build.js

@@ -1,7 +1,7 @@
+const inPlace = require('@metalsmith/in-place');
+const remove = require('@metalsmith/remove');
 const metalsmith = require('metalsmith');
-const inPlace = require('metalsmith-in-place');
 const rename = require('metalsmith-rename');
-const ignore = require('metalsmith-ignore');
 
 module.exports = function build(config) {
   return new Promise((resolve, reject) => {
@@ -9,7 +9,7 @@ module.exports = function build(config) {
       .source(config.template)
       .destination(config.path)
       .metadata(config)
-      .use(ignore(['.template.js']))
+      .use(remove(['.template.js']))
       .use(
         // Add the `.hbs` extension to any templating files that need
         // their placeholders to get filled with `metalsmith-in-place`

package/src/tasks/common/clean.js

@@ -1,4 +1,5 @@
 const util = require('util');
+
 const exec = util.promisify(require('child_process').exec);
 const chalk = require('chalk');
 

package/src/tasks/ios/install.js

@@ -1,4 +1,5 @@
 const { execSync } = require('child_process');
+
 const chalk = require('chalk');
 
 module.exports = function install(config) {

package/src/tasks/ios/setup.js

@@ -1,4 +1,5 @@
 const { execSync } = require('child_process');
+
 const chalk = require('chalk');
 
 module.exports = function setup(config) {

package/src/tasks/node/install.js

@@ -1,6 +1,8 @@
-const process = require('process');
 const { execSync } = require('child_process');
+const process = require('process');
+
 const chalk = require('chalk');
+
 const { isYarnAvailable } = require('../../utils');
 
 module.exports = function install(config) {

package/src/tasks/node/teardown.js

@@ -1,6 +1,8 @@
-const path = require('path');
 const { execSync } = require('child_process');
+const path = require('path');
+
 const chalk = require('chalk');
+
 const { isYarnAvailable } = require('../../utils');
 
 module.exports = function teardown(config) {

package/src/templates/InstantSearch.js/.template.js

@@ -7,6 +7,7 @@ module.exports = {
   supportedVersion: '>= 3.0.0 < 5.0.0',
   flags: {
     dynamicWidgets: '>= 4.30',
+    insights: '>= 4.55',
   },
   templateName: 'instantsearch.js',
   appName: 'instantsearch.js-app',

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

@@ -5,6 +5,7 @@ const searchClient = algoliasearch('{{appId}}', '{{apiKey}}');
 const search = instantsearch({
   indexName: '{{indexName}}',
   searchClient,
+  {{#if flags.insights}}insights: true,{{/if}}
 });
 
 search.addWidgets([
@@ -18,12 +19,12 @@ search.addWidgets([
     container: '#hits',
     {{#if attributesToDisplay}}
     templates: {
-      item: `
+      item: (hit, { html, components }) => html`
 <article>
-  <h1>\{{#helpers.highlight}}{ "attribute": "{{attributesToDisplay.[0]}}" }\{{/helpers.highlight}}</h1>
+  <h1>${components.Highlight({hit, attribute: "{{attributesToDisplay.[0]}}"})}</h1>
   {{#each attributesToDisplay}}
   {{#unless @first}}
-  <p>\{{#helpers.highlight}}{ "attribute": "{{this}}" }\{{/helpers.highlight}}</p>
+  <p>${components.Highlight({hit, attribute: "{{this}}"})}</p>
   {{/unless}}
   {{/each}}
 </article>
@@ -38,7 +39,7 @@ search.addWidgets([
   instantsearch.widgets.dynamicWidgets({
     container: '#dynamic-widgets',
     fallbackWidget({ container, attribute }) {
-      return instantsearch.widgets.panel({ templates: { header: attribute } })(
+      return instantsearch.widgets.panel({ templates: { header: () => attribute } })(
         instantsearch.widgets.refinementList
       )({
         container,
@@ -49,7 +50,7 @@ search.addWidgets([
       {{#each attributesForFaceting}}
       container =>
         instantsearch.widgets.panel({
-          templates: { header: '{{this}}' },
+          templates: { header: () => '{{this}}' },
         })(instantsearch.widgets.refinementList)({
           container,
           attribute: '{{this}}',
@@ -60,7 +61,7 @@ search.addWidgets([
   {{else}}
   {{#each attributesForFaceting}}
   instantsearch.widgets.panel({
-    templates: { header: '{{this}}' },
+    templates: { header: () => '{{this}}' },
   })(instantsearch.widgets.refinementList)({
     container: '#{{this}}-list',
     attribute: '{{this}}',

package/src/templates/React InstantSearch Hooks/.template.js

@@ -7,6 +7,7 @@ module.exports = {
   supportedVersion: '>= 6.0.0 < 7.0.0',
   flags: {
     dynamicWidgets: '>=6.16',
+    insights: '>=6.43',
   },
   templateName: 'react-instantsearch-hooks',
   appName: 'react-instantsearch-hooks-app',

package/src/templates/React InstantSearch Hooks/package.json

@@ -8,7 +8,6 @@
   },
   "dependencies": {
     "algoliasearch": "4",
-    "instantsearch.js": "4.43.1",
     "react": "18.1.0",
     "react-dom": "18.1.0",
     "react-instantsearch-hooks-web": "{{libraryVersion}}"

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

@@ -47,7 +47,7 @@ export function App() {
       </header>
 
       <div className="container">
-        <InstantSearch searchClient={searchClient} indexName="{{indexName}}">
+        <InstantSearch searchClient={searchClient} indexName="{{indexName}}" {{#if flags.insights}}insights{{/if}}>
           <Configure hitsPerPage={8} />
           <div className="search-panel">
             <div className="search-panel__filters">

package/src/templates/React InstantSearch Hooks Native/package.json

@@ -14,7 +14,6 @@
     "algoliasearch": "4.12.1",
     "expo": "~44.0.0",
     "expo-status-bar": "~1.2.0",
-    "instantsearch.js": "4.38.1",
     "react": "17.0.1",
     "react-dom": "17.0.1",
     "react-instantsearch-hooks": "{{libraryVersion}}",

package/src/templates/Vue InstantSearch/.template.js

@@ -6,7 +6,8 @@ module.exports = {
   libraryName: 'vue-instantsearch',
   supportedVersion: '>= 3.0.0 < 5.0.0',
   flags: {
-    dynamicWidgets: '>=4.2.0',
+    dynamicWidgets: '>= 4.2.0',
+    insights: '>= 4.9.0',
   },
   templateName: 'vue-instantsearch',
   appName: 'vue-instantsearch-app',

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

@@ -18,6 +18,7 @@
       <ais-instant-search
         :search-client="searchClient"
         index-name="{{indexName}}"
+        {{#if flags.insights}}insights{{/if}}
       >
         <ais-configure :hits-per-page.camel="8" />
         <div class="search-panel">

package/src/templates/Vue InstantSearch with Vue 3/.template.js

@@ -6,7 +6,8 @@ module.exports = {
   libraryName: 'vue-instantsearch',
   supportedVersion: '>= 4.3.3 < 5.0.0',
   flags: {
-    dynamicWidgets: '>=4.2.0',
+    dynamicWidgets: '>= 4.2.0',
+    insights: '>= 4.9.0',
   },
   templateName: 'vue-instantsearch-vue3',
   appName: 'vue-instantsearch-app',

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

@@ -16,6 +16,7 @@
       <ais-instant-search
         :search-client="searchClient"
         index-name="{{indexName}}"
+        {{#if flags.insights}}insights{{/if}}
       >
         <ais-configure :hits-per-page.camel="8" />
         <div class="search-panel">

package/src/utils/index.js

@@ -1,10 +1,11 @@
+const { execSync } = require('child_process');
 const fs = require('fs');
 const path = require('path');
-const { execSync } = require('child_process');
+
+const algoliasearch = require('algoliasearch');
 const chalk = require('chalk');
 const semver = require('semver');
 const validateProjectName = require('validate-npm-package-name');
-const algoliasearch = require('algoliasearch');
 
 const TEMPLATES_FOLDER = path.join(__dirname, '../templates');