Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions src/modules/creators/creators.include.parse.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
import { strict as assert } from 'assert';
import { CreatorListQuerySchema } from './creators.schemas';
import { parsePublicQuery } from '../../utils/public-query-parse.utils';

function run() {
const parsed = CreatorListQuerySchema.parse({
limit: '10',
offset: '0',
include: 'stats',
});

assert.deepEqual(parsed.include, ['stats']);

const invalid = parsePublicQuery(CreatorListQuerySchema, {
limit: '10',
offset: '0',
include: 'unknown',
});

assert.equal(invalid.ok, false);
if (invalid.ok) {
throw new Error('Expected invalid include value to fail validation');
}

assert.deepEqual(invalid.details, [
{
field: 'include.0',
message: "Invalid enum value. Expected 'stats', received 'unknown'",
},
]);

console.log('creators.include.parse tests passed');
}

run();
36 changes: 36 additions & 0 deletions src/modules/creators/creators.include.parse.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
import { z } from 'zod';
import { normalizeCreatorListQueryStringValue } from './creators.query-string.utils';

export const CREATOR_LIST_INCLUDE_VALUES = ['stats'] as const;

export type CreatorListIncludeValue =
(typeof CREATOR_LIST_INCLUDE_VALUES)[number];

const creatorListIncludeValueEnum = z.enum(CREATOR_LIST_INCLUDE_VALUES);

function normalizeCreatorListIncludeValue(value: unknown): unknown {
if (Array.isArray(value)) {
return value.map(item => normalizeCreatorListQueryStringValue(item));
}

const normalized = normalizeCreatorListQueryStringValue(value);
if (typeof normalized !== 'string') {
return normalized;
}

return normalized.split(',').map(part => part.trim());
}

/**
* Zod schema for the creator list `include` query parameter.
*
* - Supports comma-separated include values such as `stats`.
* - Rejects unsupported include values through normal schema validation.
* - Can be reused anywhere creator list query params are parsed.
*/
export function creatorListIncludeQueryParam() {
return z.preprocess(
normalizeCreatorListIncludeValue,
z.array(creatorListIncludeValueEnum).optional()
);
}
2 changes: 2 additions & 0 deletions src/modules/creators/creators.schemas.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { z } from 'zod';
import { creatorListSortDirectionQueryParam } from './creators.sort-direction.parse';
import { creatorListIncludeQueryParam } from './creators.include.parse';
import { withCreatorListQueryStringNormalization } from './creators.query-string.utils';
import { safeIntParam } from '../../utils/query.utils';
import {
Expand Down Expand Up @@ -41,6 +42,7 @@ export const CreatorListQuerySchema = z.object({
z.enum(CREATOR_LIST_SORT_FIELDS).optional().default(DEFAULT_CREATOR_LIST_SORT)
),
order: creatorListSortDirectionQueryParam(),
include: creatorListIncludeQueryParam(),

// Filters
verified: withCreatorListQueryStringNormalization(
Expand Down
Loading