yahnoosh/azsearch.js

Sample UI components for Azure Search. Built to work with AzSearchStore

azsearch.js's Issues

Flag/Option for API vs direct search

We should include an ability to call an intermediary API that would hide the query key from the clients should desire such behavior. This would include refactoring to make QueryKey & Service optional, and introduce a flag to enable API mode as well as API endpoint.

Question being should we pass the search parameters via query string as we do when directly calling search or (perhaps optionally) POST as JSON object.

Add basic formating to numerics

Price, size and other numeric fields should be formatted with thousands separator in the UI.

Search app with no facets/side controls should allow results to be full screen

Shouldn't show that facet bar if no facets are defined.

Include pricing in filters & results

Pricing should be included in filters (as Range Selector) and in the results being displayed.

"clear filter(s)" button visible onLoad when no search has been performed

Repo:

• Compile latest
• Load realestate.local.html
• Notice 'clear filter(s)' is visible

Expected

• Button hidden when no searches have been performed

Map based results view

Since geo search is easy in Azure Search, we should make it easy to highlight this capability. Will probably look at using this google maps library as it seems to have the most polished react bindings.

document fetch/promise usage for searchCallback

Issues were reported using json promises that didn't have a .done callback. We should document and give examples of how to override searchCallback

better developer experience and debugging

Should update typescript sample project to have better development workflow. Should support "f5" workflow of some sort. Potentially look at having a visual studio project with this set up.

Is there a sample showing how to use it in a React application?

I'm trying to use the Components directly in my react application but haven't found how to do it, is there any sample on how to achieve that?

document some examples of specifying an onclick function for results

Common scenario is displaying a modal or some other sort of interaction when a result is clicked. We should think about how we want to support this.

Overridable parent element for search results

Currently in search results, each item is wrapped in a div. This makes it impossible to use a table as the parent result element and row/columns for the results. Would require optionally passing in the element type to use in Results.tsx: return() (see: https://github.com/EvanBoyle/AzSearch.js/blob/master/src/components/Results.tsx#L26)

Enhance result template

With pricing being added the results can now be taller than the thumbnail. Suggest we reformat the data so it's a consistent height.

CI or process required to keep CDN up to date

Currently the CDN hosted version of AzSearch is at 0.0.13, what is the process to update it with the latest builds?

https://cdn.jsdelivr.net/azsearch.js/0.0.13/AzSearch.bundle.js

Should document read only nature of store.getState

FAILED to parse index and create file

When running the generate i'm getting the error "FAILED to parse index and create file" but unable to diagnose where the issue could be

Improve development workflow

1. Developing new features sometimes requires modifying azsearchstore. It would be good to sort out how we do local development across the projects. There should probably be a development sample that consumes local builds of both azsearchstore and azsearch.js locally.
2. I should create some tests for azsearch.js
3. It would be good to setup continuous integration for checkins that run linting, build on a clean environment, and run a set of tests.

Enhancement: Add ability to clear facet/filter results from search query

Add ability to easily clear facet/filters.

Range filter visible without search

The range filter (sqft) is visible at page load even when no search has been performed.

Expected:

• No facet controls are rendered

Actual:

• Range Facet is rendered

Repo

• Load realestatedemo.html
• Range Facet Control is visible

better documentation about mustache templates

should update docs to indicate that mustache templates and not handlebars templates are expected. Handlebars has additional functionality that is unsupported.

Feature: sorting control

Would be great to have a drop down control that allows sorting by fields specified by the user. A few examples:

• orderby=lastRenovationDate desc
• $orderby=geo.distance(location, geography'POINT(-122.12315 47.88121)')

There is already the ability to set the orderby clause from azsearchstore search parameters, but it may also be worth adding a higher level api that builds sorting string, especially for geo sorting.

Upgrade npm and include package-lock.json

Show error messages when CORS or query key is not properly configured

Right now the user just gets an error in the console. Seems like forgetting cors is a common pitfall.

Show a spinner or other indicator when results/facets are loading

Can be done by through state.results.isfetching

Should add ability to only modify post payload

user may want to specify searchCallback that uses underlying fetch mechanics but only modifies the post payload.,

Running `npm run devbuild` results in tsx compilation errors

tslint -c tslint.json 'src/**/*.{ts,tsx}'

ERROR: src/components/SearchBox.tsx[84, 10]: Missing semicolon
ERROR: src/components/SearchBox.tsx[81, 15]: missing whitespace

n/a

n/a

Feature: Static filter control

Sometimes users want filtering without faceting. A good example would be the language facet for the channel9 demo

Rather than searching over multiple languages, the user wants to specify a single language to limit results to (and also always limit other facets to as well). This might make sense as a drop down similar to @m-gagne 's implementation of the orderby control. Depending on the behavior of this control, it might require changes in the search store to introduce a new facet type. We may need to modify the way clearAllFacets behaves as well. This control could probably take in a list of options, but we could probably try to list the options automatically based on the result of a facet query. Static options would probably be fine to start. This may just end up being a different way of rendering a checkbox facet with slightly different clearAll behavior.

Over-verbose variables like results.results

I've already tried some examples and I've found these very verbose:

• suggestions.suggestions
• results.results
  For example:

if(state.results.results && state.results.results.length) {

It looks like System.Configuration.Configuration from .NET and I think the JS users are not accustomed to such verbosity

How to intercept search text to alter search query?

I would like to use NLP using LUIS and allow user to type NLP text in search box. Before sending query to search, I'd like to send query to LUIS and then based on LUIS response, format the search query and/or add filter.

How do i do that using AzSearch.js?