SplatDev.Search.OpenSearch 1.0.3

SplatDev.Search.OpenSearch

OpenSearch adapter for SplatDev.Search abstractions — AWS-hosted or self-hosted OpenSearch with full-text search, filtering, sorting, and bulk indexing via the official OpenSearch.Client SDK.

Compatibility

Installation

dotnet add package SplatDev.Search.OpenSearch

Configuration

DI registration

using SplatDev.Search;
using SplatDev.Search.OpenSearch.Services;

// Self-hosted (no auth)
builder.Services.AddSingleton<ISearchProvider>(_ =>
    new OpenSearchProvider(new Uri("http://localhost:9200")));

// Self-hosted with basic auth
builder.Services.AddSingleton<ISearchProvider>(_ =>
    new OpenSearchProvider(new Uri("https://search.example.com"), "admin", "password"));

// AWS OpenSearch Service uses IAM-based auth — configure via environment/AWS SDK

Usage

using SplatDev.Search;

public class DocumentIndex
{
    private readonly ISearchProvider _search;

    public DocumentIndex(ISearchProvider search) => _search = search;

    public async Task IndexAsync(Document doc)
    {
        await _search.IndexAsync("documents", doc);
    }

    public async Task<SearchResult<Document>> SearchAsync(string term)
    {
        return await _search.SearchAsync<Document>("documents", new SearchRequest
        {
            Query = term,
            Size = 50,
            Sort = [new SearchSortField { Field = "created", Direction = SortDirection.Descending }],
            Filters = new Dictionary<string, object> { { "status", "published" } },
        });
    }
}

Features

• Full ISearchProvider implementation backed by OpenSearch.Client v1.8
• Multi-match queries across configurable fields
• Term-level filtering with boolean AND combination
• Sorting by field with direction
• Source filtering (field projection)
• Bulk indexing via IndexManyAsync
• Index management (create, delete, exists)
• Basic authentication support for self-hosted instances

Dependencies

SplatDev.Search.OpenSearch — part of the SplatDev.Umbraco.Plugins suite. Licensed under MIT. © SplatDev Ltda.

Changelog

1.0.3 — 2026-08-25

Documentation only, no code change. The README's search example used SearchSort; the real type is SearchSortField. It also assigned a Dictionary<string, string> to SearchRequest.Filters, which is a Dictionary<string, object> — so the sample did not compile on either count. It is now compiled against the assembly.

1.0.2 — 2026-08-24

Removes a dashboard screenshot that showed an error toast. It was captured against a site where this plugin's API was unreachable, so it advertised a broken dashboard. No screenshot is better than a misleading one; a replacement will be taken against a working install.

1.0.1 — 2026-08-24

Package metadata only: the listing now carries an icon and search tags, and the project and repository links point at the organisation that actually hosts this code. No code changes.

1.0.0 — 2026-08-24

This package now keeps a changelog. Earlier releases predate it and are not reconstructed here — consult the repository history for those. From this version on, every release records what changed for someone using it.