@solid-nestjs/rest-api
Version:
solid-nestjs Rest-API utilities
116 lines • 5.99 kB
JavaScript
;
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
return c > 3 && r && Object.defineProperty(target, key, r), r;
};
var __metadata = (this && this.__metadata) || function (k, v) {
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.ORDER_BY_CLASS_KEY = exports.WHERE_CLASS_KEY = void 0;
exports.FindArgsFrom = FindArgsFrom;
exports.getWhereClass = getWhereClass;
exports.getOrderByClass = getOrderByClass;
const class_validator_1 = require("class-validator");
const class_transformer_1 = require("class-transformer");
const common_1 = require("@nestjs/common");
const swagger_1 = require("@nestjs/swagger");
const inputs_1 = require("../classes/inputs");
exports.WHERE_CLASS_KEY = 'WhereClass';
exports.ORDER_BY_CLASS_KEY = 'OrderByClass';
/**
* Generates a dynamic argument class for querying entities with optional pagination, filtering (where), and sorting (order by) capabilities.
*
* This mixin function creates a class based on the provided structure, supporting:
* - Pagination via a `pagination` property.
* - Filtering via a `where` property, supporting logical `_and` and `_or` operators.
* - Sorting via an `orderBy` property.
*
* The generated class is decorated for use with NestJS, class-validator, and Swagger/OpenAPI.
*
* @typeParam EntityType - The entity type being queried.
* @typeParam WhereType - The type used for filtering (where clause). Defaults to `Where<EntityType>`.
* @typeParam OrderByType - The type used for sorting (order by clause). Defaults to `OrderBy<EntityType>`.
* @param findArgsStructure - Optional structure specifying the types for where and orderBy clauses.
* @returns A dynamically generated class implementing `FindArgs<EntityType>`, decorated for validation and API documentation.
*/
function FindArgsFrom(findArgsStructure) {
const { whereType, orderByType } = findArgsStructure ?? {};
class ArgsClass {
}
__decorate([
(0, swagger_1.ApiProperty)({ type: () => inputs_1.PaginationRequest, required: false }),
(0, class_transformer_1.Type)(() => inputs_1.PaginationRequest),
(0, class_validator_1.IsOptional)(),
(0, class_validator_1.ValidateNested)(),
__metadata("design:type", inputs_1.PaginationRequest)
], ArgsClass.prototype, "pagination", void 0);
let returnedClass = ArgsClass;
if (whereType) {
let WhereClass = class WhereClass extends (0, swagger_1.PartialType)(whereType) {
};
__decorate([
(0, swagger_1.ApiProperty)({ type: () => [whereType], required: false, example: [] }),
(0, class_validator_1.IsArray)(),
(0, class_transformer_1.Type)(() => WhereClass),
(0, class_validator_1.IsOptional)(),
(0, class_validator_1.ValidateNested)(),
__metadata("design:type", Array)
], WhereClass.prototype, "_and", void 0);
__decorate([
(0, swagger_1.ApiProperty)({ type: () => [whereType], required: false, example: [] }),
(0, class_validator_1.IsArray)(),
(0, class_transformer_1.Type)(() => WhereClass),
(0, class_validator_1.IsOptional)(),
(0, class_validator_1.ValidateNested)(),
__metadata("design:type", Array)
], WhereClass.prototype, "_or", void 0);
WhereClass = __decorate([
(0, swagger_1.ApiSchema)({ name: whereType.name })
], WhereClass);
let ArgsClassWithWhere = class ArgsClassWithWhere extends returnedClass {
};
__decorate([
(0, swagger_1.ApiProperty)({ type: () => WhereClass, required: false }),
(0, class_transformer_1.Type)(() => WhereClass),
(0, class_validator_1.IsOptional)(),
(0, class_validator_1.ValidateNested)(),
__metadata("design:type", WhereClass)
], ArgsClassWithWhere.prototype, "where", void 0);
ArgsClassWithWhere = __decorate([
(0, common_1.SetMetadata)(exports.WHERE_CLASS_KEY, WhereClass)
], ArgsClassWithWhere);
returnedClass = ArgsClassWithWhere;
}
if (orderByType) {
let OrderByClass = class OrderByClass extends (0, swagger_1.PartialType)(orderByType) {
};
OrderByClass = __decorate([
(0, swagger_1.ApiSchema)({ name: orderByType.name })
], OrderByClass);
let ArgsClassWithOrderBy = class ArgsClassWithOrderBy extends returnedClass {
};
__decorate([
(0, swagger_1.ApiProperty)({ type: () => [OrderByClass], required: false }),
(0, class_validator_1.IsArray)(),
(0, class_transformer_1.Type)(() => OrderByClass),
(0, class_validator_1.IsOptional)(),
(0, class_validator_1.ValidateNested)(),
__metadata("design:type", Array)
], ArgsClassWithOrderBy.prototype, "orderBy", void 0);
ArgsClassWithOrderBy = __decorate([
(0, common_1.SetMetadata)(exports.ORDER_BY_CLASS_KEY, OrderByClass)
], ArgsClassWithOrderBy);
returnedClass = ArgsClassWithOrderBy;
}
return (0, common_1.mixin)(returnedClass);
}
function getWhereClass(findArgsType) {
return Reflect.getMetadata(exports.WHERE_CLASS_KEY, findArgsType);
}
function getOrderByClass(findArgsType) {
return Reflect.getMetadata(exports.ORDER_BY_CLASS_KEY, findArgsType);
}
//# sourceMappingURL=find-args.mixin.js.map