create-instantsearch-app 6.4.2 → 7.0.0

package/src/templates/React InstantSearch Native/App.js.hbs

@@ -1,38 +0,0 @@
-import React from 'react';
-import { StyleSheet, View, SafeAreaView, StatusBar } from 'react-native';
-import algoliasearch from 'algoliasearch';
-import { InstantSearch } from 'react-instantsearch-native';
-import SearchBox from './src/SearchBox';
-import InfiniteHits from './src/InfiniteHits';
-
-const searchClient = algoliasearch(
-  '{{appId}}',
-  '{{apiKey}}'
-);
-
-const styles = StyleSheet.create({
-  safe: {
-    flex: 1,
-    backgroundColor: '#252b33',
-  },
-  container: {
-    flex: 1,
-    backgroundColor: '#FFFFFF',
-  },
-});
-
-const App = () => {
-  return (
-    <SafeAreaView style={styles.safe}>
-      <StatusBar barStyle="light-content" />
-      <View style={styles.container}>
-        <InstantSearch searchClient={searchClient} indexName="{{indexName}}">
-          <SearchBox />
-          <InfiniteHits />
-        </InstantSearch>
-      </View>
-    </SafeAreaView>
-  );
-};
-
-export default App;

package/src/templates/React InstantSearch Native/src/Highlight.js

@@ -1,36 +0,0 @@
-import React from 'react';
-import { Text } from 'react-native';
-import PropTypes from 'prop-types';
-import { connectHighlight } from 'react-instantsearch-native';
-
-const Highlight = ({ attribute, hit, highlight }) => {
-  const highlights = highlight({
-    highlightProperty: '_highlightResult',
-    attribute,
-    hit,
-  });
-
-  return (
-    <Text>
-      {highlights.map(({ value, isHighlighted }, index) => {
-        const style = {
-          backgroundColor: isHighlighted ? 'yellow' : 'transparent',
-        };
-
-        return (
-          <Text key={index} style={style}>
-            {value}
-          </Text>
-        );
-      })}
-    </Text>
-  );
-};
-
-Highlight.propTypes = {
-  attribute: PropTypes.string.isRequired,
-  hit: PropTypes.object.isRequired,
-  highlight: PropTypes.func.isRequired,
-};
-
-export default connectHighlight(Highlight);

package/src/templates/React InstantSearch Native/src/InfiniteHits.js.hbs

