adorn-api 1.0.13 → 1.0.14

package/dist/metal/readMetalBag.d.ts

@@ -1,33 +1,69 @@
+/**
+ * Symbol key for storing Metal ORM decorator metadata.
+ */
 export declare const METAL_METADATA_KEY = "metal-orm:decorators";
+/**
+ * Represents a column definition in Metal ORM entity metadata.
+ */
 export type MetalColumnDef = {
+    /** Database column type (e.g., "varchar", "int", "timestamp") */
     type: string;
+    /** Additional type arguments (e.g., length for varchar) */
     args?: unknown[];
+    /** Database dialect-specific type definitions */
     dialectTypes?: unknown;
+    /** Whether the column is NOT NULL */
     notNull?: boolean;
+    /** Whether this is a primary key column */
     primary?: boolean;
+    /** TypeScript type override for the column */
     tsType?: unknown;
+    /** Whether the column has a unique constraint */
     unique?: boolean;
+    /** Default value for the column */
     default?: unknown;
+    /** Whether the column auto-increments */
     autoIncrement?: boolean;
+    /** How the column value is generated (e.g., "byDefault", "always") */
     generated?: unknown;
+    /** CHECK constraint for the column */
     check?: unknown;
+    /** Foreign key references */
     references?: unknown;
+    /** Column comment/description */
     comment?: string;
 };
+/**
+ * Represents relation metadata in a Metal ORM entity.
+ */
 export type MetalRelationMetadata = {
+    /** Type of relation (e.g., "hasMany", "belongsTo") */
     kind: string;
+    /** Property name of the relation */
     propertyKey: string;
+    /** Target entity constructor (optional, may be a getter) */
     target?: (...args: any[]) => any;
 };
+/**
+ * Container for all decorator metadata of a Metal ORM entity.
+ */
 export type MetalDecoratorBag = {
+    /** Array of column definitions */
     columns: Array<{
         propertyName: string;
         column: MetalColumnDef;
     }>;
+    /** Array of relation metadata */
     relations: Array<{
         propertyName: string;
         relation: MetalRelationMetadata;
     }>;
 };
+/**
+ * Reads Metal ORM decorator metadata from a class constructor.
+ *
+ * @param ctor - The class constructor to read metadata from
+ * @returns The decorator bag if metadata exists, undefined otherwise
+ */
 export declare function readMetalDecoratorBagFromConstructor(ctor: object): MetalDecoratorBag | undefined;
 //# sourceMappingURL=readMetalBag.d.ts.map

package/dist/metal/readMetalBag.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"readMetalBag.d.ts","sourceRoot":"","sources":["../../src/metal/readMetalBag.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,kBAAkB,yBAAyB,CAAC;AAEzD,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC;IACjB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,KAAK,CAAC;QAAE,YAAY,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,cAAc,CAAA;KAAE,CAAC,CAAC;IACjE,SAAS,EAAE,KAAK,CAAC;QAAE,YAAY,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,qBAAqB,CAAA;KAAE,CAAC,CAAC;CAC7E,CAAC;AAEF,wBAAgB,oCAAoC,CAAC,IAAI,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS,CAIhG"}
+{"version":3,"file":"readMetalBag.d.ts","sourceRoot":"","sources":["../../src/metal/readMetalBag.ts"],"names":[],"mappings":"AAMA;;GAEG;AACH,eAAO,MAAM,kBAAkB,yBAAyB,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,iEAAiE;IACjE,IAAI,EAAE,MAAM,CAAC;IACb,2DAA2D;IAC3D,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC;IACjB,iDAAiD;IACjD,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,qCAAqC;IACrC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,2CAA2C;IAC3C,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,8CAA8C;IAC9C,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,iDAAiD;IACjD,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,mCAAmC;IACnC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,yCAAyC;IACzC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,sEAAsE;IACtE,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,sCAAsC;IACtC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,6BAA6B;IAC7B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,iCAAiC;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,sDAAsD;IACtD,IAAI,EAAE,MAAM,CAAC;IACb,oCAAoC;IACpC,WAAW,EAAE,MAAM,CAAC;IACpB,4DAA4D;IAC5D,MAAM,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,kCAAkC;IAClC,OAAO,EAAE,KAAK,CAAC;QAAE,YAAY,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,cAAc,CAAA;KAAE,CAAC,CAAC;IACjE,iCAAiC;IACjC,SAAS,EAAE,KAAK,CAAC;QAAE,YAAY,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,qBAAqB,CAAA;KAAE,CAAC,CAAC;CAC7E,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,oCAAoC,CAAC,IAAI,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS,CAIhG"}

package/dist/metal/registerMetalEntities.d.ts

@@ -1,6 +1,26 @@
+/**
+ * Utilities for registering Metal ORM entities as OpenAPI components.
+ */
 import { type SchemaFromEntityOptions } from "./schemaFromEntity.js";
+/**
+ * Options for registering Metal ORM entities.
+ */
 export interface RegisterMetalEntitiesOptions extends SchemaFromEntityOptions {
+    /** How to handle existing schemas with the same name: "override" or "merge" (default: "merge") */
     merge?: "override" | "merge";
 }
+/**
+ * Registers Metal ORM entity schemas in an OpenAPI document.
+ *
+ * @param openapi - The OpenAPI document to modify (will be mutated)
+ * @param entities - Array of entity class constructors to register
+ * @param opts - Optional configuration for schema generation and merging
+ *
+ * @example
+ * ```ts
+ * const openapi = { components: { schemas: {} } };
+ * registerMetalEntities(openapi, [User, Post, Comment]);
+ * ```
+ */
 export declare function registerMetalEntities(openapi: any, entities: Function[], opts?: RegisterMetalEntitiesOptions): void;
 //# sourceMappingURL=registerMetalEntities.d.ts.map

