├── .gitignore ├── .nvmrc ├── LICENSE.txt ├── NOTICE.txt ├── README.md ├── bin └── ensure_engine_config.sh ├── logo-app-search.png ├── package-lock.json ├── package.json ├── public ├── favicon.ico ├── index.html └── manifest.json ├── scripts └── build-no-chunks.js └── src ├── App.js ├── config ├── config-helper.js └── engine.json.example └── index.js /.gitignore: -------------------------------------------------------------------------------- 1 | # See https://help.github.com/ignore-files/ for more about ignoring files. 2 | 3 | # dependencies 4 | /node_modules 5 | 6 | # testing 7 | /coverage 8 | 9 | # production 10 | /build 11 | 12 | # misc 13 | .DS_Store 14 | .env.local 15 | .env.development.local 16 | .env.test.local 17 | .env.production.local 18 | 19 | .netlify 20 | 21 | npm-debug.log* 22 | yarn-debug.log* 23 | yarn-error.log* 24 | 25 | src/config/engine.json 26 | -------------------------------------------------------------------------------- /.nvmrc: -------------------------------------------------------------------------------- 1 | 16.13.0 -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2019 Elasticsearch B.V. 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /NOTICE.txt: -------------------------------------------------------------------------------- 1 | Elastic App Search Reference UI. 2 | 3 | Copyright 2012-2022 Elasticsearch B.V. 4 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## Contents 2 | 3 | - [Getting started](#getting-started-) 4 | - [Usage](#usage) 5 | - [FAQ](#faq-) 6 | - [License](#license-) 7 | 8 | --- 9 | 10 | ## Getting started 🐣 11 | 12 | This is a generated search experience created with [Search UI](https://github.com/elastic/search-ui). 13 | 14 | To set up and run this project, follow the instructions below. 15 | 16 | Requires [npm](https://www.npmjs.com/). 17 | 18 | Dependencies: 19 | - Node v16.13.0 20 | 21 | One can leverage [NVM](https://github.com/nvm-sh/nvm) to install Node before proceeding to start the application by running the following commands: 22 | 23 | ```bash 24 | # Run this to install Node 16.13.0 25 | nvm install 16.13.0 26 | 27 | # Run this to use the installed Node version 28 | nvm use 16.13.0 29 | ``` 30 | 31 | Run the following commands to start this application: 32 | 33 | ```bash 34 | # Run the `cd` command to change the current directory to the 35 | # location of your downloaded Reference UI. Replace the path 36 | # below with the actual path of your project. 37 | cd ~/Downloads/app-search-reference-ui 38 | 39 | # Run this to set everything up 40 | npm install 41 | 42 | # Run this to start your application and open it up in a new browser window 43 | npm start 44 | ``` 45 | 46 | ## Usage 47 | 48 | ### Updating configuration 49 | 50 | The project is configured via a JSON [config file](src/config/engine.json). This file has been automatically generated for you when downloading this project. If you would like to make configuration changes, there is no need to regenerate this app from your App Search Dashboard. Additional configuration can be made by modifying that file. 51 | 52 | You can simply open up the 53 | [engine.json](src/config/engine.json) file, update the [options](#config), 54 | and then restart this app. 55 | 56 | ### Configuration options 57 | 58 | The following is a complete list of options available for configuration in [engine.json](src/config/engine.json). 59 | 60 | | option | value type | required/optional | source | 61 | | -------------------- | ------------- | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | 62 | | `engineName` | String | required | Found in your App Search Dashboard. | 63 | | `endpointBase` | String | required* | (*) Elastic Enterprise Search deployment URL, example: "http://127.0.0.1:3002". | 64 | | `searchKey` | String | required | Found in your App Search Dashboard. | 65 | | `searchFields` | Array[String] | required | A list of fields that will be searched with your search term. | 66 | | `resultFields` | Array[String] | required | A list of fields that will be displayed within your results. | 67 | | `querySuggestFields` | Array[String] | optional | A list of fields that will be searched and displayed as query suggestions. | 68 | | `titleField` | String | optional | The field to display as the title in results. | 69 | | `urlField` | String | optional | A field with a url to use as a link in results. | 70 | | `sortFields` | Array[String] | optional | A list of fields that will be used for sort options. | 71 | | `facets` | Array[String] | optional | A list of fields that will be available as "facet" filters. Read more about facets within the [App Search documentation](https://www.elastic.co/guide/en/app-search/current/facets-guide.html). | 72 | 73 | ## Building and embedding 74 | 75 | To embed this application into a website, it can be built into static assets using the following command: 76 | ``` 77 | npm run build 78 | ``` 79 | 80 | This will create two files in the `build` directory: 81 | ``` 82 | build/static/js/main..js 83 | build/static/css/main..css 84 | ``` 85 | 86 | Include the built static assets as well as an element with `id="root"`. For example: 87 | ```html 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 |
96 | 97 | 98 | ``` 99 | 100 | ## Deploy and Share 101 | 102 | This app can be easily published to any server as static assets and served. We recommend [Netlify](https://www.netlify.com/), but you have other [options](https://facebook.github.io/create-react-app/docs/deployment) as well. 103 | 104 | To deploy: 105 | 106 | ``` 107 | npm run build 108 | npm install netlify-cli -g 109 | netlify deploy # enter ./build as the deploy path 110 | ``` 111 | 112 | You'll then simply follow the command prompt to log into Netlify and deploy your site. This can be completed in just a few minutes. 113 | 114 | ### External configuration 115 | 116 | If you are embedding this app inside of another page, and you would like to 117 | source the configuration from outside of the `engine.json` file, 118 | you can simply write the configuration directly to `window.appConfig`. 119 | 120 | ### If you are checking this project out directly from GitHub... 121 | 122 | You can follow the previous steps, but then you will need to create and configure 123 | [engine.json](src/config/engine.json). 124 | 125 | To do so, make a copy of [engine.json.example](src/config/engine.json.example), 126 | rename it to `engine.json` and configure it with your Engine's specific details. 127 | 128 | ```bash 129 | cp src/config/engine.json.example src/config/engine.json 130 | ``` 131 | 132 | ## Customization 133 | 134 | This project is built with [Search UI](https://github.com/elastic/search-ui), which is a React library for building search experiences. If you're interested in using this project as a base for your own, most of 135 | what you'll need can be found in the Search UI documentation. 136 | 137 | ## FAQ 🔮 138 | 139 | ### Where do I report issues with this application? 140 | 141 | If something is not working as expected, please open an [issue](https://github.com/elastic/app-search-reference-ui-react/issues/new). 142 | 143 | 144 | ### Where else can I go to get help? 145 | 146 | You can checkout the [Elastic Enterprise Search community discuss forums](https://discuss.elastic.co/c/enterprise-search/84). 147 | 148 | ## License 📗 149 | 150 | [Apache-2.0](https://github.com/elastic/app-search-reference-ui-react/blob/master/LICENSE.txt) © [Elastic](https://github.com/elastic) 151 | -------------------------------------------------------------------------------- /bin/ensure_engine_config.sh: -------------------------------------------------------------------------------- 1 | project_root=$( cd "$(dirname "${BASH_SOURCE[0]}")/.." ; pwd -P ) 2 | 3 | if [[ ! -e ${project_root}/src/config/engine.json ]]; then 4 | echo "{}" > src/config/engine.json 5 | echo "wrote empty engine.json" 6 | else 7 | echo "engine.json already exists" 8 | fi 9 | -------------------------------------------------------------------------------- /logo-app-search.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/elastic/app-search-reference-ui-react/1802f935cbab477954315f5e9f75bc2ee266a36c/logo-app-search.png -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "app-search-reference-ui-react", 3 | "version": "1.8.0", 4 | "private": true, 5 | "dependencies": { 6 | "@elastic/react-search-ui": "latest", 7 | "@elastic/search-ui-app-search-connector": "latest", 8 | "react": "^17.0.2", 9 | "react-dom": "^17.0.2", 10 | "react-scripts": "5.0.0" 11 | }, 12 | "devDependencies": { 13 | "rewire": "^6.0.0" 14 | }, 15 | "scripts": { 16 | "start": "react-scripts start", 17 | "build-js": "node ./scripts/build-no-chunks.js", 18 | "build": "npm run build-js", 19 | "test": "react-scripts test", 20 | "eject": "react-scripts eject" 21 | }, 22 | "eslintConfig": { 23 | "extends": [ 24 | "react-app", 25 | "react-app/jest" 26 | ] 27 | }, 28 | "browserslist": { 29 | "production": [ 30 | ">0.2%", 31 | "not dead", 32 | "not op_mini all" 33 | ], 34 | "development": [ 35 | "last 1 chrome version", 36 | "last 1 firefox version", 37 | "last 1 safari version" 38 | ] 39 | } 40 | } 41 | -------------------------------------------------------------------------------- /public/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/elastic/app-search-reference-ui-react/1802f935cbab477954315f5e9f75bc2ee266a36c/public/favicon.ico -------------------------------------------------------------------------------- /public/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 9 | 10 | 11 | 12 | App Search Reference UI 13 | 14 | 15 | 16 | 19 |
20 | 21 | 22 | -------------------------------------------------------------------------------- /public/manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "short_name": "Reference UI", 3 | "name": "App Search Reference UI", 4 | "icons": [ 5 | { 6 | "src": "favicon.ico", 7 | "sizes": "64x64 48x48 32x32 24x24 16x16", 8 | "type": "image/x-icon" 9 | } 10 | ], 11 | "start_url": "./index.html", 12 | "display": "standalone", 13 | "theme_color": "#000000", 14 | "background_color": "#ffffff" 15 | } 16 | -------------------------------------------------------------------------------- /scripts/build-no-chunks.js: -------------------------------------------------------------------------------- 1 | // https://github.com/facebook/create-react-app/issues/5306#issuecomment-433425838 2 | // I am including this so that when we build, we get a single, "main.xxxx.js" file 3 | // in our build, which we can include in website. 4 | 5 | const rewire = require("rewire"); 6 | const defaults = rewire("react-scripts/scripts/build.js"); 7 | let config = defaults.__get__("config"); 8 | 9 | config.optimization.splitChunks = { 10 | cacheGroups: { 11 | default: false 12 | } 13 | }; 14 | 15 | config.optimization.runtimeChunk = false; 16 | -------------------------------------------------------------------------------- /src/App.js: -------------------------------------------------------------------------------- 1 | import React from "react"; 2 | 3 | import AppSearchAPIConnector from "@elastic/search-ui-app-search-connector"; 4 | 5 | import { 6 | ErrorBoundary, 7 | Facet, 8 | SearchProvider, 9 | SearchBox, 10 | Results, 11 | PagingInfo, 12 | ResultsPerPage, 13 | Paging, 14 | Sorting, 15 | WithSearch 16 | } from "@elastic/react-search-ui"; 17 | import { Layout } from "@elastic/react-search-ui-views"; 18 | import "@elastic/react-search-ui-views/lib/styles/styles.css"; 19 | 20 | import { 21 | buildAutocompleteQueryConfig, 22 | buildFacetConfigFromConfig, 23 | buildSearchOptionsFromConfig, 24 | buildSortOptionsFromConfig, 25 | getConfig, 26 | getFacetFields 27 | } from "./config/config-helper"; 28 | 29 | const { hostIdentifier, searchKey, endpointBase, engineName } = getConfig(); 30 | const connector = new AppSearchAPIConnector({ 31 | searchKey, 32 | engineName, 33 | hostIdentifier, 34 | endpointBase 35 | }); 36 | const config = { 37 | searchQuery: { 38 | facets: buildFacetConfigFromConfig(), 39 | ...buildSearchOptionsFromConfig() 40 | }, 41 | autocompleteQuery: buildAutocompleteQueryConfig(), 42 | apiConnector: connector, 43 | alwaysSearchOnInitialLoad: true 44 | }; 45 | 46 | export default function App() { 47 | return ( 48 | 49 | ({ wasSearched })}> 50 | {({ wasSearched }) => { 51 | return ( 52 |
53 | 54 | } 56 | sideContent={ 57 |
58 | {wasSearched && ( 59 | 63 | )} 64 | {getFacetFields().map(field => ( 65 | 66 | ))} 67 |
68 | } 69 | bodyContent={ 70 | 76 | } 77 | bodyHeader={ 78 | 79 | {wasSearched && } 80 | {wasSearched && } 81 | 82 | } 83 | bodyFooter={} 84 | /> 85 | 86 |
87 | ); 88 | }} 89 | 90 | 91 | ); 92 | } 93 | -------------------------------------------------------------------------------- /src/config/config-helper.js: -------------------------------------------------------------------------------- 1 | import config from "../config/engine.json"; 2 | 3 | /** 4 | * This file abstracts most logic around the configuration of the Reference UI. 5 | * 6 | * Configuration is an important part of the "reusability" and "generic-ness" of 7 | * the Reference UI, but if you are using this app as a starting point for own 8 | * project, everything related to configuration can largely be thrown away. To 9 | * that end, this file attempts to contain most of that logic to one place. 10 | */ 11 | 12 | export function getConfig() { 13 | if (process.env.NODE_ENV === "test") { 14 | return {}; 15 | } 16 | 17 | if (config.engineName) return config; 18 | 19 | if ( 20 | typeof window !== "undefined" && 21 | window.appConfig && 22 | window.appConfig.engineName 23 | ) { 24 | return window.appConfig; 25 | } 26 | 27 | return {}; 28 | } 29 | 30 | function toLowerCase(string) { 31 | if (string) return string.toLowerCase(); 32 | } 33 | 34 | function capitalizeFirstLetter(string) { 35 | return string.charAt(0).toUpperCase() + string.slice(1); 36 | } 37 | 38 | export function getTitleField() { 39 | // If no title field configuration has been provided, we attempt 40 | // to use a "title" field, if one exists 41 | return getConfig().titleField || "title"; 42 | } 43 | 44 | export function getUrlField() { 45 | return getConfig().urlField; 46 | } 47 | 48 | export function getThumbnailField() { 49 | return getConfig().thumbnailField; 50 | } 51 | 52 | export function getFacetFields() { 53 | return getConfig().facets || []; 54 | } 55 | 56 | export function getSortFields() { 57 | return getConfig().sortFields || []; 58 | } 59 | 60 | export function getResultTitle(result) { 61 | const titleField = getTitleField(); 62 | 63 | return result.getSnippet(titleField); 64 | } 65 | 66 | // Because if a field is configured to display as a "title", we don't want 67 | // to display it again in the fields list 68 | export function stripUnnecessaryResultFields(resultFields) { 69 | return Object.keys(resultFields).reduce((acc, n) => { 70 | if ( 71 | [ 72 | "_meta", 73 | "id", 74 | toLowerCase(getTitleField()), 75 | toLowerCase(getUrlField()), 76 | toLowerCase(getThumbnailField()), 77 | ].includes(toLowerCase(n)) 78 | ) { 79 | return acc; 80 | } 81 | 82 | acc[n] = resultFields[n]; 83 | return acc; 84 | }, {}); 85 | } 86 | 87 | export function buildSearchOptionsFromConfig() { 88 | const config = getConfig(); 89 | const searchFields = (config.searchFields || config.fields || []).reduce( 90 | (acc, n) => { 91 | acc = acc || {}; 92 | acc[n] = {}; 93 | return acc; 94 | }, 95 | undefined 96 | ); 97 | 98 | const resultFields = (config.resultFields || config.fields || []).reduce( 99 | (acc, n) => { 100 | acc = acc || {}; 101 | acc[n] = { 102 | raw: {}, 103 | snippet: { 104 | size: 100, 105 | fallback: true 106 | } 107 | }; 108 | return acc; 109 | }, 110 | undefined 111 | ); 112 | 113 | // We can't use url, thumbnail, or title fields unless they're actually 114 | // in the reuslts. 115 | if (config.urlField) { 116 | resultFields[config.urlField] = { 117 | raw: {}, 118 | snippet: { 119 | size: 100, 120 | fallback: true 121 | } 122 | }; 123 | } 124 | 125 | if (config.thumbnailField) { 126 | resultFields[config.thumbnailField] = { 127 | raw: {}, 128 | snippet: { 129 | size: 100, 130 | fallback: true 131 | } 132 | }; 133 | } 134 | 135 | if (config.titleField) { 136 | resultFields[config.titleField] = { 137 | raw: {}, 138 | snippet: { 139 | size: 100, 140 | fallback: true 141 | } 142 | }; 143 | } 144 | 145 | const searchOptions = {}; 146 | searchOptions.result_fields = resultFields; 147 | searchOptions.search_fields = searchFields; 148 | return searchOptions; 149 | } 150 | 151 | export function buildFacetConfigFromConfig() { 152 | const config = getConfig(); 153 | 154 | const facets = (config.facets || []).reduce((acc, n) => { 155 | acc = acc || {}; 156 | acc[n] = { 157 | type: "value", 158 | size: 100 159 | }; 160 | return acc; 161 | }, undefined); 162 | 163 | return facets; 164 | } 165 | 166 | export function buildSortOptionsFromConfig() { 167 | const config = getConfig(); 168 | return [ 169 | { 170 | name: "Relevance", 171 | value: "", 172 | direction: "" 173 | }, 174 | ...(config.sortFields || []).reduce((acc, sortField) => { 175 | acc.push({ 176 | name: `${capitalizeFirstLetter(sortField)} ASC`, 177 | value: sortField, 178 | direction: "asc" 179 | }); 180 | acc.push({ 181 | name: `${capitalizeFirstLetter(sortField)} DESC`, 182 | value: sortField, 183 | direction: "desc" 184 | }); 185 | return acc; 186 | }, []) 187 | ]; 188 | } 189 | 190 | export function buildAutocompleteQueryConfig() { 191 | const querySuggestFields = getConfig().querySuggestFields; 192 | if ( 193 | !querySuggestFields || 194 | !Array.isArray(querySuggestFields) || 195 | querySuggestFields.length === 0 196 | ) { 197 | return {}; 198 | } 199 | 200 | return { 201 | suggestions: { 202 | types: { 203 | documents: { 204 | fields: getConfig().querySuggestFields 205 | } 206 | } 207 | } 208 | }; 209 | } 210 | -------------------------------------------------------------------------------- /src/config/engine.json.example: -------------------------------------------------------------------------------- 1 | { 2 | "endpointBase": "https://search-ui-sandbox.ent.us-central1.gcp.cloud.es.io", 3 | "engineName": "national-parks", 4 | "searchKey": "search-nyxkw1fuqex9qjhfvatbqfmw", 5 | "searchFields": ["title", "description", "states"], 6 | "resultFields": [ 7 | "id", 8 | "title", 9 | "description", 10 | "states", 11 | "visitors", 12 | "square_km", 13 | "world_heritage_site", 14 | "date_established", 15 | "image_url", 16 | "location", 17 | "acres", 18 | "nps_link" 19 | ], 20 | "querySuggestFields": ["title"], 21 | "titleField": "title", 22 | "urlField": "nps_link", 23 | "thumbnailField": "image_url", 24 | "sortFields": ["title", "states"], 25 | "facets": ["states", "world_heritage_site"] 26 | } 27 | -------------------------------------------------------------------------------- /src/index.js: -------------------------------------------------------------------------------- 1 | import React from "react"; 2 | import ReactDOM from "react-dom"; 3 | import App from "./App"; 4 | 5 | ReactDOM.render(, document.getElementById("root")); 6 | --------------------------------------------------------------------------------