@clipboard-health/json-api-nestjs/src/lib/query/filterQuery.js

TypeScript-friendly utilities for adhering to the JSON:API specification with NestJS.

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.filterQuery = filterQuery;
const zod_1 = require("zod");
const queryFilterPreprocessor_1 = require("../internal/queryFilterPreprocessor");
const splitString_1 = require("../internal/splitString");
/**
 * Creates a Zod schema for JSON:API filters.
 *
 * @example
 * <embedex source="packages/example-nestjs/examples/query.ts">
 *
 * ```ts
 * import { booleanString } from "@clipboard-health/contract-core";
 * import {
 *   cursorPaginationQuery,
 *   fieldsQuery,
 *   type FilterMap,
 *   filterQuery,
 *   includeQuery,
 *   sortQuery,
 * } from "@clipboard-health/json-api-nestjs";
 * import { z } from "zod";
 *
 * import {
 *   type ArticleAttributeFields,
 *   type UserAttributeFields,
 *   type UserIncludeFields,
 * } from "../src/contract";
 *
 * const articleFields = ["title"] as const satisfies readonly ArticleAttributeFields[];
 * const userFields = ["age", "dateOfBirth"] as const satisfies readonly UserAttributeFields[];
 * const userIncludeFields = [
 *   "articles",
 *   "articles.comments",
 * ] as const satisfies readonly UserIncludeFields[];
 * const userFilterMap = {
 *   age: {
 *     filters: ["eq", "gt"],
 *     schema: z.coerce.number().int().positive().max(125),
 *   },
 *   dateOfBirth: {
 *     filters: ["gte"],
 *     schema: z.coerce.date().min(new Date("1900-01-01")).max(new Date()),
 *   },
 *   isActive: {
 *     filters: ["eq"],
 *     schema: booleanString,
 *   },
 * } as const satisfies FilterMap<UserAttributeFields>;
 *
 * /**
 *  * Disclaimer: Just because JSON:API supports robust querying doesn’t mean your service should
 *  * implement them as they may require database indexes, which have a cost. **Implement only access
 *  * patterns required by clients.**
 *  *
 *  * The spec says that if clients provide fields the server doesn’t support, it **MUST** return 400
 *  * Bad Request, hence the `.strict()`.
 *  *\/
 * export const query = z
 *   .object({
 *     ...cursorPaginationQuery(),
 *     ...fieldsQuery({ article: articleFields, user: userFields }),
 *     ...filterQuery(userFilterMap),
 *     ...sortQuery(userFields),
 *     ...includeQuery(userIncludeFields),
 *   })
 *   .strict();
 * ```
 *
 * </embedex>
 *
 * @see {@link https://jsonapi.org/recommendations/#filtering JSON:API filtering}
 * @see {@link https://discuss.jsonapi.org/t/share-propose-a-filtering-strategy/257 JSON:API filtering strategy}
 */
function filterQuery(parameters) {
    return {
        filter: zod_1.z
            .object(Object.fromEntries(Object.entries(parameters).map(([apiType, value]) => [
            apiType,
            zod_1.z.preprocess(queryFilterPreprocessor_1.queryFilterPreprocessor, filterSchema(value)).optional(),
        ])))
            .strict()
            .optional(),
    };
}
function filterSchema(parameters) {
    const { filters, schema } = parameters;
    return zod_1.z
        .object(Object.fromEntries(filters.map((filter) => [
        filter,
        zod_1.z.preprocess(splitString_1.splitString, schema.array().min(1).max(10_000).optional()).optional(),
    ])))
        .strict()
        .optional();
}
//# sourceMappingURL=filterQuery.js.map