Class AdvancedSearchPlugin

constructor

• new AdvancedSearchPlugin(typesenseService, typesenseHealthIndicator, searchIndexService, eventBus, registry, moduleRef, externalIndexService, options, i18nService, licenseService): AdvancedSearchPlugin
• Internal

  Parameters

  • typesenseService: TypesenseService
  • typesenseHealthIndicator: TypesenseHealthIndicator
  • searchIndexService: SearchIndexService
  • eventBus: EventBus
  • registry: HealthCheckRegistryService
  • moduleRef: ModuleRef
  • externalIndexService: ExternalIndexService
  • options: AdvancedSearchInitOptions
  • i18nService: I18nService
  • licenseService: LicenseService

  Returns AdvancedSearchPlugin

Static Internaloptions

StaticuiExtensions

import { compileUiExtensions } from '@vendure/ui-devkit/compiler';
import { AdvancedSearchPlugin } from '@vendure-hub/vendure-advanced-search-plugin';

// ...
plugins: [
  AdminUiPlugin.init({
    route: 'admin',
    port: 3002,
    app: compileUiExtensions({
      outputPath: path.join(__dirname, '../admin-ui'),
      extensions: [AdvancedSearchPlugin.uiExtensions],
      devMode: false,
    })
  }),
],
Copy

StaticuiExtensionsNoAnalytics

import { compileUiExtensions } from '@vendure/ui-devkit/compiler';
import { AdvancedSearchPlugin } from '@vendure-hub/vendure-advanced-search-plugin';

// ...
plugins: [
  AdminUiPlugin.init({
    route: 'admin',
    port: 3002,
    app: compileUiExtensions({
      outputPath: path.join(__dirname, '../admin-ui'),
      extensions: [AdvancedSearchPlugin.uiExtensionsNoAnalytics],
      devMode: false,
    })
  }),
],
Copy

onApplicationBootstrap

• onApplicationBootstrap(): Promise<void>
• Internal

  Returns Promise<void>

onModuleDestroy

• onModuleDestroy(): Promise<void>
• Internal

  Returns Promise<void>

onModuleInit

• onModuleInit(): Promise<void>
• Internal

  Returns Promise<void>

Staticinit

• init(options): typeof AdvancedSearchPlugin

• The static init() method is called with the options to configure the plugin.

  Parameters

  • options: AdvancedSearchInitOptions

  Returns typeof AdvancedSearchPlugin

  Example

  AdvancedSearchPlugin.init({
      shopApiKeySecret: process.env.SHOP_API_KEY_SECRET as string,
      typeSenseClientOptions: {
          apiKey: process.env.TYPESENSE_API_KEY as string,
          nodes: [
              {
                  host: process.env.TYPESENSE_HOST as string,
                  port: 8108,
                  protocol: 'http',
              },
          ],
      },
      analytics: {
          analyticsStrategy: new ClickhouseAnalyticsStrategy({
              url: process.env.CLICKHOUSE_URL as string,
              port: 8123,
              database: 'vendure_search_analytics',
              debug: false,
          }),
      },
      customMappings: {
          // same as ElasticSearchPlugin
      },
  }),
  Copy