Interface AdvancedSearchInitOptions

Configure how search analytics are stored. If you want to disable analytics, set this to false.

If set to true, updates to Products, ProductVariants and Collections will not immediately trigger an update to the search index. Instead, all these changes will be buffered and will only be run via a call to the runPendingSearchIndexUpdates mutation in the Admin API.

This is very useful for installations with a large number of ProductVariants and/or Collections, as the buffering allows better control over when these expensive jobs are run, and also performs optimizations to minimize the amount of work that needs to be performed by the worker.

Default

false
Copy

An optional prefix string for the Typesense collections that will be created. This can be useful if you are running multiple Vendure instances which share the same Typesense instance, as it allows you to differentiate between the collections created by each instance.

Default

''
Copy

Custom mappings allow you to define additional fields which will be indexed in the products index.

Example

AdvancedSearchPlugin.init({
  // ...
  customMappings: {
    reviewRating: {
      graphQlType: 'Float',
      valueFn: ({ variant }) => variant.product.customFields.reviewRating,
    },
    reviewCount: {
      graphQlType: 'Int!',
      valueFn: ({ variant }) => variant.product.customFields.reviewCount,
    },
    facetValues: {
      graphQlType: 'String!',
      searchable: true,
      hydrateRelations: ['product.facetValues'],
      valueFn: ({ variant, languageCode }) =>
        variant.product.facetValues
          .map((fv) => translateDeep(fv, languageCode).name)
          .join(' '),
    },
    featuredAssetName: {
      graphQlType: 'String!',
      hydrateRelations: ['product.featuredAsset'],
      valueFn: ({ variant }) => variant.product.featuredAsset?.name ?? '',
      searchable: true,
    },
    discountPercentage: {
      graphQlType: 'Float',
      valueFn: ({ variant }) => variant.customFields?.discountPercentage,
      outputFn: (values: number[], groupByProduct: boolean) => {
         if (groupByProduct) {
            return Math.max(...values);
         } else {
            return values[0];
         }
      },
    },
  },
}),
Copy

It is possible to override the indexed value of the built-in fields on the SearchResult type. For example, let's say you have a customField which stores a "sale price" which you want to use in your search results. Here's how you can configure it:

Example

AdvancedSearchPlugin.init({
  // ...
  documentOverrides: {
    priceWithTax: ({ variant }) => variant.customFields.salePrice,
  },
}),
Copy

Allows you to define additional external indexes which can be queried alongside the main product index.

When searching the product index, data on related Collections and Facets is cached for performance reasons. This setting allows you to set the TTL (how long a cached item lives before it must be refreshed from the database) for this cache.

A higher value will reduce the number of database queries made during search, but may result in stale data being returned.

Default

30000
Copy

The license key can be found in your Vendure Hub account at https://vendure.io/account/licenses, and then clicking on the installation instructions for this plugin's license

A secret string used to encrypt the Shop API key in the database. When this is set, a new customField will be defined on the GlobalSettings entity, which is used to store the encrypted shop API key.

Allows you to define additional ways to sort the search results.

Example

AdvancedSearchPlugin.init({
  // ...
  sortableFields: [
    // Here we are specifying that the 'sku' field
    // should also be sortable
    { name: 'sku' },
    // Assuming we have defined a customMapping for reviewRating
    // (as in the example above), we can also make this sortable.
    {
      // This name must match the field name internally in TypeSense,
      // which, for customMappings is always of the format
      // `customMapping_<name>`.
      name: 'customMapping_reviewRating',
      // We can alias this with a more friendly name that will be used
      // in the GraphQL API "sort" input.
      alias: 'rating'
    }
  ],
});
Copy

The configuration options for the Typesense client.

Example

 typeSenseClientOptions: {
   apiKey: process.env.TYPESENSE_API_KEY,
   nodes: [
     {
       host: process.env.TYPESENSE_HOST,
       port: 8108,
       protocol: 'http',
     },
   ],
 },
Copy