@nhtio/lucid-resourceful 1.20250718.1 → 1.20250724.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nhtio/lucid-resourceful",
-  "version": "1.20250718.1",
+  "version": "1.20250724.0",
   "description": "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.",
   "keywords": [],
   "author": "Jak Giveon <jak@nht.io>",

package/private/decorators.d.ts

@@ -105,7 +105,7 @@ export declare namespace resourcefulComputed {
     var string: (options?: Partial<DataTypeComputedOptions> & Partial<ResourcefulComputedAccessorDefinition<StringSchema>>) => (target: any, propertyKey: string) => void;
     var date: (options?: Partial<DataTypeComputedOptions> & Partial<ResourcefulComputedAccessorDefinition<DateSchema>>) => (target: any, propertyKey: string) => void;
     var dateTime: (options?: Partial<DataTypeComputedOptions> & Partial<ResourcefulComputedAccessorDefinition<DateSchema>>) => (target: any, propertyKey: string) => void;
-    var binary: (options?: Partial<DataTypeComputedOptions> & Partial<ResourcefulComputedAccessorDefinition<DateSchema>>) => (target: any, propertyKey: string) => void;
+    var binary: (options?: Partial<DataTypeComputedOptions> & Partial<ResourcefulComputedAccessorDefinition<BinarySchema>>) => (target: any, propertyKey: string) => void;
     var number: (options?: Partial<DataTypeComputedOptions> & Partial<ResourcefulComputedAccessorDefinition<NumberSchema>>) => (target: any, propertyKey: string) => void;
     var integer: (options?: Partial<DataTypeComputedOptions> & Partial<ResourcefulComputedAccessorDefinition<NumberSchema>>) => (target: any, propertyKey: string) => void;
     var bigint: (options?: Partial<DataTypeComputedOptions> & Partial<ResourcefulComputedAccessorDefinition<NumberSchema>>) => (target: any, propertyKey: string) => void;

package/private/joi/index.d.ts

@@ -1,65 +1,3 @@
-import type { Root } from 'joi';
-import type { BigIntSchema } from './bigint';
-/**
- * Extended Joi root interface that includes custom schema types for
- * lucid-resourceful validation scenarios.
- *
- * This interface extends the standard Joi Root interface to include
- * additional schema types specifically designed for AdonisJS Lucid
- * model validation requirements.
- *
- * @example
- * ```typescript
- * import { joi } from '@nhtio/lucid-resourceful/joi'
- *
- * const schema = joi.object({
- *   id: joi.bigint().positive().required(),
- *   balance: joi.bigint().min(0n).optional()
- * })
- * ```
- *
- * @public
- */
-export interface ExtendedJoiRoot extends Root {
-    /**
-     * Creates a BigInt schema type for validation
-     * @returns A new BigInt schema instance
-     */
-    bigint(): BigIntSchema;
-}
-/**
- * Extended Joi instance with custom schema types for lucid-resourceful.
- *
- * This instance includes all standard Joi functionality plus additional
- * schema types optimized for AdonisJS Lucid model validation scenarios.
- *
- * @example
- * ```typescript
- * import { joi } from '@nhtio/lucid-resourceful/joi'
- *
- * // Standard Joi usage
- * const userSchema = joi.object({
- *   name: joi.string().required(),
- *   age: joi.number().min(0),
- *   balance: joi.bigint().positive() // Custom BigInt type
- * })
- *
- * // Use in resourceful decorators
- * @resourceful({
- *   type: 'bigint',
- *   validate: {
- *     create: joi.bigint().positive(),
- *     update: joi.bigint().min(0n)
- *   }
- * })
- * public balance: bigint
- * ```
- *
- * @public
- */
-export declare const joi: ExtendedJoiRoot;
-/**
- * Re-export of the BigIntSchema interface for external use
- * @public
- */
-export type { BigIntSchema };
+export * from '@nhtio/validation';
+import { validator } from '@nhtio/validation';
+export { validator as joi };

package/private/mixin.d.ts

@@ -280,7 +280,10 @@ export interface ResourcefulModel extends LucidModel {
      * );
      * ```
      */
-    $onResourcefulIndex<SelectedFields extends Array<keyof ResourcefulModelSerializableAttributes<InstanceType<LucidModel>>>, ReturnType = Pick<ResourcefulModelSerializableAttributes<InstanceType<LucidModel>>, SelectedFields[number]>>(filter: string | null | undefined, page: number, perPage: number, fields: SelectedFields | null | undefined, ctx: HttpContext, app: ApplicationService, hooks?: ResourcefulScopeHooks): Promise<ResourcefulIndexResult<ReturnType>>;
+    $onResourcefulIndex<SelectedFields extends Array<keyof ResourcefulModelSerializableAttributes<InstanceType<LucidModel>>>, SelectedSingleField extends keyof ResourcefulModelSerializableAttributes<InstanceType<LucidModel>>, ReturnType = Pick<ResourcefulModelSerializableAttributes<InstanceType<LucidModel>>, SelectedFields[number]>>(filter: string | null | undefined, page: number, perPage: number, fields: SelectedFields | SelectedSingleField | null | undefined, sort: Array<[
+        Extract<keyof ResourcefulModelSerializableAttributes<InstanceType<LucidModel>>, string>,
+        'asc' | 'desc'
+    ]> | null | undefined, ctx: HttpContext, app: ApplicationService, hooks?: ResourcefulScopeHooks): Promise<ResourcefulIndexResult<ReturnType>>;
     /**
      * Retrieves a single model record by its unique identifier with access control.
      *

package/private/prepare_consume_chain_builder.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Function types for prepare and consume operations
+ */
+export type CustomPrepareFunction = (value: unknown) => unknown;
+export type CustomConsumeFunction = (value: unknown) => unknown;
+export type DefaultPrepareFunction<T = unknown> = (key: string, value: unknown, nullable?: boolean) => T;
+export type DefaultConsumeFunction<T = unknown> = (key: string, value: unknown, nullable?: boolean) => T;
+/**
+ * Utility class for building chained prepare and consume functions.
+ *
+ * The chaining order reflects the data flow:
+ * - Prepare chain: Default → Custom (data flows TO database)
+ * - Consume chain: Custom → Default (data flows FROM database)
+ */
+export declare class PrepareConsumeChainBuilder {
+    /**
+     * Creates a chained prepare function that calls default first, then custom.
+     *
+     * @param propertyKey - The property name for error context
+     * @param nullable - Whether the field accepts null values
+     * @param defaultPrepare - The default prepare function from decorator
+     * @param customPrepare - The custom prepare function from options
+     * @returns A chained prepare function or undefined if no functions provided
+     */
+    static chainPrepare<T>(propertyKey: string, nullable: boolean, defaultPrepare?: DefaultPrepareFunction<T> | undefined, customPrepare?: CustomPrepareFunction | undefined): CustomPrepareFunction | undefined;
+    /**
+     * Creates a chained consume function that calls custom first, then default.
+     *
+     * @param propertyKey - The property name for error context
+     * @param nullable - Whether the field accepts null values
+     * @param defaultConsume - The default consume function from decorator
+     * @param customConsume - The custom consume function from options
+     * @returns A chained consume function or undefined if no functions provided
+     */
+    static chainConsume<T>(propertyKey: string, nullable: boolean, defaultConsume?: DefaultConsumeFunction<T>, customConsume?: CustomConsumeFunction): CustomConsumeFunction | undefined;
+}

package/private/types.d.ts

@@ -1,3 +1,4 @@
+import { CustomConsumeFunction, CustomPrepareFunction } from '@/private/prepare_consume_chain_builder.ts';
 import type { OpenAPIV3 } from 'openapi-types';
 import type { HttpContext } from '@adonisjs/core/http';
 import type { ApplicationService } from '@adonisjs/core/types';
@@ -30,6 +31,8 @@ export interface ResourcefulPropertyDefinition {
     externalDocs?: ExternalDocumentationObject;
     example?: string;
     deprecated?: boolean;
+    prepare?: CustomPrepareFunction;
+    consume?: CustomConsumeFunction;
 }
 export interface ValidationScoper<BaseSchema extends AnySchema> {
     (schema: BaseSchema): void;

package/utils.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const decorator_utils = require("./decorator_utils-1yWqd_Gg.cjs");
+const decorator_utils = require("./decorator_utils-U_rZo8tv.cjs");
 const casters = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
   __proto__: null,
   castValueAsArray: decorator_utils.castValueAsArray,

package/utils.mjs

@@ -1,5 +1,5 @@
-import { c as castValueAsArray, a as castValueAsBigint, b as castValueAsBinary, d as castValueAsBoolean, e as castValueAsDate, f as castValueAsDateTime, g as castValueAsInteger, h as castValueAsNumber, i as castValueAsObject, j as castValueAsString, k as castValueAsUnsignedInt, p as prepareArray, l as prepareBigint, m as prepareBinary, n as prepareBoolean, o as prepareDate, q as prepareDateTime, r as prepareInteger, s as prepareNumber, t as prepareObject, u as prepareString, v as prepareUnsignedint, w as consumeArray, x as consumeBigint, y as consumeBinary, z as consumeBoolean, A as consumeDate, B as consumeDateTime, C as consumeInteger, D as consumeNumber, E as consumeObject, F as consumeString, G as consumeUnsignedint } from "./decorator_utils-BUuBwQYK.js";
-import { H } from "./decorator_utils-BUuBwQYK.js";
+import { c as castValueAsArray, a as castValueAsBigint, b as castValueAsBinary, d as castValueAsBoolean, e as castValueAsDate, f as castValueAsDateTime, g as castValueAsInteger, h as castValueAsNumber, i as castValueAsObject, j as castValueAsString, k as castValueAsUnsignedInt, p as prepareArray, l as prepareBigint, m as prepareBinary, n as prepareBoolean, o as prepareDate, q as prepareDateTime, r as prepareInteger, s as prepareNumber, t as prepareObject, u as prepareString, v as prepareUnsignedint, w as consumeArray, x as consumeBigint, y as consumeBinary, z as consumeBoolean, A as consumeDate, B as consumeDateTime, C as consumeInteger, D as consumeNumber, E as consumeObject, F as consumeString, G as consumeUnsignedint } from "./decorator_utils-YSb1EGJ6.js";
+import { H } from "./decorator_utils-YSb1EGJ6.js";
 const casters = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
   __proto__: null,
   castValueAsArray,