Weave Code
Laravel Typesense Laravel Package
devloopsnet/laravel-typesense
Laravel integration for Typesense, the open-source typo-tolerant search engine. Index Eloquent models, run typed queries, and manage collections from your app with an expressive API built for fast, relevant full-text search.
Typesense engine for laravel/scout https://github.com/typesense/typesense .
Frequently asked questions about Laravel Typesense
- How do I install devloopsnet/laravel-typesense in a Laravel application?
- Install it with Composer using composer require devloopsnet/laravel-typesense. The service provider is auto-discovered, so no manual registration is needed in a standard Laravel app. Publish the package config file, then set SCOUT_DRIVER=typesense along with the TYPESENSE_HOST, TYPESENSE_PORT, TYPESENSE_PROTOCOL and TYPESENSE_API_KEY environment variables. No database migrations are required.
- Which Laravel, PHP and Laravel Scout versions does this package support?
- The package is a third-party engine that plugs into Laravel Scout's Engine contract, but the published metadata does not spell out supported ranges. Scout's Engine interface has changed across majors, particularly around pagination return types, mapIds, keys and soft-delete handling in Scout 9 and 10, so a pin to one Scout major can block framework upgrades. Read composer.json in the repository and run a spike against your exact Laravel, PHP and Scout versions before committing. Treat the Scout major as a hard compatibility gate.
- Is this package a fork of the official typesense/laravel-scout-typesense-engine?
- That is the key question to resolve before adoption, because the repository shows no stars, no dependents and no visible CI. If it is a thin fork of the vendor-blessed engine, you inherit divergence risk with no upstream merge path. Ask the maintainer what was changed and why the changes were not contributed upstream. If it is not a fork, verify the source directly against Scout's current Engine interface.
- How do I configure the Typesense connection for Laravel Scout?
- Publish the package config file and set SCOUT_DRIVER=typesense, then provide TYPESENSE_HOST, TYPESENSE_PORT, TYPESENSE_PROTOCOL and TYPESENSE_API_KEY in your .env file. Point these at a staging Typesense instance first rather than production. Typesense can be self-hosted with Docker, a single binary or a three-node cluster, or consumed through Typesense Cloud, so the same config works for either deployment model.
- How do I index existing Eloquent models into Typesense?
- Add Laravel Scout's Searchable trait to the model, then run php artisan scout:import with the model class to push existing records into Typesense. Typesense infers the collection schema from the first indexed document, so field-type drift is a common source of problems when your data is inconsistent. Validate schema inference on a single low-risk model before importing production data. Enable SCOUT_QUEUE=true before large imports so indexing runs through the queue.
- Does this engine support soft deletes, custom collection schemas, geo search, synonyms, curation and multi-search?
- These features are not documented in the package metadata, and an engine can silently drop Scout features it does not translate. Soft-delete handling in particular changed between Scout 9 and 10, so verify it explicitly if you rely on it. Read the engine source to confirm whether geo search, synonyms, overrides and multi-search are exposed or quietly ignored. Build a fixed set of golden queries that exercises each feature you need.
- Which Typesense server versions are compatible with this package?
- The repository does not state which Typesense server versions are validated. Typesense does introduce breaking API changes between server releases, and this engine is a thin HTTP wrapper around the Typesense PHP SDK, so the SDK and server versions both matter. Pin the server version in your infrastructure-as-code and test the index and query path against exactly that version. Do not assume compatibility from the package alone.
- Is this package production-ready, and is it actively maintained?
- Adoption signals are effectively zero: no stars, no dependents, no package score and no visible CI or issue backlog. There is also no evidence of release cadence, so it is unclear whether this is maintained or an abandoned experiment. Treat it as high technical risk and ask who maintains it and what has shipped in the last twelve months. A working test suite that runs against a live Typesense container is the minimum bar before production use.
- How do I keep the Typesense index in sync with my database using queues?
- Scout fires model indexing events through the Searchable trait, and this engine translates those calls into Typesense REST operations. Set SCOUT_QUEUE=true so create, update and delete operations are pushed onto the queue instead of running inline. Queue-based indexing is strongly recommended before importing production-scale data. Test deletion and soft-delete paths specifically, since those are the most common places a third-party engine diverges from Scout's expectations.
- How does this compare to the official Typesense engine or Algolia for Laravel Scout?
- The official typesense/laravel-scout-typesense-engine is vendor-blessed and carries far more external validation than this package. Algolia is a hosted alternative with a mature Scout driver, but Typesense offers self-hosting and an Algolia-compatible API surface that lowers translation risk. Because this package has no dependents, you cannot infer supported ranges from the ecosystem, so verify it yourself. A pragmatic rollout is to switch the Scout driver model by model and keep your previous driver as a config-level fallback.
Weaver
How can I help you explore Laravel packages today?