nswdpc / silverstripe-search-typesense

v0.4.2 2026-10-01 06:50 UTC

Requires

• codem/silverstripe-html5-inputs: ^1
• kevingroeger/codeeditorfield: ^1.3
• nswdpc/silverstripe-search-forms: ~0.2
• silverstripe/siteconfig: ^5
• silverstripe/versioned: ^2
• symbiote/silverstripe-multivaluefield: *
• symbiote/silverstripe-queuedjobs: ^5
• typesense/typesense-php: ^5

Requires (Dev)

• cambis/silverstan: ^2
• cambis/silverstripe-rector: ^2
• friendsofphp/php-cs-fixer: ^3
• nswdpc/ci-files: dev-v-4
• phpstan/phpstan: ^2
• phpunit/phpunit: ^9.5
• rector/rector: ^2

BSD-3-Clause

• James

• search
• silverstripe
• typesense

Published on Packagist.org on 2026-10-01 06:50 UTC

README

This module:

• allows programmatic creation of search forms to query a Typesense collection
• carrying out of Typesense searches on a selected collection
• provides a consistent data structure for indexing and rendering results
• supports adding Typesense instantsearch to your data models, with configuration within the administration area
• provides an extension to handle upsert and removal of documents that are marked for indexing
• import records to a Typesense server, via task or queued job
• remove records from Typesense server

This module does not provide any implementations for searching in your Typesense collections. Use the following modules to implement this:

• nswdpc/silverstripe-typesense-cms - provides a Typesense page to search and display results from collections
• nswdpc/silverstripe-typesense-elemental - provides Elemental content blocks to search collections

For NSW users wanting to integrate with the NSW Design System, the module nswdpc/waratah-typesense will assist.

Documentation

• Start at the index

Requirements

• a Typesense server or servers

Installation

composer require nswdpc/silverstripe-search-typesense

License

BSD-3-Clause

Configuration

Environment:

Management key

Avoid using the bootstrap API key as documented at

The key can be limited to collections, have an expiry, as defined here.

This key should have actions to:

• create collections (collections:create)
• check existence of a collection (collections:get, collections:list)
• import documents to collections (documents:import)
• upsert a document (documents:upsert)
• delete a document (documents:delete)
• read API keys, for validating search-only keys (keys:list)

Optionally:

• delete collections (collections:delete)

TYPESENSE_API_KEY="API key that can read and write"

Server endpoint

Add one or more endpoints for Typesense. Multiple endpoints are separated by a comma.

TYPESENSE_SERVER="https://host:port"

Search-only key

Set a search-only key, this will be used to create scoped search keys. It must only have the action documents:search.

The key can be limited to collections, have an expiry, as defined here.

TYPESENSE_SEARCH_KEY='Optional search-only key for creating scoped API keys for Instantsearch'

Maintainers

• PD web team

Bugtracker

We welcome bug reports, pull requests and feature requests on the Github Issue tracker for this project.

Please review the code of conduct prior to opening a new issue.

Security

If you have found a security issue with this module, please email digital[@]dpc.nsw.gov.au in the first instance, detailing your findings.

Development and contribution

If you would like to make contributions to the module please ensure you raise a pull request and discuss with the module maintainers.

Please review the code of conduct prior to completing a pull request.