import { Arr, asUint32, memoizeFunction, Result } from 'ts-data-forge'; import { type MaxLengthArray, type SupportedLength } from 'ts-type-forge'; import { type Type } from '../type.mjs'; import { createPrimitiveValidationError, type ValidationError, } from '../utils/index.mjs'; import { buildType, validateElements } from './build-type.mjs'; export type { MaxLengthArray } from 'ts-type-forge'; /** * Creates a `Type` for a readonly array with at most `maxLength` elements, * typed as the branded {@link MaxLengthArray} instead of the union of tuple * types produced by `maxLengthTuple`. * * Because the length constraint lives only in the brand, no union of tuples * of the element type is ever constructed, which keeps type-checking cheap * even when `A` is a large type. */ export function maxLengthArray( maxLength: N, elementType: Type, options?: Partial< Readonly<{ typeName: string; defaultValue: MaxLengthArray; }> >, ): Type>; // For bounds outside `SupportedLength` (`0..2048`) the length cannot be encoded in the brand, // so the result length is left unconstrained (`readonly A[]`). export function maxLengthArray( maxLength: number, elementType: Type, options?: Partial< Readonly<{ typeName: string; defaultValue: readonly A[]; }> >, ): Type; export function maxLengthArray( maxLength: number, elementType: Type, options?: Partial< Readonly<{ typeName: string; defaultValue: readonly A[]; }> >, ): Type { type T = readonly A[]; const typeName = options?.typeName ?? `MaxLengthArray<${maxLength}, ${elementType.typeName}>`; const getDefaultValue = memoizeFunction( (): T => options?.defaultValue ?? // The empty array is the shortest value satisfying `length <= maxLength`. Arr.create(0, elementType.defaultValue), ); const validate: Type['validate'] = (a) => { if (!Arr.isArray(a)) { return Result.err([ createPrimitiveValidationError({ actualValue: a, expectedType: 'array', typeName, details: undefined, }), ]); } if (a.length > maxLength) { return Result.err([ { path: [], actualValue: a, expectedType: typeName, typeName, details: { kind: 'array-max-length', maxLength, actualLength: a.length, }, } satisfies ValidationError, ]); } return validateElements(a, elementType); }; const fill: Type['fill'] = (a) => Arr.isArray(a) ? // Keep the input but trim down to at most `maxLength` elements. Arr.map( Arr.take(a, asUint32(maxLength)), (el) => elementType.fill(el) satisfies A, ) : getDefaultValue(); return buildType({ typeName, getDefaultValue, validate, fill, elementType }); }