@@ -1,56 +0,0 @@
-import React from 'react';
-import { StyleSheet, Text, View, FlatList } from 'react-native';
-import PropTypes from 'prop-types';
-import { connectInfiniteHits } from 'react-instantsearch-native';
-{{#if attributesToDisplay}}
-import Highlight from './Highlight';
-{{/if}}
-
-const styles = StyleSheet.create({
-  separator: {
-    borderBottomWidth: 1,
-    borderColor: '#ddd',
-  },
-  item: {
-    padding: 10,
-    flexDirection: 'column',
-  },
-  titleText: {
-    fontWeight: 'bold',
-  },
-});
-
-const InfiniteHits = ({ hits, hasMore, refineNext }) => (
-  <FlatList
-    data={hits}
-    keyExtractor={item => item.objectID}
-    ItemSeparatorComponent={() => <View style={styles.separator} />}
-    onEndReached={() => hasMore && refineNext()}
-    renderItem={({ item }) => (
-      <View style={styles.item}>
-        {{#if attributesToDisplay}}
-        <Text style={styles.titleText}>
-          <Highlight attribute="{{attributesToDisplay.[0]}}" hit={item} />
-        </Text>
-        {{#each attributesToDisplay}}
-        {{#unless @first}}
-        <Text>
-          <Highlight attribute="{{this}}" hit={item} />
-        </Text>
-        {{/unless}}
-        {{/each}}
-        {{else}}
-        <Text>{JSON.stringify(item).slice(0, 100)}</Text>
-        {{/if}}
-      </View>
-    )}
-  />
-);
-
-InfiniteHits.propTypes = {
-  hits: PropTypes.arrayOf(PropTypes.object).isRequired,
-  hasMore: PropTypes.bool.isRequired,
-  refineNext: PropTypes.func.isRequired,
-};
-
-export default connectInfiniteHits(InfiniteHits);

package/src/templates/React InstantSearch Native/src/SearchBox.js.hbs

@@ -1,42 +0,0 @@
-import React from 'react';
-import { StyleSheet, View, TextInput } from 'react-native';
-import PropTypes from 'prop-types';
-import { connectSearchBox } from 'react-instantsearch-native';
-
-const styles = StyleSheet.create({
-  container: {
-    padding: 16,
-    backgroundColor: '#252b33',
-  },
-  input: {
-    height: 48,
-    padding: 12,
-    fontSize: 16,
-    backgroundColor: '#fff',
-    borderRadius: 4,
-    borderWidth: 1,
-    borderColor: '#ddd',
-    shadowColor: '#000',
-    shadowOffset: { width: 0, height: 2 },
-    shadowOpacity: 0.2,
-    shadowRadius: 2,
-  },
-});
-
-const SearchBox = ({ currentRefinement, refine }) => (
-  <View style={styles.container}>
-    <TextInput
-      style={styles.input}
-      onChangeText={value => refine(value)}
-      value={currentRefinement}
-      placeholder="{{searchPlaceholder}}"
-    />
-  </View>
-);
-
-SearchBox.propTypes = {
-  currentRefinement: PropTypes.string.isRequired,
-  refine: PropTypes.func.isRequired,
-};
-
-export default connectSearchBox(SearchBox);

package/src/templates/React InstantSearch widget/.eslintignore

@@ -1,2 +0,0 @@
-/dist
-node_modules/

package/src/templates/React InstantSearch widget/.eslintrc.cjs

@@ -1,13 +0,0 @@
-// eslint-disable-next-line import/no-commonjs
-module.exports = {
-  extends: ['algolia', 'algolia/jest', 'algolia/react', 'algolia/typescript'],
-  rules: {
-    '@typescript-eslint/explicit-function-return-type': 'off',
-    'jest/expect-expect': 'off',
-  },
-  settings: {
-    react: {
-      version: 'detect',
-    },
-  },
-};

package/src/templates/React InstantSearch widget/.prettierrc

@@ -1,5 +0,0 @@
-{
-  "singleQuote": true,
-  "proseWrap": "never",
-  "trailingComma": "es5"
-}

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

@@ -1,21 +0,0 @@
-const install = require('../../tasks/node/install');
-const teardown = require('../../tasks/node/teardown');
-
-module.exports = {
-  category: 'Widget',
-  libraryName: 'react-instantsearch',
-  supportedVersion: '>= 6.0.0 < 7.0.0',
-  templateName: 'react-instantsearch-widget',
-  packageNamePrefix: 'react-instantsearch-widget-',
-  keywords: [
-    'algolia',
-    'InstantSearch',
-    'React',
-    'react-instantsearch',
-    'widget',
-  ],
-  tasks: {
-    install,
-    teardown,
-  },
-};

package/src/templates/React InstantSearch widget/CONTRIBUTING.md

@@ -1,49 +0,0 @@
-# Contribution Guide
-
-## Test
-
-```bash
-npm test
-# or
-yarn test
-```
-
-## Build
-
-```bash
-npm run build
-# or
-yarn build
-```
-
-## Run example
-
-```bash
-npm start
-# or
-yarn start
-```
-
-## Release
-
-```bash
-npm run release
-# or
-yarn release
-```
-
-### First Release
-
-```bash
-npm run release -- --first-release
-# or
-yarn release --first-release
-```
-
-This will tag a release without bumping the version.
-
-When you are ready, push the git tag and run `npm publish`.
-
-If you want to publish it as a public scoped package, run `npm publish --access public` the first time.
-
-[To know more about `standard-version`, read this →](https://github.com/conventional-changelog/standard-version#cli-usage)

package/src/templates/React InstantSearch widget/LICENSE.md.hbs

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) {{ currentYear }}-present {{ organization }}.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/src/templates/React InstantSearch widget/README.md

@@ -1,85 +0,0 @@
-# {{name}}
-
-{{ description }}
-
----
-
-[![MIT](https://img.shields.io/npm/l/{{ packageName }})](./LICENSE) [![NPM version](http://img.shields.io/npm/v/{{ packageName }}.svg)](https://npmjs.org/package/{{ packageName }})
-
-## Install
-
-```bash
-npm install {{ packageName }}
-# or
-yarn add {{ packageName }}
-```
-
-## Widget
-
-### Usage
-
-```jsx
-import algoliasearch from 'algoliasearch/lite';
-import { InstantSearch } from 'react-instantsearch-dom';
-import { {{ pascalCaseName }} } from '{{ packageName }}';
-
-const searchClient = algoliasearch('appId', 'apiKey');
-
-const App = () => (
-  <InstantSearch searchClient={searchClient} indexName="indexName">
-    <{{ pascalCaseName }} />
-  </InstantSearch>
-);
-```
-
-### Options
-
-| Option | Type | Required | Default | Description |
-| :-- | :-- | :-- | :-- | --- |
-| [`option1`](#option1) | `string` | true | - | REPLACE WITH THE DESCRIPTION FOR THIS OPTION |
-
-#### option1
-
-> `string` | **required**
-
-REPLACE WITH THE DESCRIPTION FOR THIS OPTION
-
-## Connector
-
-### Usage
-
-```jsx
-import { connect{{ pascalCaseName }} } from '{{ packageName }}';
-
-// 1. Create a render function
-const Render{{ pascalCaseName }} = (renderOptions, isFirstRender) => {
-  // Rendering logic
-};
-
-// 2. Create the custom widget
-const Custom{{ pascalCaseName }} = connect{{ pascalCaseName }}(
-  Render{{ pascalCaseName }}
-);
-
-// 3. Instantiate
-const App = () => (
-  <InstantSearch searchClient={searchClient} indexName="indexName">
-    <Custom{{ pascalCaseName }} />
-  </InstantSearch>
-);
-```
-
-## Contributing
-
-To start contributing to code, you need to:
-
-1. [Fork the project](https://docs.github.com/en/get-started/quickstart/fork-a-repo)
-2. [Clone the repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository)
-3. Install the dependencies: `yarn`
-4. Run the development mode: `yarn start`
-
-Please read [our contribution process](./CONTRIBUTING.md) to learn more.
-
----
-
-_This project was generated with [create-instantsearch-app](https://github.com/algolia/instantsearch/tree/master/packages/create-instantsearch-app) by [Algolia](https://algolia.com)._

package/src/templates/React InstantSearch widget/babel.config.cjs

@@ -1,8 +0,0 @@
-// eslint-disable-next-line import/no-commonjs
-module.exports = {
-  presets: [
-    ['@babel/preset-env', { targets: { node: 'current' } }],
-    '@babel/preset-react',
-    '@babel/preset-typescript',
-  ],
-};

package/src/templates/React InstantSearch widget/example/index.html.hbs

@@ -1,12 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>{{ packageName }} | example</title>
-  </head>
-  <body>
-    <div id="root"></div>
-    <script type="module" src="./index.tsx"></script>
-  </body>
-</html>

package/src/templates/React InstantSearch widget/example/index.tsx.hbs

@@ -1,22 +0,0 @@
-import algoliasearch from 'algoliasearch/lite';
-import React from 'react';
-import ReactDOM from 'react-dom';
-import { InstantSearch, SearchBox, Hits } from 'react-instantsearch-dom';
-
-import { {{ pascalCaseName }} } from '../src';
-
-const searchClient = algoliasearch(
-  'latency',
-  '6be0576ff61c053d5f9a3225e2a90f76'
-);
-
-ReactDOM.render(
-  <React.StrictMode>
-    <InstantSearch indexName="instant_search" searchClient={searchClient}>
-      <{{ pascalCaseName }} />
-      <SearchBox />
-      <Hits />
-    </InstantSearch>
-  </React.StrictMode>,
-  document.getElementById('root')
-);

package/src/templates/React InstantSearch widget/package.json.hbs

@@ -1,81 +0,0 @@
-{
-  "name": "{{ packageName }}",
-  "version": "1.0.0",
-  "description": "{{ description }}",
-  "keywords": [
-    "instantsearch-widget",
-    "instantsearch",
-    "react-instantsearch",
-    "react-instantsearch-widget-{{ name }}",
-    "widget",
-    "connector",
-    "algolia"
-  ],
-  "license": "MIT",
-  "main": "./dist/index.cjs.js",
-  "module": "./dist/index.es.js",
-  "exports": {
-    "import": "./dist/index.es.js",
-    "require": "./dist/index.cjs.js"
-  },
-  "jsdelivr": "./dist/index.umd.js",
-  "unpkg": "./dist/index.umd.js",
-  "types": "./dist/index.d.ts",
-  "type": "module",
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "start": "vite example",
-    "prebuild": "rm -rf dist",
-    "build": "vite build && npm run build:types",
-    "build:types": "tsc -p tsconfig.declaration.json",
-    "lint": "eslint --ext .js,.ts,.tsx .",
-    "lint:fix": "npm run lint --fix",
-    "test": "NODE_OPTIONS=--experimental-vm-modules jest",
-    "test:watch": "npm test -- --watch",
-    "test:types": "tsc",
-    "prerelease": "npm run build",
-    "release": "standard-version"
-  },
-  "dependencies": {
-    "algoliasearch": "4",
-    "react": "^16.8.0",
-    "react-dom": "^16.8.0",
-    "react-instantsearch-dom": "^6.26.0"
-  },
-  "devDependencies": {
-    "@babel/core": "7.14.3",
-    "@babel/preset-env": "7.14.2",
-    "@babel/preset-react": "7.13.13",
-    "@babel/preset-typescript": "7.13.0",
-    "@testing-library/react": "11.2.7",
-    "@types/jest": "26.0.23",
-    "@types/node": "15.3.0",
-    "@types/react": "17.0.0",
-    "@types/react-dom": "17.0.0",
-    "@types/react-instantsearch-core": "6.26.0",
-    "@types/react-instantsearch-dom": "6.10.0",
-    "@typescript-eslint/eslint-plugin": "4.24.0",
-    "@typescript-eslint/parser": "4.24.0",
-    "@vitejs/plugin-react-refresh": "1.3.1",
-    "babel-eslint": "10.1.0",
-    "babel-jest": "26.6.3",
-    "eslint": "7.26.0",
-    "eslint-config-algolia": "18.0.0",
-    "eslint-config-prettier": "8.3.0",
-    "eslint-plugin-eslint-comments": "3.2.0",
-    "eslint-plugin-import": "2.23.2",
-    "eslint-plugin-jest": "24.3.6",
-    "eslint-plugin-jsdoc": "34.8.1",
-    "eslint-plugin-jsx-a11y": "6.4.1",
-    "eslint-plugin-prettier": "3.4.0",
-    "eslint-plugin-react": "7.23.2",
-    "eslint-plugin-react-hooks": "4.2.0",
-    "jest": "26.6.3",
-    "prettier": "2.3.0",
-    "standard-version": "9.3.0",
-    "typescript": "4.2.4",
-    "vite": "2.3.3"
-  }
-}

package/src/templates/React InstantSearch widget/src/index.tsx.hbs

@@ -1,3 +0,0 @@
-export { connect{{ pascalCaseName }} } from './lib/connector';
-export { {{ pascalCaseName }}Component } from './lib/component';
-export { {{ pascalCaseName }} } from './lib/widget';

package/src/templates/React InstantSearch widget/src/lib/__tests__/dummy-test.tsx.hbs

@@ -1,39 +0,0 @@
-import { render } from '@testing-library/react';
-import React from 'react';
-import { InstantSearch, Hits } from 'react-instantsearch-dom';
-
-import { {{ pascalCaseName }} } from '../widget';
-
-const runAllMicroTasks = (): Promise<void> => new Promise(setImmediate);
-
-describe('nothing', () => {
-  it('tests nothing', async () => {
-    const searchClient = {
-      search(_requests: any[]) {
-        return Promise.resolve({
-          results: [
-            {
-              hits:
-              [
-                {
-                  objectID: 'a',
-                  name: 'test',
-                },
-              ],
-            },
-          ],
-        });
-      },
-    };
-
-    const { debug } = render(
-      <InstantSearch indexName="test_index" searchClient={searchClient}>
-        <{{ pascalCaseName }} />
-        <Hits hitComponent={({ hit }: { hit: any }) => hit.name} />
-      </InstantSearch>
-    );
-
-    await runAllMicroTasks();
-    debug();
-  });
-});

package/src/templates/React InstantSearch widget/src/lib/component.tsx.hbs

@@ -1,15 +0,0 @@
-import React from 'react';
-
-import type { ProvidedProps } from './connector'
-
-type Props = ProvidedProps & {
-  refine: () => void;
-};
-
-export const {{ pascalCaseName }}Component = ({}: Props) => {
-  return (
-    <div>
-      {/* TODO: render something */}
-    </div>
-  );
-};

package/src/templates/React InstantSearch widget/src/lib/connector.ts.hbs

@@ -1,35 +0,0 @@
-import type { Connector } from '../types/connector';
-
-import { createConnector } from 'react-instantsearch-dom';
-
-export type ProvidedProps = {
-  // TODO: fill props that are returned by `getProvidedProps`
-}
-
-export const connect{{ pascalCaseName }}: Connector<ProvidedProps> = createConnector<ProvidedProps>({
-  displayName: '{{ pascalCaseName }}',
-  $$type: '{{ widgetType }}',
-
-  getProvidedProps(props, searchState, searchResults) {
-    return {
-      // TODO: return a props for the component
-    };
-  },
-
-  refine(props, searchState, nextRefinement) {
-    return {
-      // TODO: return a next searchState
-    };
-  },
-
-  cleanUp(props, searchState) {
-    return {
-      // TODO: return a searchState where this widget is removed from the widget tree
-    };
-  },
-
-  getSearchParameters(searchParameters, props, searchState) {
-    // TODO: update and return the searchParameters
-    return searchParameters;
-  },
-});

package/src/templates/React InstantSearch widget/src/lib/widget.tsx.hbs

@@ -1,14 +0,0 @@
-import { {{ pascalCaseName }}Component } from './component';
-import { connect{{ pascalCaseName }} } from './connector';
-
-type WidgetParams = {
-  /**
-   * Placeholder text for input element.
-   */
-  placeholder?: string;
-};
-
-export const {{ pascalCaseName }}: React.ElementType<WidgetParams> = connect{{ pascalCaseName }}(
-  {{ pascalCaseName }}Component,
-  { $$widgetType: '{{ widgetType }}' }
-);

package/src/templates/React InstantSearch widget/src/types/connector.ts

@@ -1,17 +0,0 @@
-import type {
-  ConnectedComponentClass,
-  ConnectorProvided,
-} from 'react-instantsearch-core';
-
-type AdditionalWidgetProperties = {
-  $$widgetType?: string;
-};
-
-export type Connector<TProvided = {}, TExposed = {}> = ((
-  stateless: React.FunctionComponent<ConnectorProvided<TProvided>>,
-  additionalWidgetProperties: AdditionalWidgetProperties
-) => React.ComponentClass<TExposed>) &
-  (<TProps extends Partial<ConnectorProvided<TProvided>>>(
-    Composed: React.ComponentType<TProps>,
-    additionalWidgetProperties: AdditionalWidgetProperties
-  ) => ConnectedComponentClass<TProps, ConnectorProvided<TProvided>, TExposed>);

package/src/templates/React InstantSearch widget/tsconfig.declaration.json

@@ -1,10 +0,0 @@
-{
-  "extends": "./tsconfig",
-  "compilerOptions": {
-    "outDir": "dist",
-    "noEmit": false,
-    "declaration": true,
-    "emitDeclarationOnly": true
-  },
-  "exclude": ["example/index.tsx", "**/__tests__"]
-}

package/src/templates/React InstantSearch widget/tsconfig.json

@@ -1,20 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ESNext",
-    "lib": ["DOM", "DOM.Iterable", "ESNext"],
-    "types": ["vite/client", "node", "jest"],
-    "allowJs": false,
-    "skipLibCheck": true,
-    "esModuleInterop": false,
-    "allowSyntheticDefaultImports": true,
-    "strict": true,
-    "forceConsistentCasingInFileNames": true,
-    "module": "ESNext",
-    "moduleResolution": "Node",
-    "resolveJsonModule": true,
-    "isolatedModules": true,
-    "noEmit": true,
-    "jsx": "react"
-  },
-  "include": ["./src", "example/index.tsx"]
-}