create-instantsearch-app 4.10.2 → 5.0.0

package/CHANGELOG.md

@@ -1,3 +1,97 @@
+# [5.0.0](https://github.com/algolia/create-instantsearch-app/compare/4.11.1...5.0.0) (2021-12-02)
+
+
+### Bug Fixes
+
+* **dynamicWidgets:** prevent "ais.dynamicWidgets" attribute showing up ([#542](https://github.com/algolia/create-instantsearch-app/issues/542)) ([559f705](https://github.com/algolia/create-instantsearch-app/commit/559f705ebcef48a3794efd7a588abd187d6642c9))
+
+
+### Code Refactoring
+
+* **index:** rewrite answer parsing ([#541](https://github.com/algolia/create-instantsearch-app/issues/541)) ([efd2799](https://github.com/algolia/create-instantsearch-app/commit/efd279943e23545c3c0806f8e9632ae32c83c0d6))
+
+
+### BREAKING CHANGES
+
+* **index:** the program now asks questions if some of the parameters are sent via arguments. Before this, giving an argument would cause it not to ask any questions anymore, even if they still would be useful. You can avoid this behaviour by passing --config or --no-interactive
+
+* postprocess answers
+
+* e2e installs should not have any asked questions
+
+* make e2e build test pass
+
+* more info
+
+* update to newer commander to fix the "name" issue
+
+* refactor: validate appPath like appName
+
+* error for empty string path
+
+* clean lockfile
+
+* refactor initial questions
+
+* silently check for existing answers on appName
+
+* don't ask initial questions if config is set
+
+* introduce --no-interactive, mostly for test
+
+* write tests
+
+* fix argument
+
+* undo change
+
+* make .default apply always
+
+* refactor templates to be part of initialQuestions
+
+* cover initialQuestions in tests
+
+* fix error
+
+
+
+## [4.11.1](https://github.com/algolia/create-instantsearch-app/compare/4.11.0...4.11.1) (2021-11-18)
+
+
+### Bug Fixes
+
+* **react:** add missing configure widget import ([#540](https://github.com/algolia/create-instantsearch-app/issues/540)) ([626a568](https://github.com/algolia/create-instantsearch-app/commit/626a56859c48e756429da66195d7da1a6c79e39e))
+
+
+
+# [4.11.0](https://github.com/algolia/create-instantsearch-app/compare/4.10.3...4.11.0) (2021-11-16)
+
+
+### Bug Fixes
+
+* **angular:** move styles import to angular.json ([#532](https://github.com/algolia/create-instantsearch-app/issues/532)) ([d2f73b8](https://github.com/algolia/create-instantsearch-app/commit/d2f73b895c0ed7a2530920f770f67879cca0a9a5))
+* **angular:** replace css imports with CDN <link>s ([#537](https://github.com/algolia/create-instantsearch-app/issues/537)) ([fb4c2a8](https://github.com/algolia/create-instantsearch-app/commit/fb4c2a87852fe2f4b3d2289a21234fdf04bddc98))
+* **Angular IS:** enable esModuleInterop ([#527](https://github.com/algolia/create-instantsearch-app/issues/527)) ([502e776](https://github.com/algolia/create-instantsearch-app/commit/502e776cf9ca9eca489d6acbde5f8c603de56bd0))
+* **ci:** replace legacy circleci node images ([#533](https://github.com/algolia/create-instantsearch-app/issues/533)) ([9ffb469](https://github.com/algolia/create-instantsearch-app/commit/9ffb46925db6e2a6e015be98b589f1b7cf22a9f3))
+* **cli:** configure inquirer with correct initial values for attributesToDisplay ([#530](https://github.com/algolia/create-instantsearch-app/issues/530)) ([5cd6142](https://github.com/algolia/create-instantsearch-app/commit/5cd6142d12658dde616690ab1b045c613adf711a))
+
+
+### Features
+
+* **autocomplete:** add Autocomplete v1 template ([#528](https://github.com/algolia/create-instantsearch-app/issues/528)) ([5c72d05](https://github.com/algolia/create-instantsearch-app/commit/5c72d05100d90900afbc848eaa7417c175c126cc))
+* **facets:** use dynamicWidgets ([#534](https://github.com/algolia/create-instantsearch-app/issues/534)) ([7df3225](https://github.com/algolia/create-instantsearch-app/commit/7df32252a0558f0e09288735cfddd8062af5dc09))
+
+
+
+## [4.10.3](https://github.com/algolia/create-instantsearch-app/compare/4.10.2...4.10.3) (2021-09-01)
+
+
+### Bug Fixes
+
+* **js:** enable typescript completion using window ([1fd684b](https://github.com/algolia/create-instantsearch-app/commit/1fd684bf4c5c15b0f7c5d20a6bcf25037ddf9684))
+
+
+
 ## [4.10.2](https://github.com/algolia/create-instantsearch-app/compare/4.10.1...4.10.2) (2021-09-01)
 
 

package/README.md

@@ -71,6 +71,7 @@ $ create-instantsearch-app --help
     --library-version <libraryVersion>                 The version of the library
     --config <config>                                  The configuration file to get the options from
     --no-installation                                  Ignore dependency installation
+    --no-interactive                                   Do not ask any interactive questions
     -h, --help                                         output usage information
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-instantsearch-app",
-  "version": "4.10.2",
+  "version": "5.0.0",
   "license": "MIT",
   "description": "⚡️ Build InstantSearch apps at the speed of thought",
   "keywords": [
@@ -36,9 +36,10 @@
     "node": ">= 10"
   },
   "dependencies": {
-    "algoliasearch": "3.35.1",
+    "@algolia/cache-in-memory": "4.11.0",
+    "algoliasearch": "4.11.0",
     "chalk": "3.0.0",
-    "commander": "4.0.1",
+    "commander": "4.1.1",
     "inquirer": "8.0.0",
     "jstransformer-handlebars": "1.1.0",
     "latest-semver": "2.0.0",

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

@@ -6,10 +6,10 @@ exports[`Options with invalid name throws 1`] = `
   - name can only contain URL-friendly characters"
 `;
 
-exports[`Options with unknown template throws 1`] = `"The template directory must contain a configuration file \`.template.js\` or must be one of those: Angular InstantSearch, Autocomplete.js, InstantSearch Android, InstantSearch iOS, InstantSearch.js, InstantSearch.js 2, InstantSearch.js widget, JavaScript Client, JavaScript Helper, JavaScript Helper 2, React InstantSearch, React InstantSearch Native, React InstantSearch widget, Vue InstantSearch, Vue InstantSearch 1, Vue InstantSearch 2"`;
+exports[`Options with unknown template throws 1`] = `"The template directory must contain a configuration file \`.template.js\` or must be one of those: Angular InstantSearch, Autocomplete, Autocomplete.js 0, InstantSearch Android, InstantSearch iOS, InstantSearch.js, InstantSearch.js 2, InstantSearch.js widget, JavaScript Client, JavaScript Helper, JavaScript Helper 2, React InstantSearch, React InstantSearch Native, React InstantSearch widget, Vue InstantSearch, Vue InstantSearch 1, Vue InstantSearch 2"`;
 
-exports[`Options with wrong template path throws 1`] = `"The template directory must contain a configuration file \`.template.js\` or must be one of those: Angular InstantSearch, Autocomplete.js, InstantSearch Android, InstantSearch iOS, InstantSearch.js, InstantSearch.js 2, InstantSearch.js widget, JavaScript Client, JavaScript Helper, JavaScript Helper 2, React InstantSearch, React InstantSearch Native, React InstantSearch widget, Vue InstantSearch, Vue InstantSearch 1, Vue InstantSearch 2"`;
+exports[`Options with wrong template path throws 1`] = `"The template directory must contain a configuration file \`.template.js\` or must be one of those: Angular InstantSearch, Autocomplete, Autocomplete.js 0, InstantSearch Android, InstantSearch iOS, InstantSearch.js, InstantSearch.js 2, InstantSearch.js widget, JavaScript Client, JavaScript Helper, JavaScript Helper 2, React InstantSearch, React InstantSearch Native, React InstantSearch widget, Vue InstantSearch, Vue InstantSearch 1, Vue InstantSearch 2"`;
 
 exports[`Options without path throws 1`] = `"The option \`path\` is required."`;
 
-exports[`Options without template throws 1`] = `"The template directory must contain a configuration file \`.template.js\` or must be one of those: Angular InstantSearch, Autocomplete.js, InstantSearch Android, InstantSearch iOS, InstantSearch.js, InstantSearch.js 2, InstantSearch.js widget, JavaScript Client, JavaScript Helper, JavaScript Helper 2, React InstantSearch, React InstantSearch Native, React InstantSearch widget, Vue InstantSearch, Vue InstantSearch 1, Vue InstantSearch 2"`;
+exports[`Options without template throws 1`] = `"The template directory must contain a configuration file \`.template.js\` or must be one of those: Angular InstantSearch, Autocomplete, Autocomplete.js 0, InstantSearch Android, InstantSearch iOS, InstantSearch.js, InstantSearch.js 2, InstantSearch.js widget, JavaScript Client, JavaScript Helper, JavaScript Helper 2, React InstantSearch, React InstantSearch Native, React InstantSearch widget, Vue InstantSearch, Vue InstantSearch 1, Vue InstantSearch 2"`;

package/src/cli/__tests__/getAnswersDefaultValues.js

@@ -0,0 +1,15 @@
+const getAnswersDefaultValues = require('../getAnswersDefaultValues');
+
+test('without attributesToDisplay in configuration', () => {
+  const { attributesToDisplay } = getAnswersDefaultValues({}, {}, undefined);
+  expect(attributesToDisplay).toBeUndefined();
+});
+
+test('with attributesToDisplay in configuration', () => {
+  const { attributesToDisplay } = getAnswersDefaultValues(
+    {},
+    { attributesToDisplay: ['name'] },
+    undefined
+  );
+  expect(attributesToDisplay).toEqual(['name']);
+});

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

@@ -1,25 +1,23 @@
-const algoliasearch = require('algoliasearch');
 const getAttributesFromIndex = require('../getAttributesFromIndex');
+const getInformationFromIndex = require('../getInformationFromIndex');
 
-jest.mock('algoliasearch');
+jest.mock('../getInformationFromIndex');
 
 test('with search success should fetch attributes', async () => {
-  algoliasearch.mockImplementationOnce(() => ({
-    initIndex: () => ({
-      search: () => ({
-        hits: [
-          {
-            _highlightResult: {
-              brand: 'brand',
-              description: 'description',
-              name: 'name',
-              title: 'title',
-            },
+  getInformationFromIndex.mockImplementationOnce(() =>
+    Promise.resolve({
+      hits: [
+        {
+          _highlightResult: {
+            brand: 'brand',
+            description: 'description',
+            name: 'name',
+            title: 'title',
           },
-        ],
-      }),
-    }),
-  }));
+        },
+      ],
+    })
+  );
 
   const attributes = await getAttributesFromIndex({
     appId: 'appId',
@@ -31,13 +29,9 @@ test('with search success should fetch attributes', async () => {
 });
 
 test('with search failure should return default attributes', async () => {
-  algoliasearch.mockImplementationOnce(() => ({
-    initIndex: () => ({
-      search: () => {
-        throw new Error();
-      },
-    }),
-  }));
+  getInformationFromIndex.mockImplementationOnce(() =>
+    Promise.reject(new Error())
+  );
 
   const attributes = await getAttributesFromIndex({
     appId: 'appId',

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

@@ -1,14 +1,8 @@
 const loadJsonFile = require('load-json-file');
-const utils = require('../../utils');
-const { getConfiguration, getLibraryVersion } = require('../getConfiguration');
+const getConfiguration = require('../getConfiguration');
 
 jest.mock('load-json-file');
 
-jest.mock('../../utils', () => ({
-  ...require.requireActual('../../utils'),
-  fetchLibraryVersions: jest.fn(() => Promise.resolve(['1.0.0'])),
-}));
-
 test('without template throws', async () => {
   expect.assertions(1);
 
@@ -36,21 +30,6 @@ test('with options from arguments and prompt merge', async () => {
   );
 });
 
-test('without stable version available', async () => {
-  utils.fetchLibraryVersions.mockImplementationOnce(() =>
-    Promise.resolve(['1.0.0-beta.0'])
-  );
-
-  const libraryVersion = await getLibraryVersion(
-    {
-      template: 'InstantSearch.js',
-    },
-    utils.getAppTemplateConfig(utils.getTemplatePath('InstantSearch.js'))
-  );
-
-  expect(libraryVersion).toBe('1.0.0-beta.0');
-});
-
 test('with config file overrides all options', async () => {
   loadJsonFile.mockImplementationOnce(x => Promise.resolve(x));
   const ignoredOptions = {

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

@@ -0,0 +1,39 @@
+const getFacetsFromIndex = require('../getFacetsFromIndex');
+const getInformationFromIndex = require('../getInformationFromIndex');
+
+jest.mock('../getInformationFromIndex');
+
+test('with search success should fetch attributes', async () => {
+  getInformationFromIndex.mockImplementationOnce(() =>
+    Promise.resolve({
+      facets: {
+        abc: {},
+        def: {},
+        something: {},
+        'something.nested': {},
+      },
+    })
+  );
+
+  const attributes = await getFacetsFromIndex({
+    appId: 'appId',
+    apiKey: 'apiKey',
+    indexName: 'indexName',
+  });
+
+  expect(attributes).toEqual(['abc', 'def', 'something', 'something.nested']);
+});
+
+test('with search failure should return default attributes', async () => {
+  getInformationFromIndex.mockImplementationOnce(() =>
+    Promise.reject(new Error())
+  );
+
+  const attributes = await getFacetsFromIndex({
+    appId: 'appId',
+    apiKey: 'apiKey',
+    indexName: 'indexName',
+  });
+
+  expect(attributes).toEqual([]);
+});

package/src/cli/__tests__/getInformationFromIndex.js

@@ -0,0 +1,68 @@
+const algoliasearch = require('algoliasearch');
+const getInformationFromIndex = require('../getInformationFromIndex');
+
+jest.mock('algoliasearch', () => {
+  const _algoliasearch = jest.fn(() => ({ search: _algoliasearch.__search }));
+  _algoliasearch.__search = jest.fn(() =>
+    Promise.resolve({
+      results: [
+        {
+          hits: [],
+          facets: {},
+        },
+      ],
+    })
+  );
+
+  return _algoliasearch;
+});
+
+test('returns default information', async () => {
+  const info = await getInformationFromIndex({
+    appId: 'a',
+    apiKey: 'a',
+    indexName: 'a',
+  });
+
+  expect(info).toEqual({ hits: [], facets: {} });
+});
+
+test('returns {} on error', async () => {
+  algoliasearch.__search.mockImplementationOnce(() =>
+    Promise.reject(new Error())
+  );
+
+  const info = await getInformationFromIndex({
+    appId: 'a',
+    apiKey: 'a',
+    indexName: 'a',
+  });
+
+  expect(info).toEqual({});
+});
+
+test('creates client once per credentials', async () => {
+  await getInformationFromIndex({
+    appId: 'a',
+    apiKey: 'a',
+    indexName: 'a',
+  });
+
+  expect(algoliasearch).toHaveBeenCalledTimes(1);
+
+  await getInformationFromIndex({
+    appId: 'b',
+    apiKey: 'b',
+    indexName: 'b',
+  });
+
+  expect(algoliasearch).toHaveBeenCalledTimes(2);
+
+  await getInformationFromIndex({
+    appId: 'b',
+    apiKey: 'b',
+    indexName: 'c',
+  });
+
+  expect(algoliasearch).toHaveBeenCalledTimes(2);
+});

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

@@ -4,30 +4,30 @@ test('with appId undefined should ask', () => {
   expect(
     isQuestionAsked({
       question: { name: 'appId', validate: input => Boolean(input) },
-      args: { appId: undefined },
+      args: { appId: undefined, interactive: true },
     })
-  ).toBe(true);
+  ).toBe(false);
 });
 
 test('with appId defined should not ask', () => {
   expect(
     isQuestionAsked({
       question: { name: 'appId', validate: input => Boolean(input) },
-      args: { appId: 'APP_ID' },
+      args: { appId: 'APP_ID', interactive: true },
     })
-  ).toBe(false);
+  ).toBe(true);
 });
 
-test('with unvalid template should ask', () => {
+test('with invalid template should ask', () => {
   expect(
     isQuestionAsked({
       question: {
         name: 'template',
         validate: () => false,
       },
-      args: { template: 'Unvalid' },
+      args: { template: 'Unvalid', interactive: true },
     })
-  ).toBe(true);
+  ).toBe(false);
 });
 
 test('with valid template should not ask', () => {
@@ -37,9 +37,9 @@ test('with valid template should not ask', () => {
         name: 'template',
         validate: () => true,
       },
-      args: { template: 'InstantSearch.js' },
+      args: { template: 'InstantSearch.js', interactive: true },
     })
-  ).toBe(false);
+  ).toBe(true);
 });
 
 test('with indexName should ask attributesToDisplay', () => {
@@ -48,7 +48,29 @@ test('with indexName should ask attributesToDisplay', () => {
       question: {
         name: 'attributesToDisplay',
       },
-      args: { indexName: 'INDEX_NAME' },
+      args: { indexName: 'INDEX_NAME', interactive: true },
     })
   ).toBe(false);
 });
+
+test('with config it does not ask', () => {
+  expect(
+    isQuestionAsked({
+      question: {
+        name: 'attributesToDisplay',
+      },
+      args: { config: '' },
+    })
+  ).toBe(true);
+});
+
+test('with --no-interactive it does not ask', () => {
+  expect(
+    isQuestionAsked({
+      question: {
+        name: 'attributesToDisplay',
+      },
+      args: { interactive: false },
+    })
+  ).toBe(true);
+});

package/src/cli/__tests__/postProcessAnswers.js

@@ -0,0 +1,111 @@
+const postProcessAnswers = require('../postProcessAnswers');
+const utils = require('../../utils');
+
+jest.mock('../../utils', () => ({
+  ...require.requireActual('../../utils'),
+  fetchLibraryVersions: jest.fn(() => Promise.resolve(['1.0.0'])),
+}));
+
+test('merges configuration and answers', async () => {
+  expect(
+    await postProcessAnswers({
+      configuration: { attributesForFaceting: ['test'], b: 1 },
+      answers: { attributesForFaceting: [] },
+      templateConfig: {},
+      optionsFromArguments: {},
+    })
+  ).toEqual(expect.objectContaining({ attributesForFaceting: [], b: 1 }));
+});
+
+describe('libraryVersion', () => {
+  test('library version from answers is used', async () => {
+    const { libraryVersion } = await postProcessAnswers({
+      configuration: {},
+      answers: {
+        template: 'InstantSearch.js',
+        attributesForFaceting: [],
+        libraryVersion: '0.1.2',
+      },
+      optionsFromArguments: {},
+      templateConfig: utils.getAppTemplateConfig(
+        utils.getTemplatePath('InstantSearch.js')
+      ),
+    });
+
+    expect(libraryVersion).toBe('0.1.2');
+  });
+
+  test('library version falls back to beta if it is the only available', async () => {
+    utils.fetchLibraryVersions.mockImplementationOnce(() =>
+      Promise.resolve(['1.0.0-beta.0'])
+    );
+
+    const { libraryVersion } = await postProcessAnswers({
+      configuration: {},
+      answers: {
+        template: 'InstantSearch.js',
+        attributesForFaceting: [],
+      },
+      optionsFromArguments: {},
+      templateConfig: utils.getAppTemplateConfig(
+        utils.getTemplatePath('InstantSearch.js')
+      ),
+    });
+
+    expect(libraryVersion).toBe('1.0.0-beta.0');
+  });
+});
+
+test('creates alternative names', async () => {
+  expect(
+    await postProcessAnswers({
+      configuration: {},
+      answers: {
+        attributesForFaceting: [],
+        organization: 'algolia',
+        name: 'date-range',
+      },
+      templateConfig: {
+        packageNamePrefix: 'instantsearch-widget-',
+      },
+      optionsFromArguments: {},
+    })
+  ).toEqual(
+    expect.objectContaining({
+      packageName: '@algolia/instantsearch-widget-date-range',
+      widgetType: 'algolia.date-range',
+      camelCaseName: 'dateRange',
+      pascalCaseName: 'DateRange',
+    })
+  );
+});
+
+test('detects dynamic widgets', async () => {
+  expect(
+    await postProcessAnswers({
+      configuration: {},
+      templateConfig: {},
+      optionsFromArguments: {},
+      answers: { attributesForFaceting: ['ais.dynamicWidgets', 'test'] },
+    })
+  ).toEqual(
+    expect.objectContaining({
+      attributesForFaceting: ['test'],
+      flags: { dynamicWidgets: true },
+    })
+  );
+
+  expect(
+    await postProcessAnswers({
+      configuration: {},
+      templateConfig: {},
+      optionsFromArguments: {},
+      answers: { attributesForFaceting: ['test'] },
+    })
+  ).toEqual(
+    expect.objectContaining({
+      attributesForFaceting: ['test'],
+      flags: { dynamicWidgets: false },
+    })
+  );
+});

package/src/cli/getAnswersDefaultValues.js

@@ -0,0 +1,13 @@
+module.exports = function getAnswersDefaultValues(
+  optionsFromArguments,
+  configuration,
+  template
+) {
+  return {
+    ...configuration,
+    ...optionsFromArguments,
+    template,
+    // name has a default of '', as it's a special case in Commander
+    name: optionsFromArguments.name || configuration.name,
+  };
+};

package/src/cli/getAttributesFromIndex.js

@@ -1,17 +1,19 @@
-const algoliasearch = require('algoliasearch');
+const getInformationFromIndex = require('./getInformationFromIndex');
 
 module.exports = async function getAttributesFromIndex({
   appId,
   apiKey,
   indexName,
 } = {}) {
-  const client = algoliasearch(appId, apiKey);
-  const index = client.initIndex(indexName);
   const defaultAttributes = ['title', 'name', 'description'];
   let attributes = [];
 
   try {
-    const { hits } = await index.search({ hitsPerPage: 1 });
+    const { hits } = await getInformationFromIndex({
+      appId,
+      apiKey,
+      indexName,
+    });
     const [firstHit] = hits;
     const highlightedAttributes = Object.keys(firstHit._highlightResult);
     attributes = [

package/src/cli/getConfiguration.js

@@ -1,37 +1,4 @@
-const latestSemver = require('latest-semver');
 const loadJsonFile = require('load-json-file');
-const camelCase = require('lodash.camelcase');
-
-const { fetchLibraryVersions } = require('../utils');
-
-function capitalize(str) {
-  return str.substr(0, 1).toUpperCase() + str.substr(1);
-}
-
-function createNameAlternatives({ organization, name, templateConfig }) {
-  return {
-    packageName: `@${organization}/${templateConfig.packageNamePrefix ||
-      ''}${name}`,
-    widgetType: `${organization}.${name}`,
-    camelCaseName: camelCase(name),
-    pascalCaseName: capitalize(camelCase(name)),
-  };
-}
-
-async function getLibraryVersion(config, templateConfig) {
-  const { libraryName } = templateConfig;
-  const { libraryVersion } = config;
-
-  if (libraryName && !libraryVersion) {
-    const versions = await fetchLibraryVersions(libraryName);
-
-    // Return the latest available version when
-    // the stable version is not available
-    return latestSemver(versions) || versions[0];
-  }
-
-  return libraryVersion;
-}
 
 async function getConfiguration({ options = {}, answers = {} } = {}) {
   const config = options.config
@@ -45,8 +12,4 @@ async function getConfiguration({ options = {}, answers = {} } = {}) {
   return config;
 }
 
-module.exports = {
-  getConfiguration,
-  getLibraryVersion,
-  createNameAlternatives,
-};
+module.exports = getConfiguration;

package/src/cli/getFacetsFromIndex.js

@@ -0,0 +1,18 @@
+const getInformationFromIndex = require('./getInformationFromIndex');
+
+module.exports = async function getFacetsFromIndex({
+  appId,
+  apiKey,
+  indexName,
+} = {}) {
+  try {
+    const { facets } = await getInformationFromIndex({
+      appId,
+      apiKey,
+      indexName,
+    });
+    return Object.keys(facets);
+  } catch (err) {
+    return [];
+  }
+};