sveltekit-superforms/dist/stringPath.d.ts

Making SvelteKit forms a pleasure to use!

import type { AllKeys, IsAny, MergeUnion } from './utils.js';
export declare function splitPath(path: string): string[];
export declare function mergePath(path: (string | number | symbol)[]): string;
type DictOrArray = Record<PropertyKey, unknown> | unknown[];
/**
 * Lists all paths in an object as string accessors.
 */
export type FormPath<T extends object, Type = any> = string & StringPath<T, {
    filter: 'all';
    objAppend: never;
    path: '';
    type: Type;
}>;
/**
 * List paths in an object as string accessors, but only with non-objects as accessible properties.
 * Similar to the leaves in a node tree, if you look at the object as a tree structure.
 */
export type FormPathLeaves<T extends object, Type = any> = string & StringPath<T, {
    filter: 'leaves';
    objAppend: never;
    path: '';
    type: Type;
}>;
/**
 * List paths in an object as string accessors, but only with non-objects as accessible properties.
 * Also includes the _errors field for objects and arrays.
 */
export type FormPathLeavesWithErrors<T extends object, Type = any> = string & StringPath<T, {
    filter: 'leaves';
    objAppend: '_errors';
    path: '';
    type: Type;
}>;
/**
 * List all arrays in an object as string accessors.
 */
export type FormPathArrays<T extends object, Type = any> = string & StringPath<T, {
    filter: 'arrays';
    objAppend: never;
    path: '';
    type: Type extends any[] ? Type : Type[];
}>;
type Concat<Path extends string, Next extends string> = `${Path}${Path extends '' ? '' : '.'}${Next}`;
type StringPathOptions = {
    filter: 'arrays' | 'leaves' | 'all';
    objAppend: string | never;
    path: string;
    type: any;
};
type If<Options extends StringPathOptions, Pred extends keyof Options, Subj, Then, Else, Value> = Options[Pred] extends Subj ? Options['type'] extends never ? Then : Value extends Options['type'] ? Then : never : Else;
type StringPath<T extends object, Options extends StringPathOptions = {
    filter: 'all';
    objAppend: never;
    path: '';
    type: never;
}> = T extends (infer U)[] ? If<Options, 'objAppend', string, Concat<Options['path'], Options['objAppend']>, never, T> | If<Options, 'filter', 'arrays' | 'all', Options['path'], never, T> | (NonNullable<U> extends DictOrArray ? StringPath<NonNullable<U>, {
    filter: Options['filter'];
    objAppend: Options['objAppend'];
    path: `${Options['path']}[${number}]`;
    type: Options['type'];
}> : If<Options, 'filter', 'leaves' | 'all', `${Options['path']}[${number}]`, never, T>) : {
    [K in Extract<AllKeys<T>, string>]: NonNullable<T[K]> extends DictOrArray ? If<Options, 'objAppend', string, Concat<Options['path'], Options['objAppend']>, never, T[K]> | NonNullable<T[K]> extends (infer U)[] ? If<Options, 'filter', 'arrays' | 'all', Concat<Options['path'], K>, never, T[K]> | (NonNullable<U> extends unknown[] ? If<Options, 'filter', 'arrays' | 'all', Concat<Options['path'], `${K}[${number}]`>, never, T[K]> : NonNullable<U> extends DictOrArray ? IsAny<T[K]> extends true ? Concat<Options['path'], `${K}[${number}]`> : If<Options, 'filter', 'all', Concat<Options['path'], `${K}[${number}]`>, never, U> : If<Options, 'filter', 'leaves' | 'all', Concat<Options['path'], `${K}[${number}]`>, never, U>) | (NonNullable<U> extends DictOrArray ? StringPath<NonNullable<U>, {
        filter: Options['filter'];
        objAppend: Options['objAppend'];
        path: Concat<Options['path'], `${K}[${number}]`>;
        type: Options['type'];
    }> : never) : IsAny<T[K]> extends true ? Concat<Options['path'], K> : If<Options, 'filter', 'all', Concat<Options['path'], K>, unknown extends T[K] ? Concat<Options['path'], K> : never, T[K]> | StringPath<NonNullable<T[K]>, {
        filter: Options['filter'];
        objAppend: Options['objAppend'];
        path: Concat<Options['path'], K>;
        type: Options['type'];
    }> : If<Options, 'filter', 'leaves' | 'all', Concat<Options['path'], K>, never, T[K]>;
}[Extract<AllKeys<T>, string>];
export type FormPathType<T, P extends string> = P extends keyof T ? T[P] : P extends number ? T : P extends `.${infer Rest}` ? FormPathType<NonNullable<T>, Rest> : P extends `${number}]${infer Rest}` ? NonNullable<T> extends (infer U)[] ? FormPathType<U, Rest> : {
    invalid_path1: P;
    Type: T;
} : P extends `${infer K}[${infer Rest}` ? K extends keyof NonNullable<T> ? FormPathType<NonNullable<T>[K], Rest> : FormPathType<T, Rest> : P extends `${infer K}.${infer Rest}` ? K extends keyof NonNullable<T> ? FormPathType<NonNullable<T>[K], Rest> : NonNullable<T> extends (infer U)[] ? FormPathType<U, Rest> : {
    invalid_path2: P;
    Type: T;
} : P extends `[${infer K}].${infer Rest}` ? K extends number ? T extends (infer U)[] ? FormPathType<U, Rest> : {
    invalid_path3: P;
    Type: T;
} : P extends `${number}` ? NonNullable<T> extends (infer U)[] ? U : {
    invalid_path4: P;
    Type: T;
} : P extends keyof NonNullable<T> ? NonNullable<T>[P] : P extends `${number}` ? NonNullable<T> extends (infer U)[] ? U : {
    invalid_path5: P;
    Type: T;
} : {
    invalid_path6: P;
    Type: T;
} : P extends '' ? T : P extends AllKeys<T> ? MergeUnion<T>[P] : {
    invalid_path7: P;
    Type: T;
};
export {};