Bsft.Data.Contracts
2.2.0.1
dotnet add package Bsft.Data.Contracts --version 2.2.0.1
NuGet\Install-Package Bsft.Data.Contracts -Version 2.2.0.1
<PackageReference Include="Bsft.Data.Contracts" Version="2.2.0.1" />
<PackageVersion Include="Bsft.Data.Contracts" Version="2.2.0.1" />
<PackageReference Include="Bsft.Data.Contracts" />
paket add Bsft.Data.Contracts --version 2.2.0.1
#r "nuget: Bsft.Data.Contracts, 2.2.0.1"
#:package Bsft.Data.Contracts@2.2.0.1
#addin nuget:?package=Bsft.Data.Contracts&version=2.2.0.1
#tool nuget:?package=Bsft.Data.Contracts&version=2.2.0.1
Bsft.Data.Contracts
The wire vocabulary of the Bsft.Data query surface — the paged request and result, the filter AST,
the sort criteria and the search request — with no dependencies at all, so a client can speak it
without acquiring the query engine.
Install
dotnet add package Bsft.Data.Contracts
Requires nothing. That is the point of the package: its dependency list is empty and a test pins it
empty, so referencing it from a Blazor WebAssembly front end or a console tool adds these types and
nothing else. A server that also needs to execute the queries references Bsft.Data, which brings
this package with it.
Register
Nothing to register. This package contains only contract types; it has no DI entry point and no
services. The engine that consumes these types is registered by
DataServiceCollectionExtensions.AddBsftDataQueryFiltering in Bsft.Data.
Configure
None. The package has no options type and reads no configuration.
| Option | Default | Effect |
|---|---|---|
| — | — | — |
Validation: none. The types carry no invariants of their own; a filter is validated when
FilterCompiler in Bsft.Data binds it against a query configuration, and the bounds on a
caller-supplied filter are enforced by BsftFilterTransportOptions in Bsft.Hosting.
Extend
FilterNode is a concrete base class with [JsonDerivedType] attributes naming AndNode, OrNode,
ComparisonNode and PresenceNode; the discriminators are the serialization contract, so a new node
type is a wire-format change and belongs in this package rather than in an application. PagedResult<T>
and RankedItem<T> are generic over the row type an application returns, and IEntityTaggedItem is
the one seam a DTO implements itself, so that a list response can carry a per-row entity tag for
conditional requests. Nothing here is replaceable at runtime.
Documentation
Topic page: docs/data.md. Conventions: docs/package-conventions.md.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
-
net10.0
- No dependencies.
-
net8.0
- No dependencies.
NuGet packages (5)
Showing the top 5 NuGet packages that depend on Bsft.Data.Contracts:
| Package | Downloads |
|---|---|
|
Bsft.Data
BSFT Framework data layer: query filtering, full-text search, pagination, multi-tenancy |
|
|
Bsft.Messaging.Abstractions
BSFT Framework messaging abstractions: integration events, the message bus contract, the transactional outbox store contract and the paged reader an operator console lists parked and pending messages through. |
|
|
Bsft.Hosting
BSFT Framework hosting defaults, health checks, and startup validation |
|
|
Bsft.EventAggregator.Saga
BSFT Framework saga/flow engine on top of IEventAggregator |
|
|
Bsft.Scheduling
BSFT Framework job scheduling: recurring (cron/interval) and delayed background jobs on a leased, durable dispatcher |
GitHub repositories
This package is not used by any popular GitHub repositories.