CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

4.5.0 - 2026-05-01

Added

• API: added ApiEntityAbstract as a convenience base combining searchable/query filter and response model behaviors for entity DTOs.

Changed

• API markers: standardized marker usage around ApiField(...) flags across core services, ODM persisted entities, and API utility tests while preserving response/update/search semantics.

4.4.4 - 2026-05-01

Changed

• API/query utilities: consolidated pagination, query abstractions/resolvers/types, and API response/searchable model helpers under core.utils.api; updated ODM plugin imports and coverage to match the new module layout.

4.4.3 - 2026-04-18

Fixed

• API: get_updateable_fields now descends into nested ApiResponseModelAbstract fields that are marked only with ApiResponseField, so dotted updateable paths match reconcile_update_request for PUT payloads under API-only containers.

Added

• Tests: coverage for updateable path collection and reconciliation (optional nested containers, deep API-only chains, combined ApiResponseField / UpdateableField markers, added / removed change kinds).

4.4.2 - 2026-04-17

Changed

• CI: merged SBOM generation and Grype vulnerability scan into a single dependency-scan job and updated release dependencies accordingly, simplifying the pipeline while preserving artifacts used by release.

4.4.1 - 2026-04-17

Fixed

• CI: workflow now uses runner-embedded Poetry/uv binaries from /home/runner/.local/bin instead of reinstalling toolchain dependencies in jobs, reducing setup overhead while keeping release publishing intact.

4.4.0 - 2026-04-17

Added

• API response models: add UpdateableField, PUT request model generation, and update reconciliation helpers that merge payloads by policy, track changed/ignored paths, and support strict rejection of non-updateable fields.

4.3.2 - 2026-04-16

Fixed

• Aiopika: AbstractListener passes the bound queue’s exclusivity (and an optional exclusive constructor override, including explicit False) to consume instead of always using an exclusive consumer; Queue exposes an exclusive read-only property.

4.3.1 - 2026-04-14

Fixed

