solr-query-io-ts

solr-query-io-ts - Build Solr search queries, including spatial predicates

Quick Start

After yarn add solr-query-io-ts:

import {
  Q,
  QueryElement,
  SolrQueryFromElement,
  simple,
} from 'solr-query-io-ts';
import { inspect } from 'util';
import { Right } from 'fp-ts/lib/Either';

// Build up a query using the 'Q' module.
function makeQuery() {
  // (geo:"Intersects(POINT(-122.17381 37.426002))" OR "spicy" OR title:He??o OR product:([100 TO *] AND (NOT 600)))
  const tree = Q.or(
    Q.term(
      'geo',
      Q.spatial.intersects({
        type: 'Point',
        coordinates: [-122.17381, 37.426002],
      })
    ),
    Q.defaultTerm(Q.L('spicy')),
    Q.term('title', Q.glob('He??o')),
    Q.term('product', Q.and(Q.closedRange(100, undefined), Q.not(Q.L(600))))
  );
  // convert to a string.
  return SolrQueryFromElement.decode(tree);
}

console.log(makeQuery());

// Build up a query using the 'simple' module.
// This module is useful for parsing user-provided API input (ex. URL query params).
function makeSimple() {
  // (((NOT "zzz-VERYBAD")) AND ({"zzz-FILES" TO *}) AND (README* OR CHANGE*))
  const tree = {
    gt: 'zzz-FILES',
    neq: ['zzz-VERYBAD'],
    glob: ['README*', 'CHANGE*'],
  };
  // convert to a query element.  This result can be passed
  // to SolrQueryFromElement to get a string query.
  return SolrQueryFromElement.decode(
    (simple.LStringTermValueFromSimpleStrings.decode(tree) as Right<
      QueryElement
    >).right
  );
}

console.log(inspect(makeSimple(), false, 100, true));

License

Read the LICENSE for details.
The entire NOTICE file serves as the NOTICE that must be included under Section 4d of the License.

# solr-query-io-ts

This product contains software originally developed by Holvonix LLC.
Original Repository: https://github.com/holvonix-open/solr-query-io-ts

Copyright (c) 2019 Holvonix LLC. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this software except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Dependencies may have their own licenses.