Typesense

Heads up: namespace move in 5.9.0

In 5.9.0 the internal PHP namespace moves from percipiolondon\typesense to craftpulse\typesense. The Composer package name (craftpulse/craft-typesense) and the plugin handle (typesense) do not change, so project config, permissions, and settings are unaffected. The move is bridged in both directions: on this 5.8.x line a forward-compatibility alias lets you reference the future craftpulse\typesense\* class names today, and on 5.9.0 a backwards-compatibility alias keeps the percipiolondon\typesense\* names working (with a deprecation notice). Update your imports to craftpulse\typesense\* before upgrading.

Added

• Forward-compatibility alias for the upcoming craftpulse\typesense namespace: reference the future class names (for example in config/typesense.php) today and they resolve to the current percipiolondon\typesense\* classes.
• Added an update-schema console command (craft typesense/default/update-schema) that drops and recreates every configured collection's fields from config/typesense.php, useful while iterating on a schema in development. It is destructive (existing field data is removed and must be re-synced), so it prints that in ./craft help and prompts for confirmation unless --force is passed. Thanks to @jamie-s-white (#61).

Changed

• Reworked the document sync queue flow onto Craft's batched job contract (BaseBatchedJob), so large indexes progress across spawned jobs while stale-document cleanup stays correct across the whole run (flush/create side effects run once, processed IDs survive queue serialization, the batchable query is cloned and stably ordered). Thanks to @timkelty (#70). Expected to resolve #69.

Fixed

• Guard against a null entry when applying a draft: the after-restore / after-move handler could pass a query miss straight to handleSave() (a non-nullable signature) and throw a TypeError. Reported by @mikeymeister (#67).
• Delete documents from collections defined with the .all section syntax: the delete handler resolved only the specific section.type collection, so documents in an .all collection were never removed. It now falls back to section.all, matching the save path. Thanks to @jamie-s-white (#64).
• Fixed a bug where deleting a Cockpit element left its document in the index: the delete handler looked the element up with a craft\elements\Entry query, which never matches craftpulse\cockpit\elements\Job, craftpulse\cockpit\elements\Department, craftpulse\cockpit\elements\Contact or craftpulse\cockpit\elements\MatchFieldEntry, so those documents were only ever removed by a later full sync.
• Fixed a bug where deleting a disabled element left its document in the index, because the delete handler's element lookup applied the default enabled-only status filter.
• Fixed a bug where deleting a Cockpit element did not resolve the site-aware collection, so a FiftyFivePlus job or department would have been removed from the Go4Jobs collection rather than its own. The save and delete handlers now share one collection resolver.
• Do not attach the element sync events until an API key is configured, so saving elements on a fresh, not-yet-configured install no longer errors. Thanks to @jamie-s-white (#63).
• Confirmed the control-panel Sync/Flush actions build their URLs with cpUrl(), so they respect CRAFT_BASE_CP_URL and post to the control-panel domain rather than the front-end site URL (the CORS failure reported when the control panel runs on a separate domain). Reported by @vardumper (#68).

Fixed

• Fixed site-aware collection resolution in DocumentsController for multi-instance Cockpit elements. Previously, handleSave always resolved to the first matching collection (Go4Jobs), causing FiftyFivePlus jobs and departments to never sync to their correct Typesense index on element save.

Fixed

• Fixed an where the custom elements wouldn't sync - this is cockpit specific, temporary solution until full rework is labelled "done".

Fixed

• Fixed an issue where the custom elements couldn't resolve, only Entry's could be resolved

Added

• Added element support for craftpulse/cockpit/elements/Contact
• Added element support for craftpulse/cockpit/elements/Department
• Added element support for craftpulse/cockpit/elements/Job
• Added element support for craftpulse/cockpit/elements/MatchFieldEntry
• Added element support for craftpulse/reviews/elements/Review;

Fixed

• Fixed a regression issue from safeguarding when no client is known

Added

• Added the structure after move event inside the after save method

Fixed

• Fixed the unwanted entries in an index in after save, because criteria were skipped. Thanks to scholejo

Fixed

• Fixed an issue that could occur when upgrading the project but not having client settings.

Added

• Added support for categories thanks to dezeweetjeniet PR #54

Fixed

• Don't sync/flush if the domain is not the same in site #55
• Session does not exist in a console request thanks to samuelbirch #51

Added

• Fixed an issue where choosing "single" would end up in validation errors #47

Fixed

• Fixed an issue where the settings wouldn't display if "Single" was selected as an option #46

Added

• Added support for synonyms
• Added support for Craft Commerce (Products and Variants) thanks to samuelbirch and dezeweetjeniet PR #36
• Added support for Shopify products thanks to sidoneill issue #43

Added

• Added event hooks to capture changes on the Typesense document (EVENT_AFTER_DELETE/EVENT_AFTER_UPSERT/EVENT_BEFORE_DELETE/EVENT_BEFORE_UPSERT)

Fixed

• Composer version of craft vite

Added

• Added the possibility to allow indexing multiple sections in a single collection #35
• Added code analysis and auto release scripts

Fixed

• Removed composer.lock so latest versions of dependencies can be installed as defined in composer.json

Fixed

• Added section.all fallback for the deletion of documents

Fixed

• Check for the deletion on the documents

Changed

• Craft 5 release

Changed

• Prepped for Craft 5

Added

• Check for null resolvers

Added

• Before Sync / Flush event hooks

Added

• Support for Assets

Changed

• Changed the handling of the document deletion for mutli sites

Added

• Docs for the official release
• Seperate typesense logging

Changed

• Move the deletion of the collection into the sync if it's a flush #7

Added

• Added the possibility to handle save for all the types inside of the section

Fix

• Fixed: the project rebuild command was failing because of project config settings, these were disabled since we don't use them yet

Added

• Added: A sync console command

Changed

• Changed: disabled the before routing fetch to check for scheduled posts

Added

• Added: Delete the document when setting an enabled entry to disable #6
• Added: Create the document when a scheduled post becomes active #9

Added

• Added support for Craft 4