Typesense

Typesense is a blazing-fast, open-source search engine built in C++. It’s easy to use, privacy-friendly, and offers a free self-hosted option for building smart, instant search experiences.

Getting Started

Install dependencies

First install the typesense package.

npm install typesense

Configure environment variables

Update your environment variables schema and add them to your .env file.

import { Env } from '@adonisjs/core/env'
 
export default await Env.create(new URL('../', import.meta.url), {
  TYPESENSE_NODE_URL: Env.schema.string({ format: 'host' }),
  TYPESENSE_API_KEY: Env.schema.string(),
})

Configure the Search Engine

Add the TypesenseEngine to your Magnify configuration.

config/magnify.ts

import env from '#start/env'
import { defineConfig, engines } from '@foadonis/magnify'
import type { InferEngines } from '@foadonis/magnify/types'
 
const magnifyConfig = defineConfig({
  default: 'typesense',
  engines: {
    typesense: engines.typesense({
      apiKey: env.get('TYPESENSE_API_KEY', undefined),
      nodes: [{ url: env.get('TYPESENSE_NODE_URL') }],
    }),
  },
})
 
export default magnifyConfig
 
/**
 * Inferring types for the list of engines you have configured
 * in your application.
 */
declare module '@foadonis/magnify/types' {
  export interface EnginesList extends InferEngines<typeof magnifyConfig> {}
}

Configure indices

Typesense does not automatically create collections for you. You need to create and configure them manually.

config/magnify.ts

import env from '#start/env'
import { defineConfig, engines } from '@foadonis/magnify'
import type { InferEngines } from '@foadonis/magnify/types'
 
const magnifyConfig = defineConfig({
  default: 'typesense',
  engines: {
    typesense: engines.typesense({
      apiKey: env.get('TYPESENSE_API_KEY', undefined),
      nodes: [{ url: env.get('TYPESENSE_NODE_URL') }],
      collectionSettings: {
        posts: {
          queryBy: ['title'],
          fields: [
            {
              name: 'title',
              type: 'string',
            },
            {
              name: 'updatedAt',
              type: 'int32',
            },
            {
              name: 'createdAt',
              type: 'int32',
            },
          ],
        },
      },
    }),
  },
})
 
export default magnifyConfig

You can then synchronize your indices with the following command:

node ace magnify:sync

Getting Started

Install dependencies

Configure environment variables

Configure the Search Engine

Configure indices

Start Searching

On this page