@prezly/theme-kit-core/build/routing/UrlGenerator.d.ts

Data layer and utility library for developing Prezly themes with JavaScript

import type { Route } from './Route';
import type { Router } from './Router';
type WithLocaleCode<T> = T extends {
    localeSlug: string;
} ? Omit<T, 'localeSlug'> & {
    localeCode: string;
} : T extends {
    localeSlug?: string;
} ? Omit<T, 'localeSlug'> & {
    localeCode?: string;
} : T;
/**
 * Construct a type based on `Router.generate()`, but:
 * - required `localeSlug` can be replaced with required `localeCode`
 * - optional `localeSlug` can be replaced with optional `localeCode`
 */
export type UrlGenerator<T> = T extends Router<infer Routes> ? <RouteName extends keyof Routes>(routeName: RouteName, ...params: Routes[RouteName] extends Route<string, infer Match> ? {} extends Match ? [WithLocaleCode<Match>] | [Match] | [] : [WithLocaleCode<Match>] | [Match] : never) => `/${string}` : never;
export declare namespace UrlGenerator {
    /**
     * Construct a type based on `Router.generate()`, but:
     * - expected to generate absolute URLs instead of relative ones
     * - required `localeSlug` can be replaced with required `localeCode`
     * - optional `localeSlug` can be replaced with optional `localeCode`
     *
     * This is the same as UrlGenerator<T>, but for absolute URLs.
     * @see UrlGenerator.
     */
    type Absolute<T> = T extends Router<infer Routes> ? <RouteName extends keyof Routes>(routeName: RouteName, ...params: Routes[RouteName] extends Route<string, infer Match> ? {} extends Match ? [WithLocaleCode<Match>] | [Match] | [] : [WithLocaleCode<Match>] | [Match] : never) => `http://${string}` | `https://${string}` : never;
    type Params<T> = T extends Router<infer Routes> ? {
        [RouteName in keyof Routes]: Routes[RouteName] extends Route<string, infer Match> ? {} extends Match ? {
            routeName: RouteName;
            params?: WithLocaleCode<Match> | Match;
        } : {
            routeName: RouteName;
            params: WithLocaleCode<Match> | Match;
        } : never;
    }[keyof Routes] : never;
}
export {};