@nhtio/lucid-resourceful/types

Types utilized by @nhtio/lucid-resourceful

Namespaces

Namespace	Description
OpenAPIV3	-

Interfaces

Interface	Description
AdditionalResourcefulRouteDetails	Additional route details with OpenAPI metadata
AdditionalResourcefulRoutesMap	-
AdvancedResourcefulMixinOptions	-
ApplicationService	Application service is a singleton resolved from the container
BaseInterface	Base interface for all Resourceful data type options. Includes common modifier properties that apply to all data types.
DateTime	A DateTime is an immutable data structure representing a specific date and time and accompanying methods. It contains class and instance methods for creating, parsing, interrogating, transforming, and formatting them.
ExternalDocumentationObject	-
GeneratedRoute	Generated route configuration used internally by services
HttpContext	Http context encapsulates properties for a given HTTP request. The context class can be extended using macros and getters.
LocalResourcefulPropertyDefinition	-
LucidModel	Shape of the model static properties. The $ prefix is to denote special properties from the base model.
ModelQueryBuilderContract	Model query builder will have extras methods on top of the Database query builder
NormalizedAdditionalResourcefulRouteDetails	Normalized additional route details for internal processing
NormalizedAdditionalResourcefulRoutes	Normalized additional routes for internal processing
NormalizedResourcefulRouterOptions	Normalized configuration options for internal processing
ODataRouterMacro	-
ODataRouterService	-
OpenApiGeneratorService	OpenAPI generator service interface
ParsedNamedMiddleware	Parsed named middleware type
ResolvedResourcefulHttpContext	-
ResourcefulAccessControlFilter	-
ResourcefulArrayTypeOptions	Configuration options for ResourcefulArrayType instances. Defines array schemas with typed items and validation constraints. Supports complex item types including nested objects and arrays.
ResourcefulBigintTypeOptions	Configuration options for ResourcefulBigintType instances. Defines validation rules and constraints for 64-bit integer fields in OpenAPI schemas.
ResourcefulBinaryTypeOptions	Configuration options for ResourcefulBinaryType instances. Defines constraints for binary data represented as base64-encoded strings.
ResourcefulBooleanTypeOptions	Configuration options for ResourcefulBooleanType instances. Currently has no specific configuration options as boolean types are straightforward.
ResourcefulColumnDefinition	-
ResourcefulComputedAccessorDefinition	-
ResourcefulDateTimeTypeOptions	Configuration options for ResourcefulDateTimeType instances. Represents date-time values formatted as ISO 8601 date-time strings.
ResourcefulDateTypeOptions	Configuration options for ResourcefulDateType instances. Represents date-only values formatted as ISO 8601 date strings.
ResourcefulErrorMiddlewareHeaders	Configuration object for custom HTTP headers to be included in error responses. Allows for CORS headers, security headers, API versioning, or any custom headers that should be consistently applied to all error responses.
ResourcefulErrorMiddlewareOptions	Configuration options for the ResourcefulErrorMiddleware class. Defines event handlers for different error types and response formatting options.
ResourcefulFormattedError	Standardized error response format used by the ResourcefulErrorMiddleware. Provides consistent structure for all API error responses with support for field-level validation details and error chaining.
ResourcefulFormattedErrorDetails	Individual error detail within a formatted error response. Provides field-level information for validation errors or error chain details.
ResourcefulGeneralAccessControlFilter	-
ResourcefulHooks	Combined hook interface providing both query scoping and payload validation.
ResourcefulIndexResponse	-
ResourcefulIndexResult	Result object returned by the resourceful index/list operation.
ResourcefulIntegerTypeOptions	Configuration options for ResourcefulIntegerType instances. Defines validation rules and constraints for 32-bit integer fields in OpenAPI schemas.
ResourcefulMixinOptions	-
ResourcefulModel	Enhanced Lucid model interface providing resourceful CRUD functionality.
ResourcefulModelColumnMetaSchema	-
ResourcefulModelComputedAccessorMetaSchema	-
ResourcefulModelMetaSchema	-
ResourcefulModelRelationshipMetaSchema	-
ResourcefulNumberTypeOptions	Configuration options for ResourcefulNumberType instances. Defines validation rules and constraints for numeric fields in OpenAPI schemas.
ResourcefulObjectTypeOptions	Configuration options for ResourcefulObjectType instances. Defines complex object schemas with typed properties and validation rules. Supports advanced OpenAPI features like oneOf, allOf, anyOf, and not operators.
ResourcefulOpenAPISpec	OpenAPI specification structure for resourceful endpoints
ResourcefulPayloadSchemaGetter	Function type for generating request-specific payload validation schemas.
ResourcefulPayloadValidatorGetter	Function type for generating payload validation schemas based on request context.
ResourcefulPolicy	-
ResourcefulPropertyDefinition	-
ResourcefulQueryScopeCallback	Function type for applying query-level scoping to database queries.
ResourcefulRelationshipDefinition	-
ResourcefulResourceAccessControlFilter	-
ResourcefulRouterMacro	Main resourceful router macro function signature
ResourcefulRouterModelMappedOptions	-
ResourcefulRouterModelOptions	-
ResourcefulRouterModelServiceOptions	-
ResourcefulRouterMutatorOptions	-
ResourcefulRouterOptions	Configuration options for the resourceful router macro
ResourcefulSecuritySchemaDefinition	-
ResourcefulStringTypeOptions	Configuration options for ResourcefulStringType instances. Defines validation rules and constraints for string-based fields in OpenAPI schemas.
ResourcefulUnsignedIntegerTypeOptions	Configuration options for ResourcefulUnsignedIntegerType instances. Defines validation rules and constraints for unsigned integer fields in OpenAPI schemas.
RouteGeneratorService	Route generator service interface
RouterRegistrationService	Router registration service interface (AdonisJS router type to be defined)
ServableResourcefulIndexResult	-
ValidationScoper	-