package/dist/metal/registerMetalEntities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"registerMetalEntities.d.ts","sourceRoot":"","sources":["../../src/metal/registerMetalEntities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,KAAK,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAYvF,MAAM,WAAW,4BAA6B,SAAQ,uBAAuB;IAC3E,KAAK,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC;CAC9B;AAED,wBAAgB,qBAAqB,CACnC,OAAO,EAAE,GAAG,EACZ,QAAQ,EAAE,QAAQ,EAAE,EACpB,IAAI,GAAE,4BAAiC,QAoBxC"}
+{"version":3,"file":"registerMetalEntities.d.ts","sourceRoot":"","sources":["../../src/metal/registerMetalEntities.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAoB,KAAK,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAYvF;;GAEG;AACH,MAAM,WAAW,4BAA6B,SAAQ,uBAAuB;IAC3E,kGAAkG;IAClG,KAAK,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC;CAC9B;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,qBAAqB,CACnC,OAAO,EAAE,GAAG,EACZ,QAAQ,EAAE,QAAQ,EAAE,EACpB,IAAI,GAAE,4BAAiC,QAoBxC"}

package/dist/metal/schemaFromEntity.d.ts

@@ -1,11 +1,41 @@
+/**
+ * JSON Schema representation for OpenAPI.
+ */
 export type JsonSchema = Record<string, any>;
+/**
+ * Schema generation mode determining which fields are included.
+ * - "read": All fields (read-only marked on primary keys)
+ * - "create": Exclude auto-generated fields (primary keys, autoIncrement)
+ * - "update": All fields (none required)
+ */
 export type EntitySchemaMode = "read" | "create" | "update";
+/**
+ * Options for generating a JSON Schema from an entity.
+ */
 export interface SchemaFromEntityOptions {
+    /** Custom name for the schema (defaults to entity class name) */
     name?: string;
+    /** Strip "Entity" suffix from class name (default: true) */
     stripEntitySuffix?: boolean;
+    /** Schema generation mode (default: "read") */
     mode?: EntitySchemaMode;
+    /** Allow additional properties not defined in schema (default: true) */
     additionalProperties?: boolean;
+    /** How to handle relations in the schema (default: "none") */
     includeRelations?: "none" | "inline";
 }
+/**
+ * Generates a JSON Schema from a Metal ORM entity class.
+ *
+ * @param ctor - The entity class constructor
+ * @param opts - Schema generation options
+ * @returns JSON Schema object or undefined if entity has no columns
+ *
+ * @example
+ * ```ts
+ * const schema = schemaFromEntity(User, { mode: "create" });
+ * // Returns: { title: "User", type: "object", properties: {...}, required: [...] }
+ * ```
+ */
 export declare function schemaFromEntity(ctor: Function, opts?: SchemaFromEntityOptions): JsonSchema | undefined;
 //# sourceMappingURL=schemaFromEntity.d.ts.map

package/dist/metal/schemaFromEntity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schemaFromEntity.d.ts","sourceRoot":"","sources":["../../src/metal/schemaFromEntity.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAE7C,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAE5D,MAAM,WAAW,uBAAuB;IACtC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,IAAI,CAAC,EAAE,gBAAgB,CAAC;IACxB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,gBAAgB,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAC;CACtC;AAgHD,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,GAAE,uBAA4B,GAAG,UAAU,GAAG,SAAS,CAwD3G"}
+{"version":3,"file":"schemaFromEntity.d.ts","sourceRoot":"","sources":["../../src/metal/schemaFromEntity.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAE7C;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,iEAAiE;IACjE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,4DAA4D;IAC5D,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,+CAA+C;IAC/C,IAAI,CAAC,EAAE,gBAAgB,CAAC;IACxB,wEAAwE;IACxE,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,8DAA8D;IAC9D,gBAAgB,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAC;CACtC;AAgHD;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,GAAE,uBAA4B,GAAG,UAAU,GAAG,SAAS,CAwD3G"}

package/dist/metal/searchWhere.d.ts

@@ -1,3 +1,7 @@
+/**
+ * Type definitions for building "where" clauses with nested relations.
+ * Supports filtering on entity properties and related entity properties.
+ */
 import type { BelongsToReference, HasManyCollection, HasOneReference, ManyToManyCollection, SelectableKeys } from "metal-orm";
 export type SearchWhereDepth = 0 | 1 | 2 | 3 | 4 | 5;
 type PrevDepth = [0, 0, 1, 2, 3, 4];
@@ -38,21 +42,56 @@ type WhereShape<TEntity extends object, Depth extends SearchWhereDepth, IncludeP
 } & (Depth extends 0 ? {} : {
     [K in RelationKeysWithOverrides<TEntity, RelationOverrides> as IsRelationAllowed<K, IncludePaths, ExcludePaths> extends true ? K : never]?: WhereShape<RelationTargetForKey<TEntity, K>, PrevDepth[Depth], ChildIncludePaths<K, IncludePaths>, ChildExcludePaths<K, ExcludePaths>, never>;
 });
+/**
+ * Represents valid property paths for SearchWhere filtering.
+ * Includes all scalar properties and nested relation paths.
+ *
+ * @typeParam TEntity - The entity type
+ * @typeParam Depth - Maximum nesting depth (default: 2)
+ * @typeParam Relations - Additional relation overrides
+ */
 export type SearchWherePath<TEntity extends object, Depth extends SearchWhereDepth = 2, Relations = never> = "*" | ScalarKeys<TEntity> | RelationKeysWithOverrides<TEntity, Relations> | (Depth extends 0 ? never : {
     [K in RelationKeysWithOverrides<TEntity, Relations>]: `${K}.*` | `${K}.${SearchWherePath<RelationTargetForKey<TEntity, K>, PrevDepth[Depth]>}`;
 }[RelationKeysWithOverrides<TEntity, Relations>]);
 type BaseSearchWhereOptions = {
+    /** Maximum depth for relation traversal */
     maxDepth?: SearchWhereDepth;
+    /** Whitelist of allowed property paths */
     include?: readonly string[];
+    /** Paths to exclude from filtering */
     exclude?: readonly string[];
+    /** Relation property names to include */
     relations?: readonly string[];
 };
 export type SearchWhereOptions<TEntity extends object, Depth extends SearchWhereDepth = 5, Relations = never> = {
+    /** Maximum depth for relation traversal */
     maxDepth?: Depth;
+    /** Whitelist of allowed property paths */
     include?: readonly SearchWherePath<TEntity, Depth, Relations>[];
+    /** Paths to exclude from filtering */
     exclude?: readonly SearchWherePath<TEntity, Depth, Relations>[];
+    /** Relation property names to include */
     relations?: readonly ObjectKeys<TEntity>[];
 };
+/**
+ * Type representing a where clause for querying entities.
+ * Supports filtering on scalar properties and nested relations.
+ *
+ * @typeParam TEntity - The entity type to filter
+ * @typeParam Opts - SearchWhere configuration options
+ *
+ * @example
+ * ```ts
+ * // Simple equality filter
+ * { name: "John" }
+ *
+ * // With operators
+ * { age: { gt: 18 }, name: { contains: "John" } }
+ *
+ * // Nested relation filter
+ * { posts: { title: { contains: "Hello" } } }
+ * ```
+ */
 export type SearchWhere<TEntity extends object, Opts extends BaseSearchWhereOptions = {}> = Opts extends SearchWhereOptions<TEntity, ResolveDepth<Opts>, ResolveRelations<Opts>> ? WhereShape<TEntity, ResolveDepth<Opts>, ResolveInclude<Opts>, ResolveExclude<Opts>, ResolveRelations<Opts>> : never;
 export {};
 //# sourceMappingURL=searchWhere.d.ts.map

package/dist/metal/searchWhere.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchWhere.d.ts","sourceRoot":"","sources":["../../src/metal/searchWhere.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,kBAAkB,EAClB,iBAAiB,EACjB,eAAe,EACf,oBAAoB,EACpB,cAAc,EACf,MAAM,WAAW,CAAC;AAEnB,MAAM,MAAM,gBAAgB,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAErD,KAAK,SAAS,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;AAEpC,KAAK,eAAe,GAChB,iBAAiB,CAAC,GAAG,CAAC,GACtB,oBAAoB,CAAC,GAAG,EAAE,GAAG,CAAC,GAC9B,eAAe,CAAC,GAAG,CAAC,GACpB,kBAAkB,CAAC,GAAG,CAAC,CAAC;AAE5B,KAAK,YAAY,CAAC,OAAO,SAAS,MAAM,IAAI;KACzC,CAAC,IAAI,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,eAAe,GAAG,CAAC,GAAG,KAAK;CAC7F,CAAC,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC;AAE1B,KAAK,cAAc,CAAC,CAAC,IAAI,CAAC,SAAS,iBAAiB,CAAC,MAAM,CAAC,SAAS,MAAM,CAAC,GACxE,CAAC,GACD,CAAC,SAAS,oBAAoB,CAAC,MAAM,CAAC,SAAS,MAAM,EAAE,GAAG,CAAC,GACzD,CAAC,GACH,CAAC,SAAS,eAAe,CAAC,MAAM,CAAC,SAAS,MAAM,CAAC,GAC/C,CAAC,GACC,CAAC,SAAS,kBAAkB,CAAC,MAAM,CAAC,SAAS,MAAM,CAAC,GAClD,CAAC,GACD,KAAK,CAAC;AAEhB,KAAK,oBAAoB,CAAC,OAAO,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,OAAO,GAAG,MAAM,IAChF,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,eAAe,GAC3C,cAAc,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,GACvC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GACpC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GACvB,KAAK,CAAC;AAEd,KAAK,UAAU,CAAC,OAAO,SAAS,MAAM,IAAI,cAAc,CAAC,OAAO,CAAC,GAAG,MAAM,OAAO,GAAG,MAAM,CAAC;AAE3F,KAAK,UAAU,CAAC,OAAO,SAAS,MAAM,IAAI;KACvC,CAAC,IAAI,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,CAAC,GAAG,KAAK;CACpF,CAAC,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC;AAE1B,KAAK,oBAAoB,CAAC,OAAO,SAAS,MAAM,EAAE,SAAS,IAAI,OAAO,CAAC,SAAS,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;AAEvG,KAAK,yBAAyB,CAAC,OAAO,SAAS,MAAM,EAAE,SAAS,IAC9D,YAAY,CAAC,OAAO,CAAC,GAAG,oBAAoB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;AAEnE,KAAK,WAAW,CAAC,GAAG,SAAS,MAAM,EAAE,KAAK,IAAI,KAAK,SAAS,GAAG,GAAG,IAAI,MAAM,IAAI,EAAE,GAAG,IAAI,GAAG,KAAK,CAAC;AAElG,KAAK,cAAc,CAAC,YAAY,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,KAAK,CAAC,GAC9D,IAAI,GACJ,GAAG,SAAS,YAAY,GACtB,IAAI,GACJ,KAAK,CAAC;AAEZ,KAAK,YAAY,CAAC,YAAY,IAAI,GAAG,SAAS,YAAY,GAAG,IAAI,GAAG,KAAK,CAAC;AAE1E,KAAK,iBAAiB,CAAC,GAAG,SAAS,MAAM,EAAE,KAAK,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,GAAG,IAAI,MAAM,EAAE,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GACpG,KAAK,GACL,IAAI,CAAC;AAET,KAAK,eAAe,CAAC,GAAG,SAAS,MAAM,EAAE,YAAY,EAAE,YAAY,IAAI,YAAY,CAAC,YAAY,CAAC,SAAS,IAAI,GAC1G,KAAK,GACL,cAAc,CAAC,YAAY,CAAC,SAAS,IAAI,GACvC,CAAC,OAAO,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAC1C,IAAI,GACJ,KAAK,GACP,CAAC,OAAO,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAC1C,KAAK,GACL,CAAC,OAAO,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAC1C,IAAI,GACJ,KAAK,CAAC;AAEhB,KAAK,iBAAiB,CAAC,GAAG,SAAS,MAAM,EAAE,YAAY,EAAE,YAAY,IAAI,YAAY,CAAC,YAAY,CAAC,SAAS,IAAI,GAC5G,KAAK,GACL,CAAC,OAAO,CAAC,YAAY,EAAE,GAAG,GAAG,GAAG,GAAG,IAAI,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GACvD,cAAc,CAAC,YAAY,CAAC,SAAS,IAAI,GACvC,IAAI,GACJ,CAAC,OAAO,CAAC,YAAY,EAAE,GAAG,GAAG,GAAG,GAAG,IAAI,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GACvD,iBAAiB,CAAC,GAAG,EAAE,YAAY,CAAC,GACpC,IAAI,GACR,KAAK,CAAC;AAEZ,KAAK,iBAAiB,CAAC,GAAG,SAAS,MAAM,EAAE,YAAY,IAAI,cAAc,CAAC,YAAY,CAAC,SAAS,IAAI,GAChG,KAAK,GACL,CAAC,OAAO,CAAC,YAAY,EAAE,GAAG,GAAG,GAAG,GAAG,IAAI,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GACvD,WAAW,CAAC,GAAG,EAAE,YAAY,CAAC,GAC9B,KAAK,CAAC;AAEZ,KAAK,iBAAiB,CAAC,GAAG,SAAS,MAAM,EAAE,YAAY,IAAI,YAAY,CAAC,YAAY,CAAC,SAAS,IAAI,GAC9F,GAAG,GACH,WAAW,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;AAEnC,KAAK,YAAY,CAAC,IAAI,IAAI,IAAI,SAAS;IAAE,QAAQ,EAAE,MAAM,CAAC,CAAA;CAAE,GACxD,CAAC,SAAS,gBAAgB,GACxB,CAAC,GACD,CAAC,GACH,CAAC,CAAC;AAEN,KAAK,cAAc,CAAC,IAAI,IAAI,IAAI,SAAS;IAAE,OAAO,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAA;CAAE,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,GAAG,KAAK,CAAC;AAClG,KAAK,cAAc,CAAC,IAAI,IAAI,IAAI,SAAS;IAAE,OAAO,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAA;CAAE,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,GAAG,KAAK,CAAC;AAClG,KAAK,gBAAgB,CAAC,IAAI,IAAI,IAAI,SAAS;IAAE,SAAS,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAA;CAAE,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,GAAG,KAAK,CAAC;AAEtG,KAAK,UAAU,CACb,OAAO,SAAS,MAAM,EACtB,KAAK,SAAS,gBAAgB,EAC9B,YAAY,EACZ,YAAY,EACZ,iBAAiB,IACf;KACD,CAAC,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,eAAe,CAAC,CAAC,EAAE,YAAY,EAAE,YAAY,CAAC,SAAS,IAAI,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;CACnH,GAAG,CAAC,KAAK,SAAS,CAAC,GAChB,EAAE,GACF;KACG,CAAC,IAAI,yBAAyB,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,iBAAiB,CAAC,CAAC,EAAE,YAAY,EAAE,YAAY,CAAC,SAAS,IAAI,GACxH,CAAC,GACD,KAAK,CAAC,CAAC,EAAE,UAAU,CACrB,oBAAoB,CAAC,OAAO,EAAE,CAAC,CAAC,EAChC,SAAS,CAAC,KAAK,CAAC,EAChB,iBAAiB,CAAC,CAAC,EAAE,YAAY,CAAC,EAClC,iBAAiB,CAAC,CAAC,EAAE,YAAY,CAAC,EAClC,KAAK,CACN;CACF,CAAC,CAAC;AAEP,MAAM,MAAM,eAAe,CACzB,OAAO,SAAS,MAAM,EACtB,KAAK,SAAS,gBAAgB,GAAG,CAAC,EAClC,SAAS,GAAG,KAAK,IAEf,GAAG,GACH,UAAU,CAAC,OAAO,CAAC,GACnB,yBAAyB,CAAC,OAAO,EAAE,SAAS,CAAC,GAC7C,CAAC,KAAK,SAAS,CAAC,GACZ,KAAK,GACL;KACG,CAAC,IAAI,yBAAyB,CAAC,OAAO,EAAE,SAAS,CAAC,GACjD,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,eAAe,CAAC,oBAAoB,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE;CAC3F,CAAC,yBAAyB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;AAE1D,KAAK,sBAAsB,GAAG;IAC5B,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5B,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5B,SAAS,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,kBAAkB,CAC5B,OAAO,SAAS,MAAM,EACtB,KAAK,SAAS,gBAAgB,GAAG,CAAC,EAClC,SAAS,GAAG,KAAK,IACf;IACF,QAAQ,CAAC,EAAE,KAAK,CAAC;IACjB,OAAO,CAAC,EAAE,SAAS,eAAe,CAAC,OAAO,EAAE,KAAK,EAAE,SAAS,CAAC,EAAE,CAAC;IAChE,OAAO,CAAC,EAAE,SAAS,eAAe,CAAC,OAAO,EAAE,KAAK,EAAE,SAAS,CAAC,EAAE,CAAC;IAChE,SAAS,CAAC,EAAE,SAAS,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;CAC5C,CAAC;AAEF,MAAM,MAAM,WAAW,CAAC,OAAO,SAAS,MAAM,EAAE,IAAI,SAAS,sBAAsB,GAAG,EAAE,IACtF,IAAI,SAAS,kBAAkB,CAAC,OAAO,EAAE,YAAY,CAAC,IAAI,CAAC,EAAE,gBAAgB,CAAC,IAAI,CAAC,CAAC,GAChF,UAAU,CAAC,OAAO,EAAE,YAAY,CAAC,IAAI,CAAC,EAAE,cAAc,CAAC,IAAI,CAAC,EAAE,cAAc,CAAC,IAAI,CAAC,EAAE,gBAAgB,CAAC,IAAI,CAAC,CAAC,GAC3G,KAAK,CAAC"}
+{"version":3,"file":"searchWhere.d.ts","sourceRoot":"","sources":["../../src/metal/searchWhere.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EACV,kBAAkB,EAClB,iBAAiB,EACjB,eAAe,EACf,oBAAoB,EACpB,cAAc,EACf,MAAM,WAAW,CAAC;AAEnB,MAAM,MAAM,gBAAgB,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAErD,KAAK,SAAS,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;AAEpC,KAAK,eAAe,GAChB,iBAAiB,CAAC,GAAG,CAAC,GACtB,oBAAoB,CAAC,GAAG,EAAE,GAAG,CAAC,GAC9B,eAAe,CAAC,GAAG,CAAC,GACpB,kBAAkB,CAAC,GAAG,CAAC,CAAC;AAE5B,KAAK,YAAY,CAAC,OAAO,SAAS,MAAM,IAAI;KACzC,CAAC,IAAI,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,eAAe,GAAG,CAAC,GAAG,KAAK;CAC7F,CAAC,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC;AAE1B,KAAK,cAAc,CAAC,CAAC,IAAI,CAAC,SAAS,iBAAiB,CAAC,MAAM,CAAC,SAAS,MAAM,CAAC,GACxE,CAAC,GACD,CAAC,SAAS,oBAAoB,CAAC,MAAM,CAAC,SAAS,MAAM,EAAE,GAAG,CAAC,GACzD,CAAC,GACH,CAAC,SAAS,eAAe,CAAC,MAAM,CAAC,SAAS,MAAM,CAAC,GAC/C,CAAC,GACC,CAAC,SAAS,kBAAkB,CAAC,MAAM,CAAC,SAAS,MAAM,CAAC,GAClD,CAAC,GACD,KAAK,CAAC;AAEhB,KAAK,oBAAoB,CAAC,OAAO,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,OAAO,GAAG,MAAM,IAChF,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,eAAe,GAC3C,cAAc,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,GACvC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GACpC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GACvB,KAAK,CAAC;AAEd,KAAK,UAAU,CAAC,OAAO,SAAS,MAAM,IAAI,cAAc,CAAC,OAAO,CAAC,GAAG,MAAM,OAAO,GAAG,MAAM,CAAC;AAE3F,KAAK,UAAU,CAAC,OAAO,SAAS,MAAM,IAAI;KACvC,CAAC,IAAI,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,CAAC,GAAG,KAAK;CACpF,CAAC,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC;AAE1B,KAAK,oBAAoB,CAAC,OAAO,SAAS,MAAM,EAAE,SAAS,IAAI,OAAO,CAAC,SAAS,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;AAEvG,KAAK,yBAAyB,CAAC,OAAO,SAAS,MAAM,EAAE,SAAS,IAC9D,YAAY,CAAC,OAAO,CAAC,GAAG,oBAAoB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;AAEnE,KAAK,WAAW,CAAC,GAAG,SAAS,MAAM,EAAE,KAAK,IAAI,KAAK,SAAS,GAAG,GAAG,IAAI,MAAM,IAAI,EAAE,GAAG,IAAI,GAAG,KAAK,CAAC;AAElG,KAAK,cAAc,CAAC,YAAY,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,KAAK,CAAC,GAC9D,IAAI,GACJ,GAAG,SAAS,YAAY,GACtB,IAAI,GACJ,KAAK,CAAC;AAEZ,KAAK,YAAY,CAAC,YAAY,IAAI,GAAG,SAAS,YAAY,GAAG,IAAI,GAAG,KAAK,CAAC;AAE1E,KAAK,iBAAiB,CAAC,GAAG,SAAS,MAAM,EAAE,KAAK,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,GAAG,IAAI,MAAM,EAAE,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GACpG,KAAK,GACL,IAAI,CAAC;AAET,KAAK,eAAe,CAAC,GAAG,SAAS,MAAM,EAAE,YAAY,EAAE,YAAY,IAAI,YAAY,CAAC,YAAY,CAAC,SAAS,IAAI,GAC1G,KAAK,GACL,cAAc,CAAC,YAAY,CAAC,SAAS,IAAI,GACvC,CAAC,OAAO,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAC1C,IAAI,GACJ,KAAK,GACP,CAAC,OAAO,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAC1C,KAAK,GACL,CAAC,OAAO,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAC1C,IAAI,GACJ,KAAK,CAAC;AAEhB,KAAK,iBAAiB,CAAC,GAAG,SAAS,MAAM,EAAE,YAAY,EAAE,YAAY,IAAI,YAAY,CAAC,YAAY,CAAC,SAAS,IAAI,GAC5G,KAAK,GACL,CAAC,OAAO,CAAC,YAAY,EAAE,GAAG,GAAG,GAAG,GAAG,IAAI,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GACvD,cAAc,CAAC,YAAY,CAAC,SAAS,IAAI,GACvC,IAAI,GACJ,CAAC,OAAO,CAAC,YAAY,EAAE,GAAG,GAAG,GAAG,GAAG,IAAI,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GACvD,iBAAiB,CAAC,GAAG,EAAE,YAAY,CAAC,GACpC,IAAI,GACR,KAAK,CAAC;AAEZ,KAAK,iBAAiB,CAAC,GAAG,SAAS,MAAM,EAAE,YAAY,IAAI,cAAc,CAAC,YAAY,CAAC,SAAS,IAAI,GAChG,KAAK,GACL,CAAC,OAAO,CAAC,YAAY,EAAE,GAAG,GAAG,GAAG,GAAG,IAAI,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GACvD,WAAW,CAAC,GAAG,EAAE,YAAY,CAAC,GAC9B,KAAK,CAAC;AAEZ,KAAK,iBAAiB,CAAC,GAAG,SAAS,MAAM,EAAE,YAAY,IAAI,YAAY,CAAC,YAAY,CAAC,SAAS,IAAI,GAC9F,GAAG,GACH,WAAW,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;AAEnC,KAAK,YAAY,CAAC,IAAI,IAAI,IAAI,SAAS;IAAE,QAAQ,EAAE,MAAM,CAAC,CAAA;CAAE,GACxD,CAAC,SAAS,gBAAgB,GACxB,CAAC,GACD,CAAC,GACH,CAAC,CAAC;AAEN,KAAK,cAAc,CAAC,IAAI,IAAI,IAAI,SAAS;IAAE,OAAO,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAA;CAAE,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,GAAG,KAAK,CAAC;AAClG,KAAK,cAAc,CAAC,IAAI,IAAI,IAAI,SAAS;IAAE,OAAO,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAA;CAAE,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,GAAG,KAAK,CAAC;AAClG,KAAK,gBAAgB,CAAC,IAAI,IAAI,IAAI,SAAS;IAAE,SAAS,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAA;CAAE,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,GAAG,KAAK,CAAC;AAEtG,KAAK,UAAU,CACb,OAAO,SAAS,MAAM,EACtB,KAAK,SAAS,gBAAgB,EAC9B,YAAY,EACZ,YAAY,EACZ,iBAAiB,IACf;KACD,CAAC,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,eAAe,CAAC,CAAC,EAAE,YAAY,EAAE,YAAY,CAAC,SAAS,IAAI,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;CACnH,GAAG,CAAC,KAAK,SAAS,CAAC,GAChB,EAAE,GACF;KACG,CAAC,IAAI,yBAAyB,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,iBAAiB,CAAC,CAAC,EAAE,YAAY,EAAE,YAAY,CAAC,SAAS,IAAI,GACxH,CAAC,GACD,KAAK,CAAC,CAAC,EAAE,UAAU,CACrB,oBAAoB,CAAC,OAAO,EAAE,CAAC,CAAC,EAChC,SAAS,CAAC,KAAK,CAAC,EAChB,iBAAiB,CAAC,CAAC,EAAE,YAAY,CAAC,EAClC,iBAAiB,CAAC,CAAC,EAAE,YAAY,CAAC,EAClC,KAAK,CACN;CACF,CAAC,CAAC;AAEP;;;;;;;GAOG;AACH,MAAM,MAAM,eAAe,CACzB,OAAO,SAAS,MAAM,EACtB,KAAK,SAAS,gBAAgB,GAAG,CAAC,EAClC,SAAS,GAAG,KAAK,IAEf,GAAG,GACH,UAAU,CAAC,OAAO,CAAC,GACnB,yBAAyB,CAAC,OAAO,EAAE,SAAS,CAAC,GAC7C,CAAC,KAAK,SAAS,CAAC,GACZ,KAAK,GACL;KACG,CAAC,IAAI,yBAAyB,CAAC,OAAO,EAAE,SAAS,CAAC,GACjD,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,eAAe,CAAC,oBAAoB,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE;CAC3F,CAAC,yBAAyB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;AAE1D,KAAK,sBAAsB,GAAG;IAC5B,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B,0CAA0C;IAC1C,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5B,sCAAsC;IACtC,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5B,yCAAyC;IACzC,SAAS,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,kBAAkB,CAC5B,OAAO,SAAS,MAAM,EACtB,KAAK,SAAS,gBAAgB,GAAG,CAAC,EAClC,SAAS,GAAG,KAAK,IACf;IACF,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,KAAK,CAAC;IACjB,0CAA0C;IAC1C,OAAO,CAAC,EAAE,SAAS,eAAe,CAAC,OAAO,EAAE,KAAK,EAAE,SAAS,CAAC,EAAE,CAAC;IAChE,sCAAsC;IACtC,OAAO,CAAC,EAAE,SAAS,eAAe,CAAC,OAAO,EAAE,KAAK,EAAE,SAAS,CAAC,EAAE,CAAC;IAChE,yCAAyC;IACzC,SAAS,CAAC,EAAE,SAAS,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;CAC5C,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,WAAW,CAAC,OAAO,SAAS,MAAM,EAAE,IAAI,SAAS,sBAAsB,GAAG,EAAE,IACtF,IAAI,SAAS,kBAAkB,CAAC,OAAO,EAAE,YAAY,CAAC,IAAI,CAAC,EAAE,gBAAgB,CAAC,IAAI,CAAC,CAAC,GAChF,UAAU,CAAC,OAAO,EAAE,YAAY,CAAC,IAAI,CAAC,EAAE,cAAc,CAAC,IAAI,CAAC,EAAE,cAAc,CAAC,IAAI,CAAC,EAAE,gBAAgB,CAAC,IAAI,CAAC,CAAC,GAC3G,KAAK,CAAC"}

package/dist/metal/symbolMetadata.d.ts

@@ -1,2 +1,8 @@
+/**
+ * Ensures the Symbol.metadata symbol exists and returns it.
+ * Used by Metal ORM decorators to store metadata on classes.
+ *
+ * @returns The Symbol.metadata symbol
+ */
 export declare function ensureSymbolMetadata(): symbol;
 //# sourceMappingURL=symbolMetadata.d.ts.map

package/dist/metal/symbolMetadata.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"symbolMetadata.d.ts","sourceRoot":"","sources":["../../src/metal/symbolMetadata.ts"],"names":[],"mappings":"AAAA,wBAAgB,oBAAoB,IAAI,MAAM,CAM7C"}
+{"version":3,"file":"symbolMetadata.d.ts","sourceRoot":"","sources":["../../src/metal/symbolMetadata.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wBAAgB,oBAAoB,IAAI,MAAM,CAM7C"}

package/dist/runtime/auth/runtime.d.ts

@@ -1,34 +1,183 @@
+/**
+ * Runtime authentication module for adorn-api.
+ *
+ * @remarks
+ * This module provides interfaces and factory functions for implementing
+ * authentication schemes in adorn-api. It includes utilities for Bearer JWT
+ * authentication and API key authentication.
+ *
+ * @package
+ */
+/**
+ * Result of an authentication attempt.
+ *
+ * @remarks
+ * Contains the authenticated principal (user/entity) and any granted scopes
+ * that can be used for authorization decisions.
+ *
+ * @public
+ */
 export interface AuthResult {
+    /**
+     * The authenticated principal (user object, token payload, etc.).
+     */
     principal: any;
+    /**
+     * Array of scope strings granted to the principal.
+     * Used for authorization checks.
+     */
     scopes?: string[];
 }
+/**
+ * Runtime interface for an authentication scheme.
+ *
+ * @remarks
+ * Implement this interface to create custom authentication schemes.
+ * Each scheme must provide methods for authentication, issuing challenges,
+ * and optional authorization.
+ *
+ * @public
+ */
 export interface AuthSchemeRuntime {
+    /**
+     * Unique name identifying this authentication scheme.
+     */
     name: string;
+    /**
+     * Authenticate a request and return the result.
+     *
+     * @param req - The incoming request object
+     * @returns Promise resolving to AuthResult if authenticated, null otherwise
+     */
     authenticate(req: any): Promise<AuthResult | null>;
+    /**
+     * Send an authentication challenge to the client.
+     *
+     * @param res - The response object to send the challenge
+     */
     challenge(res: any): void;
+    /**
+     * Authorize an authenticated principal against required scopes.
+     *
+     * @param auth - The authentication result
+     * @param requiredScopes - Scopes required for the operation
+     * @returns true if authorized, false otherwise
+     */
     authorize?(auth: AuthResult, requiredScopes: string[]): boolean;
 }
-export declare function createBearerJwtRuntime(options: {
+/**
+ * Options for creating a Bearer JWT authentication runtime.
+ *
+ * @public
+ */
+export interface BearerJwtRuntimeOptions {
+    /**
+     * Extract the Bearer token from a request.
+     *
+     * @param req - The incoming request object
+     * @returns The token string, or undefined if not present
+     */
     getToken: (req: any) => string | undefined;
+    /**
+     * Verify a JWT token and return its payload.
+     *
+     * @param token - The JWT token to verify
+     * @returns Promise resolving to the token payload
+     * @defaultvalue Async function that returns the token as payload
+     */
     verify?: (token: string) => Promise<any>;
+    /**
+     * Extract scopes from a token payload.
+     *
+     * @param payload - The JWT payload
+     * @returns Array of scope strings
+     * @defaultvalue Function returning empty array
+     */
     getScopes?: (payload: any) => string[];
-}): {
+}
+/**
+ * Options for creating an API key header authentication runtime.
+ *
+ * @public
+ */
+export interface ApiKeyHeaderRuntimeOptions {
+    /**
+     * The name of the header containing the API key.
+     */
+    headerName: string;
+    /**
+     * Validate an API key and return the associated principal.
+     *
+     * @param key - The API key to validate
+     * @returns Promise resolving to the principal (user/service) associated with the key
+     */
+    validate: (key: string) => Promise<any>;
+}
+/**
+ * Creates a Bearer JWT authentication runtime.
+ *
+ * @remarks
+ * This factory function creates an AuthSchemeRuntime for Bearer token authentication.
+ * The implementation extracts the token from the Authorization header, verifies it,
+ * and extracts scopes from the payload.
+ *
+ * @example
+ * ```typescript
+ * const bearerRuntime = createBearerJwtRuntime({
+ *   getToken: (req) => req.headers.authorization?.split(' ')[1],
+ *   verify: async (token) => jwt.verify(token, secret),
+ *   getScopes: (payload) => payload.scopes || []
+ * });
+ * ```
+ *
+ * @param options - Configuration options for the Bearer JWT runtime
+ * @returns An AuthSchemeRuntime for Bearer authentication
+ *
+ * @public
+ */
+export declare function createBearerJwtRuntime(options: BearerJwtRuntimeOptions): {
     name: string;
+    /** @inheritdoc */
     authenticate(req: any): Promise<{
         principal: any;
         scopes: string[];
     } | null>;
+    /** @inheritdoc */
     challenge(res: any): void;
+    /** @inheritdoc */
     authorize(auth: AuthResult, requiredScopes: string[]): boolean;
 };
-export declare function createApiKeyHeaderRuntime(options: {
-    headerName: string;
-    validate: (key: string) => Promise<any>;
-}): {
+/**
+ * Creates an API key header authentication runtime.
+ *
+ * @remarks
+ * This factory function creates an AuthSchemeRuntime for API key authentication.
+ * The implementation extracts the API key from a specified header and validates it.
+ *
+ * @example
+ * ```typescript
+ * const apiKeyRuntime = createApiKeyHeaderRuntime({
+ *   headerName: "X-API-Key",
+ *   validate: async (key) => {
+ *     const user = await db.users.findByApiKey(key);
+ *     if (!user) throw new Error("Invalid API key");
+ *     return user;
+ *   }
+ * });
+ * ```
+ *
+ * @param options - Configuration options for the API key runtime
+ * @returns An AuthSchemeRuntime for API key authentication
+ *
+ * @public
+ */
+export declare function createApiKeyHeaderRuntime(options: ApiKeyHeaderRuntimeOptions): {
     name: string;
+    /** @inheritdoc */
     authenticate(req: any): Promise<{
         principal: any;
     } | null>;
+    /** @inheritdoc */
     challenge(res: any): void;
 };
 //# sourceMappingURL=runtime.d.ts.map

package/dist/runtime/auth/runtime.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["../../../src/runtime/auth/runtime.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,UAAU;IACzB,SAAS,EAAE,GAAG,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC;IACnD,SAAS,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI,CAAC;IAC1B,SAAS,CAAC,CAAC,IAAI,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;CACjE;AAED,wBAAgB,sBAAsB,CAAC,OAAO,EAAE;IAC9C,QAAQ,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,MAAM,GAAG,SAAS,CAAC;IAC3C,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IACzC,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,MAAM,EAAE,CAAC;CACxC;;sBAK2B,GAAG;;;;mBAYZ,GAAG;oBAIF,UAAU,kBAAkB,MAAM,EAAE;EAMvD;AAED,wBAAgB,yBAAyB,CAAC,OAAO,EAAE;IACjD,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;CACzC;;sBAK2B,GAAG;;;mBAWZ,GAAG;EAIrB"}
+{"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["../../../src/runtime/auth/runtime.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH;;;;;;;;GAQG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,SAAS,EAAE,GAAG,CAAC;IAEf;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC;IAEnD;;;;OAIG;IACH,SAAS,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI,CAAC;IAE1B;;;;;;OAMG;IACH,SAAS,CAAC,CAAC,IAAI,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;CACjE;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC;;;;;OAKG;IACH,QAAQ,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,MAAM,GAAG,SAAS,CAAC;IAE3C;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IAEzC;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,MAAM,EAAE,CAAC;CACxC;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;CACzC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,uBAAuB;;IAMnE,kBAAkB;sBACM,GAAG;;;;IAa3B,kBAAkB;mBACH,GAAG;IAKlB,kBAAkB;oBACF,UAAU,kBAAkB,MAAM,EAAE;EAMvD;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,yBAAyB,CAAC,OAAO,EAAE,0BAA0B;;IAMzE,kBAAkB;sBACM,GAAG;;;IAY3B,kBAAkB;mBACH,GAAG;EAIrB"}

package/dist/runtime/metadata/bucket.d.ts

@@ -1,3 +1,2 @@
-import type { AdornBucket } from "./types.js";
-export declare function getBucket(metadata: DecoratorMetadata): AdornBucket;
+export {};
 //# sourceMappingURL=bucket.d.ts.map

package/dist/runtime/metadata/bucket.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bucket.d.ts","sourceRoot":"","sources":["../../../src/runtime/metadata/bucket.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE9C,wBAAgB,SAAS,CAAC,QAAQ,EAAE,iBAAiB,GAAG,WAAW,CAalE"}
+{"version":3,"file":"bucket.d.ts","sourceRoot":"","sources":["../../../src/runtime/metadata/bucket.ts"],"names":[],"mappings":""}

package/dist/runtime/metadata/key.d.ts

@@ -1,2 +1,2 @@
-export declare const ADORN_META: unique symbol;
+export {};
 //# sourceMappingURL=key.d.ts.map

package/dist/runtime/metadata/key.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"key.d.ts","sourceRoot":"","sources":["../../../src/runtime/metadata/key.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,UAAU,eAA+B,CAAC"}
+{"version":3,"file":"key.d.ts","sourceRoot":"","sources":["../../../src/runtime/metadata/key.ts"],"names":[],"mappings":""}

package/dist/runtime/metadata/read.d.ts

@@ -1,3 +1,2 @@
-import type { AdornBucket } from "./types.js";
-export declare function readAdornBucket(ctor: Function): AdornBucket | null;
+export {};
 //# sourceMappingURL=read.d.ts.map

package/dist/runtime/metadata/read.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"read.d.ts","sourceRoot":"","sources":["../../../src/runtime/metadata/read.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE9C,wBAAgB,eAAe,CAAC,IAAI,EAAE,QAAQ,GAAG,WAAW,GAAG,IAAI,CAalE"}
+{"version":3,"file":"read.d.ts","sourceRoot":"","sources":["../../../src/runtime/metadata/read.ts"],"names":[],"mappings":""}

package/dist/runtime/metadata/types.d.ts

@@ -1,21 +1,95 @@
+/**
+ * Runtime metadata types for adorn-api.
+ *
+ * @remarks
+ * This module contains the type definitions used by the runtime metadata
+ * system, including HTTP methods, route operations, and authentication metadata.
+ *
+ * @package
+ */
+/**
+ * Supported HTTP methods for route operations.
+ *
+ * @public
+ */
 export type HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD";
+/**
+ * Represents a single route operation registered on a controller.
+ *
+ * @public
+ */
 export interface RouteOperation {
+    /**
+     * The HTTP method for this route.
+     */
     httpMethod: HttpMethod;
+    /**
+     * The URL path pattern for this route (relative to controller base path).
+     */
     path: string;
+    /**
+     * The name of the method on the controller class.
+     */
     methodName: string;
+    /**
+     * Optional OpenAPI operation ID.
+     */
     operationId?: string;
+    /**
+     * Array of middleware names or functions to apply to this route.
+     */
     use?: Array<string | ExpressMw>;
+    /**
+     * Authentication configuration: "public" for open access, AuthMeta for protected.
+     */
     auth?: AuthMeta | "public";
 }
+/**
+ * Authentication metadata for a route.
+ *
+ * @public
+ */
 export interface AuthMeta {
+    /**
+     * The authentication scheme name (e.g., "BearerAuth", "ApiKeyAuth").
+     */
     scheme: string;
+    /**
+     * Required scopes for authorization. Empty array means any authenticated user.
+     */
     scopes?: string[];
+    /**
+     * Whether authentication is optional for this route.
+     */
     optional?: boolean;
 }
+/**
+ * Type alias for Express middleware functions.
+ *
+ * @public
+ */
 export type ExpressMw = (req: any, res: any, next: (err?: any) => void) => any;
+/**
+ * Container for all decorator metadata on a controller class.
+ *
+ * @remarks
+ * The AdornBucket is stored in class metadata and contains all route operations,
+ * controller-level middleware, and base path configuration.
+ *
+ * @public
+ */
 export interface AdornBucket {
+    /**
+     * Base path prefix for all routes in this controller.
+     */
     basePath?: string;
+    /**
+     * Middleware to apply to all routes in this controller.
+     */
     controllerUse?: Array<string | ExpressMw>;
+    /**
+     * Array of route operations defined on this controller.
+     */
     ops: RouteOperation[];
 }
 //# sourceMappingURL=types.d.ts.map

package/dist/runtime/metadata/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/runtime/metadata/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,UAAU,GAClB,KAAK,GACL,MAAM,GACN,KAAK,GACL,OAAO,GACP,QAAQ,GACR,SAAS,GACT,MAAM,CAAC;AAEX,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE,UAAU,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,GAAG,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAChC,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;CAC5B;AAED,MAAM,WAAW,QAAQ;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,MAAM,SAAS,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,IAAI,KAAK,GAAG,CAAC;AAE/E,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAC1C,GAAG,EAAE,cAAc,EAAE,CAAC;CACvB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/runtime/metadata/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAClB,KAAK,GACL,MAAM,GACN,KAAK,GACL,OAAO,GACP,QAAQ,GACR,SAAS,GACT,MAAM,CAAC;AAEX;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC;IAEvB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,GAAG,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAEhC;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;CAC5B;AAED;;;;GAIG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,IAAI,KAAK,GAAG,CAAC;AAE/E;;;;;;;;GAQG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAE1C;;OAEG;IACH,GAAG,EAAE,cAAc,EAAE,CAAC;CACvB"}

package/dist/runtime/polyfill.d.ts

@@ -1,2 +1,2 @@
-export declare const ADORN_POLYFILL: unique symbol;
+export {};
 //# sourceMappingURL=polyfill.d.ts.map

package/dist/runtime/polyfill.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"polyfill.d.ts","sourceRoot":"","sources":["../../src/runtime/polyfill.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,cAAc,eAA2B,CAAC"}
+{"version":3,"file":"polyfill.d.ts","sourceRoot":"","sources":["../../src/runtime/polyfill.ts"],"names":[],"mappings":""}

package/dist/runtime/upload.d.ts

@@ -1,7 +1,44 @@
+/**
+ * Represents an uploaded file in the request.
+ *
+ * @remarks
+ * This interface describes the structure of a file uploaded via multipart/form-data
+ * requests. It provides metadata about the file as well as access to its contents
+ * through a readable stream.
+ *
+ * @example
+ * ```typescript
+ * async function handleUpload(file: UploadFile) {
+ *   console.log(`Received file: ${file.filename}`);
+ *   console.log(`Type: ${file.mimeType}`);
+ *   console.log(`Size: ${file.size} bytes`);
+ *
+ *   // Process the file stream
+ *   for await (const chunk of file.stream) {
+ *     // Handle chunk...
+ *   }
+ * }
+ * ```
+ *
+ * @public
+ */
 export interface UploadFile {
+    /**
+     * The original filename as sent by the client.
+     */
     filename: string;
+    /**
+     * The MIME type of the file (e.g., "image/png", "application/pdf").
+     */
     mimeType: string;
+    /**
+     * The file size in bytes, if available.
+     */
     size?: number;
+    /**
+     * A Node.js readable stream to read the file contents.
+     * Use this to pipe, transform, or buffer the file data.
+     */
     stream: NodeJS.ReadableStream;
 }
 //# sourceMappingURL=upload.d.ts.map