@nhtio/lucid-resourceful
Modules
| Module | Description |
|---|---|
| @nhtio/lucid-resourceful | A decorator-driven AdonisJS library that lets you annotate Lucid ORM models with metadata to automatically generate CRUD controllers, validation rules, OpenAPI schemas, and a unified query interface. |
| @nhtio/lucid-resourceful/definitions | Column Data Type Definition Helpers for Resourceful Lucid Models |
| @nhtio/lucid-resourceful/encoding | Portable cross-environment encoding and decoding of structured data. |
| @nhtio/lucid-resourceful/errors | Errors thrown by the Lucid Resourceful Library |
| @nhtio/lucid-resourceful/integration/middlewares/odata_error | An Adonis middleware which intercepts errors thrown during the request lifecycle and formats the responses in a consistent manner meant to be easily consumed by clients. |
| @nhtio/lucid-resourceful/integration/middlewares/resourceful_encoded_request | An Adonis middleware which accepts and decodes requests encoded using the Resourceful encoding utility. |
| @nhtio/lucid-resourceful/integration/middlewares/resourceful_error | An Adonis middleware which intercepts errors thrown during the request lifecycle and formats the responses in a consistent manner meant to be easily consumed by clients. |
| @nhtio/lucid-resourceful/integration/provider | The Adonis Provider for the Lucid Resourceful Library which adds the router.resourceful functionality |
| @nhtio/lucid-resourceful/joi | A modified version of the joi validation library which adds support for new custom schemas |
| @nhtio/lucid-resourceful/odata/context | Utility which allows resolution of resourceful odata context. |
| @nhtio/lucid-resourceful/odata/macro | Utility which provides a stable XML response for OData requests. |
| @nhtio/lucid-resourceful/private/lucid_augmentations | Module augmentations that surface the relation-cache public methods on Lucid's own contracts, so Model.query().preloadCached(...) and instance.load(name, { forceLoad }) typecheck for consumers. |
| @nhtio/lucid-resourceful/private/utils/cache_error_handler | Process-wide registration + dispatch for the relation-cache error handler (onRelationsCacheError, ADR-009). Holds the host-supplied default handler and reports every runtime cache-infra/serialization failure to the effective handler (per-model → process-wide default → no-op), guarded and never awaited so a reporter can neither throw into nor delay a load/write. |
| @nhtio/lucid-resourceful/private/utils/cache_event_handler | Process-wide registration + dispatch for the relation-cache EVENT hook (onRelationsCacheEvent). The relation cache emits lifecycle events (hit/miss/store/force/bypass/evict); the host decides what to do with them — write to @nhtio/logger or Adonis' logger, push metrics, trace, or nothing. |
| @nhtio/lucid-resourceful/private/utils/cache_service_resolver | Resolves the cache service used for relation caching via a precedence chain (per-model relationsCacheService option → process-wide default → none) and exposes the package-level default registration setter. |
| @nhtio/lucid-resourceful/router | Resourceful Router Macro for use with Lucid Resourceful Library |
| @nhtio/lucid-resourceful/router/context | Utility which allows resolution of resourceful model context. |
| @nhtio/lucid-resourceful/router/utils | Resourceful Router Macro for use with Lucid Resourceful Library |
| @nhtio/lucid-resourceful/types | Types utilized by @nhtio/lucid-resourceful |
| @nhtio/lucid-resourceful/utils | Helpers and utilities used by Lucid Resourceful |