Type Aliases

Type Alias	Description
BaseClass	Base type constraint for abstract constructor functions used in data type generation.
BaseModel	-
CallableNewable	A hybrid type that represents a constructor function which can be called both with and without the new keyword. This type enables creating data type classes that work as both constructors and factory functions.
ComputedOptions	Represents a computed property on the model
Constructor	Constructor type for controllers
DataTypeColumnOptions	-
DataTypeComputedOptions	-
DateColumnOptions	Options for date columns including autoCreate and autoUpdate flags.
EventMap	The default shape of the event map.
GetControllerHandlers	Controller handler methods type
HasManyThroughRelationOptions	Options for hasManyThrough relation decorators.
Key	A utility type used to extract the event key from the event map.
LazyImport	Lazy import type for controllers
Listener	A utility type used to extract the shape of the listener function from the event map.
LucidBinaryValue	-
LucidPlainObject	-
MacroModelsMap	Map of resource names to their corresponding ResourcefulModel classes
MiddlewareAsClass	-
MiddlewareFn	Middleware function type (simplified for now)
ModelColumnOptions	Shape of column options after they have set on the model
NormalizeConstructor	Normalizes constructor to work with mixins. There is an open bug for mixins to allow constructors other than ...args: any[]
OneOrMore	One or more middleware items
PromiseAble	-
Promised	-
RelatedModelRelationOptions	Options for relation decorators on related models.
Resolvable	-
ResolvedModelsMap	Resolved map of resource names to their corresponding ResourcefulModel classes
ResourcefulACLOperationType	-
ResourcefulACLOperationType	-
ResourcefulDataType	Union type representing all available resourceful data types. Provides a comprehensive type for working with any resourceful data type instance.
ResourcefulEnum	-
ResourcefulEnumObject	-
ResourcefulErrorHandlerMethod	-
ResourcefulErrorHandlerMethod	-
ResourcefulErrorMiddlewareEvents	Event map defining the types of errors that can be emitted by the ResourcefulErrorMiddleware. Each event type maps to the specific error instance that will be passed to event handlers.
ResourcefulHttpVerb	-
ResourcefulIndexResponseHook	-
ResourcefulMixinEventMap	-
ResourcefulModelFieldRelationshipMeta	-
ResourcefulModelOpenApiRelatedSchema	-
ResourcefulModelOpenApiSchema	-
ResourcefulModelPropertyMetaSchema	-
ResourcefulModelRelationshipMeta	-
ResourcefulModelRelationshipMetaChoice	-
ResourcefulModelSerializableAttributes	-
ResourcefulPropertySchema	-
ResourcefulResponseFormat	-
ResourcefulRouterOperation	-
ResourcefulRouterOptionsExcludedFromModelOptions	-
ResourcefulRouterVerb	-
ResourcefulRouterVerbMetaOperation	-
ResourcefulScopeHooks	Array of query scope callback functions.
ResourcefulValidationHooks	Array of payload validation schema getter functions.
ResourceResourcefulRecordResponse	-
ResourceResourcefulRecordResponseHook	-
RouteCallback	Route callback that can be either a function or controller tuple
RouteFn	Route callback function type
Schema	Union type of all available Joi schema types
VineValidationError	Type alias for Vine validation errors thrown by the VineJS validation library.

Variables

Variable	Description
odataRouterMacro	-
ResourcefulHttpVerb	-
ResourcefulResponseFormat	-
ResourcefulRouterOperation	-
ResourcefulRouterVerb	-
ResourcefulRouterVerbMetaOperation	-

References

AnySchema

Re-exports AnySchema

---

ArraySchema

Re-exports ArraySchema

---

BinarySchema

Re-exports BinarySchema

---

BooleanSchema

Re-exports BooleanSchema

---

DatabaseQueryBuilderContract

Re-exports DatabaseQueryBuilderContract

---

DateSchema

Re-exports DateSchema

---

NumberSchema

Re-exports NumberSchema

---

ObjectSchema

Re-exports ObjectSchema

---

StringSchema

Re-exports StringSchema

---

ValidationError

Re-exports ValidationError