@chronicstone/vue-route-query/dist/index.d.mts

Type-safe URL query parameter synchronization for Vue 3 with Zod validation

import { z } from 'zod';
import { Ref } from 'vue';

type Primitive = string | number | symbol;
type GenericObject = Record<Primitive, unknown>;
type SchemaInput = z.ZodTypeAny | {
    [key: string]: z.ZodTypeAny;
};
type InferSchemaType<T extends SchemaInput, Nullable extends boolean = false> = Nullable extends true ? T extends z.ZodTypeAny ? z.infer<T> | null : T extends {
    [key: string]: z.ZodTypeAny;
} ? {
    [K in keyof T]: z.infer<T[K]>;
} | null : never : T extends z.ZodTypeAny ? z.infer<T> : T extends {
    [key: string]: z.ZodTypeAny;
} ? {
    [K in keyof T]: z.infer<T[K]>;
} : never;
type RouteQueryConfig<Schema extends SchemaInput, Nullable extends boolean = false> = {
    schema: Schema;
    default: Nullable extends true ? NonNullable<InferSchemaType<Schema, false>> | null : NonNullable<InferSchemaType<Schema, false>>;
    nullable?: Nullable;
    enabled?: boolean;
    debug?: boolean;
    mode?: "push" | "replace";
} & (Schema extends z.ZodTypeAny ? {
    key: string;
} : {
    key?: string;
});
type ZodDeepPartial<T extends z.ZodTypeAny> = T extends z.ZodObject<z.ZodRawShape> ? z.ZodObject<{
    [k in keyof T["shape"]]: z.ZodOptional<ZodDeepPartial<T["shape"][k]>>;
}, T["_def"]["unknownKeys"], T["_def"]["catchall"]> : T extends z.ZodArray<infer Type, infer Card> ? z.ZodArray<ZodDeepPartial<Type>, Card> : T extends z.ZodOptional<infer Type> ? z.ZodOptional<ZodDeepPartial<Type>> : T extends z.ZodNullable<infer Type> ? z.ZodNullable<ZodDeepPartial<Type>> : T extends z.ZodTuple<infer Items> ? {
    [k in keyof Items]: Items[k] extends z.ZodTypeAny ? ZodDeepPartial<Items[k]> : never;
} extends infer PI ? PI extends z.ZodTupleItems ? z.ZodTuple<PI> : never : never : T;

/**
 * Vue composable for syncing component state with URL query parameters
 */
declare function useRouteQuery<Schema extends SchemaInput, Nullable extends boolean = false>(params: RouteQueryConfig<Schema, Nullable>): Ref<InferSchemaType<Schema, Nullable>>;

export { useRouteQuery };
export type { GenericObject, InferSchemaType, Primitive, RouteQueryConfig, SchemaInput, ZodDeepPartial };