• CI release job: extract GitHub release notes when the CHANGELOG.md version line uses Keep a Changelog’s dated form (## [x.y.z] - YYYY-MM-DD), not only a bare ## [x.y.z] line.

4.3.0 - 2026-04-14

Added

• Application builder: build_as_uvicorn_utils, build_as_hypercorn_utils, and build_and_serve forward **kwargs to build() for callers that need late FastAPI wiring.

Changed

• Queries: narrow mypy noise on dynamic create_model when building nested SearchableEntity query filter models.

4.2.1 - 2026-04-14

Fixed

• Release: GitHub release notes extraction now matches the CHANGELOG.md version header exactly and fails the workflow when notes for the tag are missing/empty, preventing silent blank release descriptions.

4.2.0 - 2026-04-14

Added

• Server: optional Hypercorn ASGI support alongside Uvicorn (core.utils.hypercorn, app builder wiring, config), with integration coverage for ASGI servers.

4.1.1 - 2026-04-14

Added

• Audit: AuditEventObject.pre_publish_hook(entity) now provides a default hook for redacting or transforming audited entities before publish.

Fixed

• Audit: AbstractAuditPublisherService.publish now delegates to AbstractPublisher.publish and wraps broker failures as AuditServiceError without recursive self-calls.
• Audit: default routing-key prefix now uses a valid topic segment (all) so the publisher service can be imported and instantiated safely.

4.1.0 - 2026-04-12

Changed

• Audit: AuditableEntity uses a permissive Pydantic model_config (extra="allow", arbitrary_types_allowed=True) so auditable actors can carry extended or non-JSON-native fields when needed.

4.0.1 - 2026-04-12

Changed

• Audit: AuditableEntity is a standalone model again; PersistedAuditableEntity subclasses it with revision_id and optional auto-generated id aligned to PersistedEntity without multiple BaseModel inheritance.

4.0.0 - 2026-04-12

Added

• Audit: UseCaseName, optional AuditEventObject.use_case (default unknown) and metadata, and PersistedAuditableEntity for ODM-backed documents.

Changed

• Breaking: AuditableEntity now subclasses PersistedEntity with a required id, adds published / published_at, and drops embedded entity_name, domain_name, service_name fields and their getters (domain/service remain on AuditEventObject).

3.4.0 - 2026-04-11

Added

• Queries: QueryResolver coerces query strings to enum.Flag / enum.IntFlag, enum.Enum (including StrEnum and IntEnum), and other leaf types via a TypeAdapter fallback (for example datetime).

3.3.0 - 2026-04-11

Added

• Queries: QueryFieldOperation accepts T | list[T] for value and validates that lists are only used with in / nin operators; ODM builder tests cover UUID id filters.

Fixed

• Queries: QueryResolver coerces typing.NewType over any supported scalar supertype (for example NewType(..., str)), not only uuid.UUID.

3.2.1 - 2026-04-11

Fixed

• ODM: ODMQueryBuilder maps filter field id to MongoDB _id so match documents align with Beanie primary key storage.

3.2.0 - 2026-04-11

Added

• ODM: PersistedEntity mixes in SearchableEntity and ApiResponseModelAbstract; id, created_at, and updated_at use ApiResponseField and SearchableField so shared query and response model builders apply consistently.

3.1.1 - 2026-04-11

Fixed

• Queries: QueryResolver preserves typing.NewType annotations when deriving field types so values such as NewType(..., uuid.UUID) coerce from query strings to uuid.UUID (not plain str).

3.1.0 - 2026-04-11

Added

• Services: Audit (AuditableEntity, AuditEventObject), Hydra (HydraTokenIntrospectObject), and Kratos session/identity DTOs mix in SearchableEntity and ApiResponseModelAbstract, with fields marked via Annotated[..., ApiResponseField, SearchableField] for the shared query and response model builders.
• Tests: OpenTelemetry integration teardown flushes and shuts down the meter provider using the configured closing timeout.

3.0.0 - 2026-04-11

Added

• API: ApiResponseField marker; ApiResponseModelAbstract.build_response_model derives exposed fields from Annotated[..., ApiResponseField] instead of FIELDS_ALLOWED_FOR_RESPONSE.
• Queries: SearchableField marker, QueryFilterNestedAbstract, and SearchableEntity.build_nested_query_filter_model for nested filter segments; SearchableEntity.build_query_filter_model derives searchable fields from Annotated[..., SearchableField] instead of SEARCHABLE_FIELDS or dotted path lists.
• Queries: QueryResolver coerces uuid.UUID (including NewType wrappers over UUID) from query strings.

Changed

• Breaking: ApiResponseModelAbstract drops FIELDS_ALLOWED_FOR_RESPONSE and dotted nested path configuration; nest ApiResponseModelAbstract subclasses to shape nested responses.
• Breaking: SearchableEntity drops SEARCHABLE_FIELDS and dotted nested paths; nest SearchableEntity subclasses so nested filters map to inner models (with dotted query keys via existing resolver rules).

2.1.1 - 2026-04-10

Changed

• Queries: SearchableEntity.build_query_filter_model subclasses QueryAbstract, so generated filter models include pagination and sort fields; the previous standalone QueryFilterAbstract model was removed and QueryFilterAbstract is now an alias to QueryAbstract in core.utils.queries.

2.1.0 - 2026-04-10

Added

• Dynamic API response model builder (ApiResponseModelAbstract, ApiResponseSchemaBase) for nested Pydantic projections using dotted field paths.
• Shared pydantic_path_fields helpers to resolve dotted paths and detect prefix conflicts.
• QueryFilterAbstract and SearchableEntity to build optional QueryField-typed filter models from searchable field lists, with unit tests for API and query utilities.

2.0.1 - 2026-04-07

Fixed

• Aiopika: listener decodes message bodies as UTF-8 JSON; malformed JSON, decode errors, and validation failures are logged and the delivery is rejected with requeue

Added

• Tests: unit tests for AbstractListener setup, consume registration, close, and _on_message success and error paths

2.0.0 - 2026-04-06

Added

• Audit: required entity, domain, and service on AuditEventObject; export DomainName, EntityFunctionalEventName, EntityName, and ServiceName from the audit package

Changed

• Audit (breaking): publisher and listener services use AuditEventObject[AuditableEntity]; routing-key pattern is documented as {prefix}.{domain}.{service}.{what}.{why}

Fixed

• Aiopika: AMQP connect_robust failures are raised as AiopikaPluginBaseError

1.0.0 - 2026-04-06

Added

• Aiopika: validated PartStr, AbstractName, RoutingKey, QueueName, and ExchangeName; fluent builders for routing keys, queue names, and exchange names; topic wildcard * support for listener-style patterns; unit tests for types, builders, GenericMessage, and AbstractPublisher.publish
• Audit: AuditServiceError includes audit_event and routing_key context when audit publish fails

Changed

• Aiopika: GenericMessage initializes an optional incoming delivery reference; publisher treats failed serialization, broker errors, missing confirmation, and Basic.Return as AiopikaPluginBaseError

Fixed

• Aiopika: GenericMessage.ack / reject behave when no incoming message is bound

Removed

• Audit (breaking): AuditableEntity no longer uses private attributes for metadata; callers must pass entity_name, domain_name, and service_name (excluded from default serialization)

0.24.0 - 2026-04-05

Added

• Core: QueryResolver.from_model registers query-string keys for nested filter models (non-QueryAbstract BaseModel fields produce dotted paths such as object1.field1) and for Field validation_alias / AliasChoices; optional-union nested models are supported when exactly one branch is such a model; self-referential nested graphs are skipped safely after the first visit
• Core: QueryAbstract.get_fields flattens nested filter models into entries keyed by each nested QueryField name (so ODM filters keep dotted Mongo paths)
• ODM: ODMQueryBuilder and ODMFindQuery in odm_plugin.queries to translate QueryAbstract into MongoDB match filters and Beanie find kwargs (skip, limit, sort), including multi-operation merge per field
• Tests: unit tests for the ODM query builder; integration tests with Beanie/MongoDB and a FastAPI-style resolver chain

0.23.0 - 2026-04-04

Added

• Core: core.utils.queries package — QueryField, QuerySort, QueryFieldOperatorEnum, QueryResolver, and QueryAbstract for filter/sort query parsing and coercion from FastAPI requests
• Core: unit tests for query types, field names, resolver behavior, QueryAbstract, and docstring-aligned examples

Changed

• Core: pagination helpers — resolve_offset moved to paginations.helpers; paginations re-exports PaginationPageOffset, PaginationSize, and resolve_offset only

0.22.1 - 2026-03-17

Fixed

• JWT: raise dedicated ExpiredJWTError when bearer token is expired for clearer error handling and differentiation from generic invalid token errors

0.22.0 - 2026-03-14

Added

• Core: CSRF exception handler with structured logging returning 403 on invalid token
• Core: register_csrf_protect_exception_handler(app) to register CSRF exception handler on FastAPI app
• Core: validation exception handler and register_exception_handlers(app) for FastAPI

Changed

• Core: CSRF registration function renamed to register_csrf_protect_exception_handler (from register_exception_handler)

0.21.1 - 2026-03-14

Removed

• Dev: explicit black dependency from pyproject.toml (formatting remains via pre-commit)

0.21.0 - 2026-03-13

Added

• Core: CSRF configuration model and dependency helpers to integrate fastapi-csrf-protect via RootConfig.csrf and application state

0.20.0 - 2026-03-02

Added

• JWT: configurable bearer token extraction strategies for bearer token resolution

0.19.2 - 2026-02-28

Changed

• JWT: audience moved from BaseApplicationConfig to JWTBearerAuthenticationConfig; Hydra OAuth2 client credentials service now accepts config and default_audience instead of application config

0.19.1 - 2026-02-26

Changed

• Aiohttp plugin: extracted AioHttpResourceDepends.export_from_state helper to reuse FastAPI application state export logic

0.19.0 - 2026-02-25

Added

• JWT/Hydra: in-memory JWKS store configuration helper from Hydra introspect services and FastAPI dependency for Hydra JWKS store (configure_jwks_in_memory_store_from_hydra_introspect_services, DependsHydraJWKStoreMemory)

Changed

• JWT: documentation and authentication abstractions updated to use JWTAuthenticationServiceAbstract, GenericJWTBearerTokenDecoder, issuer type OAuth2Issuer, and issuer-aware JWK stores

Removed

• Repo: removed legacy .cursor configuration directory and .gitmodules metadata from version control

0.18.0 - 2026-02-23

Added

• JWT: JWTBearerAuthenticationConfigBuilder to build config from application YAML
• JWT: DependsJWTBearerAuthenticationConfig for FastAPI state injection
• JWT: JWTBearerAuthenticationConfigBuilderError and CONFIG_FILENAME on ApplicationAbstract
• Unit tests for JWT config builder and dependency in test_configs.py

0.17.1 - 2026-02-23

Changed

• JWT: single issuer in config, generic decoder/verifier, and issuer-by-kid in JWK stores

0.17.0 - 2026-02-16

Added

• ODM plugin: PersistedEntity is now generic over entity ID type (PersistedEntity[BookEntityId]) for typed IDs with improved docstring and usage example

0.16.1 - 2026-02-14

Fixed

• KratosSessionObject validation update

0.16.0 - 2026-01-25

Added

• Pagination utilities module (core/utils/paginations/)
  • PaginationSize type with validation (1-200 range, default 50)
  • PaginationPageOffset type with validation (min 0, default 0)
  • depends_pagination_page_offset() for FastAPI dependency injection
  • depends_pagination_page_size() for FastAPI dependency injection
  • resolve_offset() utility function to calculate database offset from page offset and page size
  • Comprehensive unit test suite (191 lines, 5 test classes)
• Query filter helper module (core/utils/query_helper.py)
  • QueryFilterHelper class for validating and transforming query parameters in FastAPI endpoints
  • QueryFilterValidationError exception for invalid filter values
  • QueryFilterUnauthorizedError exception for unauthorized filter keys
  • Support for type transformation and validation of query parameters
  • Configurable error handling (raise on unauthorized/invalid filters)
  • Comprehensive unit test suite (530 lines)

0.15.1 - 2026-01-25

Security

• Added exception for protobuf waiting fix in Grype configuration

0.15.0 - 2026-01-24

Added

• Exception mapping utilities module (core/utils/exceptions.py)
• ExceptionMapping dataclass for defining source-to-target exception mappings
• exception_mapper decorator for mapping exceptions in sync and async functions
• ExceptionMapper class for wrapping method calls with exception mapping
• ExceptionMappingContext context manager supporting both sync and async contexts
• Support for context hooks (sync and async) to inject context into target exceptions
• Exception chaining preserved via raise ... from syntax
• Comprehensive test suite for exception mapping utilities (72 tests)