@craftercms/search

@craftercms/search

This package contains tools for integrating your application with Crafter Search.

Usage

• Install module using yarn or npm
  • Yarn: yarn add @craftercms/search
  • npm: npm install @craftercms/search
• Import and use the service(s) you need

Services

---

Search

Returns the result for a given query.

search(query: Query)

Parameters
query	The query object
config	Crafter configuration. Optional. Default value in here.

Returns

Map model

Examples

• Connect to Crafter Search to query for content with ELASTIC SEARCH (crafter version: 3.1.x):

  import { crafterConf } from '@craftercms/classes';
  import { search, createQuery } from '@craftercms/search';

  //First, set the Crafter configuration to _cache_ your config. 
  //All subsequent calls to `getConfig` will use that configuration.
  crafterConf.configure({
    baseUrl: 'http://localhost:8080',
    site: 'editorial'
  });

  //Create elastic query
  const query = createQuery('elasticsearch');
  query.query = {
    "query" : {
        "match_all" : {}
    }
  }

  search(query).subscribe((results) => {
    // Do stuff with results...
  });

• Connect to Crafter Search to query for content with SOLR (crafter version: 3.0.x):

  import { crafterConf } from '@craftercms/classes';
  import { search, createQuery } from '@craftercms/search';

  //First, set the Crafter configuration to _cache_ your config. 
  //All subsequent calls to `getConfig` will use that configuration.
  crafterConf.configure({
    baseUrl: 'http://localhost:8080',
    site: 'editorial',
    searchId: 'editorial'   // if searchId is the same as site, this parameters is not needed
  })

  const query = createQuery('solr');
  query.query = "*:*";
  query.filterQueries = ['content-type:"/component/video"'];

  search(query).subscribe((results) => {
    // ...
  });

You may alternatively use a different config by supplying the config object at the service call invoking time

  import { search, createQuery } from '@craftercms/search';

  //Create query
  const query = createQuery('elasticsearch');
  query.query = {
    "query" : {
        "match_all" : {}
    }
  };

  search(query, { baseUrl: 'http://localhost:8080', site: 'editorial' }).subscribe((results) => {
    // ...
  });

Changelog

1.2.2

@craftercms/ice

• Adds reportNavigation util for SPAs to report the current URL as the app navigates.

misc

• [internal] Bumps acorn version