@inploi/plugin-job-search 9.0.0 → 9.0.2

package/dist/index.d.cts

@@ -0,0 +1,977 @@
+import type { AnalyticsService } from '@inploi/sdk' with { 'resolution-mode': 'import' };
+import type { ApiClient } from '@inploi/sdk' with { 'resolution-mode': 'import' };
+import type { FeedbackPlugin } from '@inploi/plugin-feedback' with { 'resolution-mode': 'import' };
+import type { feedbackPlugin } from '@inploi/plugin-feedback' with { 'resolution-mode': 'import' };
+import type { FeedbackPluginParams } from '@inploi/plugin-feedback' with { 'resolution-mode': 'import' };
+import type { InploiRpcClient } from '@inploi/sdk' with { 'resolution-mode': 'import' };
+import type { InploiSdkEnvironment } from '@inploi/sdk' with { 'resolution-mode': 'import' };
+import type { jobAlertsPlugin } from '@inploi/plugin-job-alerts' with { 'resolution-mode': 'import' };
+import type { JobAlertsPluginParams } from '@inploi/plugin-job-alerts' with { 'resolution-mode': 'import' };
+import type { Logger } from '@inploi/sdk' with { 'resolution-mode': 'import' };
+
+declare type ColorPaletteConfig = {
+    /** Number between 0 and 360. Number above or below range will loop. */
+    hue: number;
+    /** Float between 0 and 2. Acts as a multiplier to the original generated palette. */
+    chroma: number;
+};
+
+export declare const createJobSearchDomManager: (logger: Logger) => {
+    getRenderTargetElement: (widgetId: string | undefined) => Element;
+};
+
+declare const createTFunction: <T extends {
+    readonly type_to_search_jobs: "Type to search jobs";
+    readonly type_to_search: "Type to search";
+    readonly jobs_found: {
+        readonly one: "{{count}} job found";
+        readonly other: "{{count}} jobs found";
+    };
+    readonly no_jobs_found: "No jobs found";
+    readonly no_jobs_found_description: "We could not find any jobs matching your filtering criteria.";
+    readonly jobs_loading_error: "We’re having trouble loading available jobs.";
+    readonly filters_loading_error: "We’re having trouble loading available filters.";
+    readonly no_filter_options_available: "No filter options available.";
+    readonly clear: "Clear";
+    readonly selected: "selected";
+    readonly done: "Done";
+    readonly close: "Close";
+    readonly new: "NEW";
+    readonly posted: "Posted";
+    readonly distance_away: "{{distance}} away";
+    readonly retry: "Retry";
+    readonly widget_unavailable: "Sorry, this widget is unavailable at the moment.";
+    readonly load_more_count: "Load {{count}} more";
+    readonly of_remaining_count: "of {{count}} remaining";
+    readonly today: "today";
+    readonly over_30_days_ago: "over 30 days ago";
+    readonly in_over_30_days: "in over 30 days";
+    readonly up_to: "Up to";
+    readonly from: "From";
+    readonly invalid_salary: "Invalid salary";
+    readonly competitive: "Competitive";
+    readonly natural_language_input: "Type anything";
+    readonly great_match: "Great match";
+    readonly advanced_mode: "Filters";
+    readonly simple_mode: "Hide filters";
+    readonly ai_disclaimer: "Results may not be perfect. AI-powered search can occasionally suggest unrelated content.";
+    readonly geo_error_timeout: "Timed out. Please type your location manually.";
+    readonly geo_error_permission_denied: "Please allow location access to use this feature.";
+    readonly geo_error_position_unavailable: "Could not locate you. Please type your location manually.";
+    readonly geo_my_location: "My location";
+    readonly geo_locating: "Locating you...";
+    readonly geo_search_placeholder: "Search for a location";
+    readonly geo_clear_search: "Clear location search";
+    readonly location_provided: "Provided location";
+    readonly search_label: "What";
+    readonly geo_label: "Where";
+    readonly geo_range_label: "Within";
+    readonly geo_suggestions_error: "Could not get the suggested locations.";
+    readonly geo_no_match: "We couldn’t find that place. Try a town, city or postcode.";
+    readonly geo_query_too_short: "Type at least 3 letters of a town, city or postcode.";
+    readonly geo_choose_location: "Press Enter or choose a suggestion to search near this place.";
+    readonly geo_any_distance: "Any distance";
+    readonly feedback: "How was your search experience?";
+    readonly list: "List";
+    readonly map: "Map";
+    readonly map_gesture_windows: "Use Ctrl + scroll to zoom the map";
+    readonly map_gesture_mac: "Use ⌘ + scroll to zoom the map";
+    readonly map_gesture_mobile: "Use two fingers to move the map";
+    readonly map_unavailable: "Map unavailable";
+    readonly loading_jobs: "Loading jobs…";
+    readonly map_jobs_error: "We’re having trouble loading jobs in the area";
+    readonly map_has_more_title: "Not showing all the jobs in this area";
+    readonly map_has_more_description: "Zoom in to refine your search further";
+    readonly map_jobs_showing: {
+        readonly one: "Showing {{count}} job";
+        readonly other: "Showing {{count}} jobs";
+    };
+    readonly page: "Page";
+    readonly reset: "Reset";
+    readonly sort_by: "Sort by";
+    readonly sort_most_relevant: "Most relevant";
+    readonly sort_closest: "Closest";
+    readonly sort_newest: "Newest";
+    readonly 'job.employment_type.FULL_TIME': "Full-time";
+    readonly 'job.employment_type.PART_TIME': "Part-time";
+    readonly 'job.employment_type.CONTRACT': "Contractor";
+    readonly 'job.employment_type.TEMPORARY': "Temporary";
+    readonly 'job.employment_type.INTERN': "Internship";
+    readonly 'job.employment_type.VOLUNTEER': "Volunteer";
+    readonly 'job.employment_type.OTHER': "Other";
+    readonly 'job.location_type.LOCATION': "On-site";
+    readonly 'job.location_type.REMOTE': "Remote";
+    readonly 'job.location_type.HYBRID': "Hybrid";
+} = {
+    readonly type_to_search_jobs: "Type to search jobs";
+    readonly type_to_search: "Type to search";
+    readonly jobs_found: {
+        readonly one: "{{count}} job found";
+        readonly other: "{{count}} jobs found";
+    };
+    readonly no_jobs_found: "No jobs found";
+    readonly no_jobs_found_description: "We could not find any jobs matching your filtering criteria.";
+    readonly jobs_loading_error: "We’re having trouble loading available jobs.";
+    readonly filters_loading_error: "We’re having trouble loading available filters.";
+    readonly no_filter_options_available: "No filter options available.";
+    readonly clear: "Clear";
+    readonly selected: "selected";
+    readonly done: "Done";
+    readonly close: "Close";
+    readonly new: "NEW";
+    readonly posted: "Posted";
+    readonly distance_away: "{{distance}} away";
+    readonly retry: "Retry";
+    readonly widget_unavailable: "Sorry, this widget is unavailable at the moment.";
+    readonly load_more_count: "Load {{count}} more";
+    readonly of_remaining_count: "of {{count}} remaining";
+    readonly today: "today";
+    readonly over_30_days_ago: "over 30 days ago";
+    readonly in_over_30_days: "in over 30 days";
+    readonly up_to: "Up to";
+    readonly from: "From";
+    readonly invalid_salary: "Invalid salary";
+    readonly competitive: "Competitive";
+    readonly natural_language_input: "Type anything";
+    readonly great_match: "Great match";
+    readonly advanced_mode: "Filters";
+    readonly simple_mode: "Hide filters";
+    readonly ai_disclaimer: "Results may not be perfect. AI-powered search can occasionally suggest unrelated content.";
+    readonly geo_error_timeout: "Timed out. Please type your location manually.";
+    readonly geo_error_permission_denied: "Please allow location access to use this feature.";
+    readonly geo_error_position_unavailable: "Could not locate you. Please type your location manually.";
+    readonly geo_my_location: "My location";
+    readonly geo_locating: "Locating you...";
+    readonly geo_search_placeholder: "Search for a location";
+    readonly geo_clear_search: "Clear location search";
+    readonly location_provided: "Provided location";
+    readonly search_label: "What";
+    readonly geo_label: "Where";
+    readonly geo_range_label: "Within";
+    readonly geo_suggestions_error: "Could not get the suggested locations.";
+    readonly geo_no_match: "We couldn’t find that place. Try a town, city or postcode.";
+    readonly geo_query_too_short: "Type at least 3 letters of a town, city or postcode.";
+    readonly geo_choose_location: "Press Enter or choose a suggestion to search near this place.";
+    readonly geo_any_distance: "Any distance";
+    readonly feedback: "How was your search experience?";
+    readonly list: "List";
+    readonly map: "Map";
+    readonly map_gesture_windows: "Use Ctrl + scroll to zoom the map";
+    readonly map_gesture_mac: "Use ⌘ + scroll to zoom the map";
+    readonly map_gesture_mobile: "Use two fingers to move the map";
+    readonly map_unavailable: "Map unavailable";
+    readonly loading_jobs: "Loading jobs…";
+    readonly map_jobs_error: "We’re having trouble loading jobs in the area";
+    readonly map_has_more_title: "Not showing all the jobs in this area";
+    readonly map_has_more_description: "Zoom in to refine your search further";
+    readonly map_jobs_showing: {
+        readonly one: "Showing {{count}} job";
+        readonly other: "Showing {{count}} jobs";
+    };
+    readonly page: "Page";
+    readonly reset: "Reset";
+    readonly sort_by: "Sort by";
+    readonly sort_most_relevant: "Most relevant";
+    readonly sort_closest: "Closest";
+    readonly sort_newest: "Newest";
+    readonly 'job.employment_type.FULL_TIME': "Full-time";
+    readonly 'job.employment_type.PART_TIME': "Part-time";
+    readonly 'job.employment_type.CONTRACT': "Contractor";
+    readonly 'job.employment_type.TEMPORARY': "Temporary";
+    readonly 'job.employment_type.INTERN': "Internship";
+    readonly 'job.employment_type.VOLUNTEER': "Volunteer";
+    readonly 'job.employment_type.OTHER': "Other";
+    readonly 'job.location_type.LOCATION': "On-site";
+    readonly 'job.location_type.REMOTE': "Remote";
+    readonly 'job.location_type.HYBRID': "Hybrid";
+}>(options: {
+    overrides: Partial<TranslationDict<    {
+    readonly type_to_search_jobs: "Type to search jobs";
+    readonly type_to_search: "Type to search";
+    readonly jobs_found: {
+    readonly one: "{{count}} job found";
+    readonly other: "{{count}} jobs found";
+    };
+    readonly no_jobs_found: "No jobs found";
+    readonly no_jobs_found_description: "We could not find any jobs matching your filtering criteria.";
+    readonly jobs_loading_error: "We’re having trouble loading available jobs.";
+    readonly filters_loading_error: "We’re having trouble loading available filters.";
+    readonly no_filter_options_available: "No filter options available.";
+    readonly clear: "Clear";
+    readonly selected: "selected";
+    readonly done: "Done";
+    readonly close: "Close";
+    readonly new: "NEW";
+    readonly posted: "Posted";
+    readonly distance_away: "{{distance}} away";
+    readonly retry: "Retry";
+    readonly widget_unavailable: "Sorry, this widget is unavailable at the moment.";
+    readonly load_more_count: "Load {{count}} more";
+    readonly of_remaining_count: "of {{count}} remaining";
+    readonly today: "today";
+    readonly over_30_days_ago: "over 30 days ago";
+    readonly in_over_30_days: "in over 30 days";
+    readonly up_to: "Up to";
+    readonly from: "From";
+    readonly invalid_salary: "Invalid salary";
+    readonly competitive: "Competitive";
+    readonly natural_language_input: "Type anything";
+    readonly great_match: "Great match";
+    readonly advanced_mode: "Filters";
+    readonly simple_mode: "Hide filters";
+    readonly ai_disclaimer: "Results may not be perfect. AI-powered search can occasionally suggest unrelated content.";
+    readonly geo_error_timeout: "Timed out. Please type your location manually.";
+    readonly geo_error_permission_denied: "Please allow location access to use this feature.";
+    readonly geo_error_position_unavailable: "Could not locate you. Please type your location manually.";
+    readonly geo_my_location: "My location";
+    readonly geo_locating: "Locating you...";
+    readonly geo_search_placeholder: "Search for a location";
+    readonly geo_clear_search: "Clear location search";
+    readonly location_provided: "Provided location";
+    readonly search_label: "What";
+    readonly geo_label: "Where";
+    readonly geo_range_label: "Within";
+    readonly geo_suggestions_error: "Could not get the suggested locations.";
+    readonly geo_no_match: "We couldn’t find that place. Try a town, city or postcode.";
+    readonly geo_query_too_short: "Type at least 3 letters of a town, city or postcode.";
+    readonly geo_choose_location: "Press Enter or choose a suggestion to search near this place.";
+    readonly geo_any_distance: "Any distance";
+    readonly feedback: "How was your search experience?";
+    readonly list: "List";
+    readonly map: "Map";
+    readonly map_gesture_windows: "Use Ctrl + scroll to zoom the map";
+    readonly map_gesture_mac: "Use ⌘ + scroll to zoom the map";
+    readonly map_gesture_mobile: "Use two fingers to move the map";
+    readonly map_unavailable: "Map unavailable";
+    readonly loading_jobs: "Loading jobs…";
+    readonly map_jobs_error: "We’re having trouble loading jobs in the area";
+    readonly map_has_more_title: "Not showing all the jobs in this area";
+    readonly map_has_more_description: "Zoom in to refine your search further";
+    readonly map_jobs_showing: {
+    readonly one: "Showing {{count}} job";
+    readonly other: "Showing {{count}} jobs";
+    };
+    readonly page: "Page";
+    readonly reset: "Reset";
+    readonly sort_by: "Sort by";
+    readonly sort_most_relevant: "Most relevant";
+    readonly sort_closest: "Closest";
+    readonly sort_newest: "Newest";
+    readonly 'job.employment_type.FULL_TIME': "Full-time";
+    readonly 'job.employment_type.PART_TIME': "Part-time";
+    readonly 'job.employment_type.CONTRACT': "Contractor";
+    readonly 'job.employment_type.TEMPORARY': "Temporary";
+    readonly 'job.employment_type.INTERN': "Internship";
+    readonly 'job.employment_type.VOLUNTEER': "Volunteer";
+    readonly 'job.employment_type.OTHER': "Other";
+    readonly 'job.location_type.LOCATION': "On-site";
+    readonly 'job.location_type.REMOTE': "Remote";
+    readonly 'job.location_type.HYBRID': "Hybrid";
+    }>>;
+    locale: string | undefined;
+}) => TFn<T>;
+
+export declare type CustomDataKey = `custom_data.${string}`;
+
+export declare const defaultTerms: {
+    readonly type_to_search_jobs: "Type to search jobs";
+    readonly type_to_search: "Type to search";
+    readonly jobs_found: {
+        readonly one: "{{count}} job found";
+        readonly other: "{{count}} jobs found";
+    };
+    readonly no_jobs_found: "No jobs found";
+    readonly no_jobs_found_description: "We could not find any jobs matching your filtering criteria.";
+    readonly jobs_loading_error: "We’re having trouble loading available jobs.";
+    readonly filters_loading_error: "We’re having trouble loading available filters.";
+    readonly no_filter_options_available: "No filter options available.";
+    readonly clear: "Clear";
+    readonly selected: "selected";
+    readonly done: "Done";
+    readonly close: "Close";
+    readonly new: "NEW";
+    readonly posted: "Posted";
+    readonly distance_away: "{{distance}} away";
+    readonly retry: "Retry";
+    readonly widget_unavailable: "Sorry, this widget is unavailable at the moment.";
+    readonly load_more_count: "Load {{count}} more";
+    readonly of_remaining_count: "of {{count}} remaining";
+    readonly today: "today";
+    readonly over_30_days_ago: "over 30 days ago";
+    readonly in_over_30_days: "in over 30 days";
+    readonly up_to: "Up to";
+    readonly from: "From";
+    readonly invalid_salary: "Invalid salary";
+    readonly competitive: "Competitive";
+    readonly natural_language_input: "Type anything";
+    readonly great_match: "Great match";
+    readonly advanced_mode: "Filters";
+    readonly simple_mode: "Hide filters";
+    readonly ai_disclaimer: "Results may not be perfect. AI-powered search can occasionally suggest unrelated content.";
+    readonly geo_error_timeout: "Timed out. Please type your location manually.";
+    readonly geo_error_permission_denied: "Please allow location access to use this feature.";
+    readonly geo_error_position_unavailable: "Could not locate you. Please type your location manually.";
+    readonly geo_my_location: "My location";
+    readonly geo_locating: "Locating you...";
+    readonly geo_search_placeholder: "Search for a location";
+    readonly geo_clear_search: "Clear location search";
+    readonly location_provided: "Provided location";
+    readonly search_label: "What";
+    readonly geo_label: "Where";
+    readonly geo_range_label: "Within";
+    readonly geo_suggestions_error: "Could not get the suggested locations.";
+    readonly geo_no_match: "We couldn’t find that place. Try a town, city or postcode.";
+    readonly geo_query_too_short: "Type at least 3 letters of a town, city or postcode.";
+    readonly geo_choose_location: "Press Enter or choose a suggestion to search near this place.";
+    readonly geo_any_distance: "Any distance";
+    readonly feedback: "How was your search experience?";
+    readonly list: "List";
+    readonly map: "Map";
+    readonly map_gesture_windows: "Use Ctrl + scroll to zoom the map";
+    readonly map_gesture_mac: "Use ⌘ + scroll to zoom the map";
+    readonly map_gesture_mobile: "Use two fingers to move the map";
+    readonly map_unavailable: "Map unavailable";
+    readonly loading_jobs: "Loading jobs…";
+    readonly map_jobs_error: "We’re having trouble loading jobs in the area";
+    readonly map_has_more_title: "Not showing all the jobs in this area";
+    readonly map_has_more_description: "Zoom in to refine your search further";
+    readonly map_jobs_showing: {
+        readonly one: "Showing {{count}} job";
+        readonly other: "Showing {{count}} jobs";
+    };
+    readonly page: "Page";
+    readonly reset: "Reset";
+    readonly sort_by: "Sort by";
+    readonly sort_most_relevant: "Most relevant";
+    readonly sort_closest: "Closest";
+    readonly sort_newest: "Newest";
+    readonly 'job.employment_type.FULL_TIME': "Full-time";
+    readonly 'job.employment_type.PART_TIME': "Part-time";
+    readonly 'job.employment_type.CONTRACT': "Contractor";
+    readonly 'job.employment_type.TEMPORARY': "Temporary";
+    readonly 'job.employment_type.INTERN': "Internship";
+    readonly 'job.employment_type.VOLUNTEER': "Volunteer";
+    readonly 'job.employment_type.OTHER': "Other";
+    readonly 'job.location_type.LOCATION': "On-site";
+    readonly 'job.location_type.REMOTE': "Remote";
+    readonly 'job.location_type.HYBRID': "Hybrid";
+};
+
+export declare type DisplayableFilterProperty = {
+    key: /** Enter any key or traverse any custom_data object returned by the job with dot-separated keys.
+    *  @example `custom_data.location.city`
+    */ FilterKey | CustomDataKey;
+    transform?: (value: unknown) => string | string[] | null;
+};
+
+/** Given a string with double curly braces, returns the content of all curly braces. */
+declare type ExtractParams<T extends string> = T extends `${infer Head}{{${infer Param}}}${infer Tail}` ? Param | ExtractParams<Tail> : never;
+
+export declare const FILTER_KEYS: readonly ["locale", "company_name", "employment_type", "location_type", "pay_type", "pay_currency", "pay_mask", "pay", "pay_min", "pay_max", "title", "industry", "category", "skills", "town", "city", "country", "contract_type", "pay_display"];
+
+export declare type FilterKey = (typeof FILTER_KEYS)[number];
+
+export declare type FilterProperty = {
+    key: FilterKey | CustomDataKey;
+    /** The label to display for the property.
+     *  Represents a human-readable name for the property.
+     */
+    label: string;
+    /** Override the default icon.
+     * Icons are already suggested for each property, but you can override them.
+     */
+    icon?: IconName;
+    /** Hides the property from the UI
+     * You can use this property to hard-code searches without allowing the user to modify or view them.
+     */
+    hidden?: boolean;
+    /** The **fixed** value for the filter. Cannot be removed or changed. */
+    value?: string | string[];
+    /** The **default** value for the filter. Can be removed or changed, but defaults to it during initial load. */
+    defaultValue?: string | string[];
+    /** Whether users can search from the available results.
+     *  @default false
+     */
+    searchable?: boolean;
+    /** Whether users can select one or multiple values.
+     *  @default `'one'`
+     */
+    select: 'one' | 'many';
+    /** How to show results
+     *  @default "all"
+     *  @description
+     *  - "all" will show all results
+     *  - "only-available" (⚠️ leads to layout shifts) will show results that are available for the current filters
+     */
+    results?: 'only-available' | 'all';
+    /** How to sort the suggestions
+     *  @default { by: 'results-count', order: 'ascending' }
+     *  @description
+     *  - 'results-count' will sort the suggestions by the number of results they have
+     *  - 'alphabetically' will sort the suggestions alphabetically
+     *  - 'numerically' will sort the suggestions numerically, coercing any string values to numbers
+     */
+    sortSuggestions?: {
+        by: 'results-count' | 'alphabetically' | 'numerically';
+        order: 'ascending' | 'descending';
+    };
+};
+
+declare type FilterValue = {
+    select: 'one';
+    value: string | undefined;
+} | {
+    select: 'many';
+    value: string[] | undefined;
+};
+
+declare type FontSettings = {
+    fontFamily: string;
+    weight: 'normal' | 'bold' | 'lighter' | 'bolder' | number;
+    style: 'normal' | 'italic';
+};
+
+declare type GeoBounds = {
+    type: 'bounds';
+    sw: {
+        lat: number;
+        lng: number;
+    };
+    ne: {
+        lat: number;
+        lng: number;
+    };
+};
+
+declare type GeoSearchFilter = {
+    type: 'provided';
+    coords?: {
+        lat: number;
+        lng: number;
+    };
+    radius: number;
+    /** The place as the candidate chose it; absent when the search came from a URL. */
+    label?: string;
+} | {
+    type: 'ip';
+    radius: number;
+} | GeoBounds;
+
+declare const getJobSearchResults: ({ rpcClient, signal, state, page, t, prioritySegment, locale, fallbackLocale, }: {
+    rpcClient: InploiRpcClient;
+    signal?: AbortSignal;
+    state: JobSearchState;
+    page?: number;
+    t: TFunction;
+    prioritySegment: string | undefined;
+    locale: string | undefined;
+    fallbackLocale: string | undefined;
+}) => Promise<{
+    pagination: {
+        total: number;
+        current_page: number;
+        per_page: number;
+        last_page: number;
+    };
+    results: {
+        id: number;
+        createdAt: string | null;
+        company: {
+            name: string;
+            logo: string | null;
+        };
+        pay: string | null;
+        title: string;
+        contractType: string | null;
+        href: string;
+        relativePostedDate: string;
+        customData: {
+            [x: string]: any;
+        } | null;
+        raw: {
+            location_type: string;
+            employment_type: string;
+            id: number;
+            company_name: string;
+            company_logo: string | null;
+            pay_type: "ANNUALLY" | "HOURLY" | "MONTHLY" | "WEEKLY" | "DAILY" | null;
+            pay_currency: string;
+            pay_mask: boolean;
+            pay_display: boolean;
+            pay: string | null;
+            pay_min: string | null;
+            pay_max: string | null;
+            title: string;
+            contract_type: string | null;
+            created_at: string | null;
+            custom_data: {
+                [x: string]: any;
+            } | null;
+            href: string;
+            industry: string | null;
+            category: string | null;
+            skills: string | null;
+            town: string | null;
+            city: string | null;
+            country: string | null;
+            vector_distance: string | null;
+            coordinates?: {
+                lat: number;
+                lng: number;
+            } | null | undefined;
+            distance_meters: number | null;
+            locale?: string | null | undefined;
+        };
+        distanceMeters: number | null;
+        match: string | null;
+    }[];
+}>;
+
+declare type HintedString<KnownValues> = (string & {}) | KnownValues;
+
+declare type IconName = 'briefcase' | 'brand' | 'building' | 'circles' | 'clock' | 'filter' | 'globe' | 'magnifier' | 'magnifierSimple' | 'mapPin' | 'pay' | 'sunset' | 'x' | 'plus' | 'chevron-right' | 'ai' | 'target-location' | 'warning' | 'map' | 'list';
+
+export declare type JobSearchDomManager = ReturnType<typeof createJobSearchDomManager>;
+
+export declare const jobSearchPlugin: () => ({ apiClient, rpcClient, logger, analytics }: {
+    apiClient: ApiClient;
+    rpcClient: InploiRpcClient;
+    logger: Logger;
+    analytics: AnalyticsService;
+    publishableKey?: string;
+    env?: InploiSdkEnvironment;
+}) => {
+    /** Returns a string with the initial rendering state of the UI.
+     *  Useful when server-side rendering to avoid CLS.
+     */
+    prerender: (params: PrerenderJobSearchPluginParams) => Promise<{
+        html: string;
+        data: {
+            jobs: {
+                pagination: {
+                    total: number;
+                    current_page: number;
+                    per_page: number;
+                    last_page: number;
+                };
+                results: {
+                    id: number;
+                    createdAt: string | null;
+                    company: {
+                        name: string;
+                        logo: string | null;
+                    };
+                    pay: string | null;
+                    title: string;
+                    contractType: string | null;
+                    href: string;
+                    relativePostedDate: string;
+                    customData: {
+                        [x: string]: any;
+                    } | null;
+                    raw: {
+                        location_type: string;
+                        employment_type: string;
+                        id: number;
+                        company_name: string;
+                        company_logo: string | null;
+                        pay_type: "ANNUALLY" | "HOURLY" | "MONTHLY" | "WEEKLY" | "DAILY" | null;
+                        pay_currency: string;
+                        pay_mask: boolean;
+                        pay_display: boolean;
+                        pay: string | null;
+                        pay_min: string | null;
+                        pay_max: string | null;
+                        title: string;
+                        contract_type: string | null;
+                        created_at: string | null;
+                        custom_data: {
+                            [x: string]: any;
+                        } | null;
+                        href: string;
+                        industry: string | null;
+                        category: string | null;
+                        skills: string | null;
+                        town: string | null;
+                        city: string | null;
+                        country: string | null;
+                        vector_distance: string | null;
+                        coordinates?: {
+                            lat: number;
+                            lng: number;
+                        } | null | undefined;
+                        distance_meters: number | null;
+                        locale?: string | null | undefined;
+                    };
+                    distanceMeters: number | null;
+                    match: string | null;
+                }[];
+            };
+        } | undefined;
+    }>;
+    /** Renders the Job Search Plugin inside the container element. */
+    render: (params: RenderJobSearchPluginParams) => Promise<void>;
+};
+
+export declare type JobSearchPluginCardOverrides = {
+    /** Use only if you want to override the default salary property. */
+    salary?: DisplayableFilterProperty;
+    /** Overrides the link to the job. */
+    baseUrl?: (jobId: string) => string;
+    /** Overrides the default behavior of the click event. */
+    onClick?: (e: TargetedEvent<HTMLAnchorElement, MouseEvent>) => void;
+    /** Overrides the default behavior of the hover event. */
+    onMouseEnter?: (e: TargetedEvent<HTMLAnchorElement, MouseEvent>) => void;
+};
+
+export declare interface JobSearchPluginI18nParams {
+    /** Only see jobs in this locale */
+    locale: string | undefined;
+    /** Fallback locale to use if jobs in the preferred locale are not available */
+    fallbackLocale: string | undefined;
+}
+
+export declare interface JobSearchPluginParams {
+    /** Used to identify the specific widget you want to render, in case there are multiple instances of the widget on the page.*/
+    widgetId?: string;
+    theme: {
+        mode: 'light' | 'dark';
+        corners: 'rounded' | 'soft' | 'sharp';
+        highlights: 'stroke' | 'fill';
+        accent: ColorPaletteConfig;
+        neutral?: ColorPaletteConfig;
+        monetary?: ColorPaletteConfig;
+        typography: Partial<FontSettings> & Partial<Record<TextStyle, Partial<FontSettings>>>;
+        /** Applies to the filter section on desktop. Override to ensure the filters are stuck to the top of the viewport,
+         * but not obscured by the header. This is useful when the header is sticky on your website.
+         * @default 112px
+         */
+        filtersOffsetTopPx?: number;
+        accessibility?: {
+            highContrast: boolean;
+            reducedMotion: boolean;
+        };
+    };
+    /** Array of properties because _order matters_ to display them. */
+    properties: FilterProperty[];
+    jobCard: {
+        subheading: DisplayableFilterProperty | null;
+        infoTags: DisplayableFilterProperty[];
+        logo?: 'hidden' | '1:1' | '2:1';
+        /**
+         * Whether to show the posted date or not.
+         *  @default 'show'
+         *  @description
+         *  - 'show' will show the posted date and the "NEW" badge if the job is new (less than 7 days old).
+         *  - 'hide' will hide the posted date.
+         *  - 'only-new' will only show the "NEW" badge if the job is new.
+         */
+        postedDate?: 'hide' | 'show' | 'only-new';
+        /** Time *in days* for a job to be considered new
+         *  @default 7
+         */
+        newUnderDays?: number;
+        overrides?: JobSearchPluginCardOverrides;
+        /**
+         * Specifies how the job link should be opened.
+         * @default 'redirect'
+         * @description
+         * - 'redirect': Navigates to the job's URL in the current tab.
+         * - 'redirect-new-tab': Opens the job's URL in a new tab.
+         */
+        openJob?: 'redirect' | 'redirect-new-tab';
+    };
+    initialState: JobSearchState | ((params: Omit<JobSearchPluginParams, 'initialState'>) => JobSearchState);
+    /** Enables searching for jobs by keyword */
+    enableKeywordSearch?: boolean;
+    geolocation?: {
+        enabled: boolean;
+        distanceUnit?: 'miles' | 'km';
+    };
+    naturalLanguageSearch?: {
+        /** Enables searching for jobs by natural language */
+        enabled: boolean;
+        /** Suggestion searches */
+        suggestions: string[];
+    };
+    /** Override terms used in the plugin */
+    terms?: JobSearchTranslationTerms;
+    i18n?: JobSearchPluginI18nParams;
+    /** Provide a plugin instance to enable job alerts. */
+    alerts?: {
+        plugin: ReturnType<typeof jobAlertsPlugin> | Promise<{
+            jobAlertsPlugin: typeof jobAlertsPlugin;
+        }>;
+        params: Pick<JobAlertsPluginParams, 'config' | 'terms'>;
+    };
+    /** Provide a plugin instance to enable feedback. */
+    feedback?: {
+        plugin: FeedbackPlugin | Promise<{
+            feedbackPlugin: typeof feedbackPlugin;
+        }>;
+        params?: {
+            terms?: FeedbackPluginParams['terms'];
+            theme: Partial<FeedbackPluginParams['theme']>;
+        };
+    };
+    map?: {
+        enabled: boolean;
+        /** The map rendering library. Mapbox loads only when set explicitly. @default 'maplibre' */
+        renderer?: 'mapbox' | 'maplibre';
+        /** @deprecated Used only by Mapbox; will be removed when the Mapbox renderer is retired. */
+        accessToken?: string;
+        /** MapLibre: a style id (e.g. `default`) or HTTPS URL. Mapbox: a style URL, including `mapbox://`. */
+        style?: string;
+        pinColor?: string;
+        defaultCenter?: [number, number];
+    };
+    results?: {
+        prioritySegment?: string;
+    };
+}
+
+declare type JobSearchState = {
+    filters: Record<string, FilterValue | undefined>;
+    query: string;
+    mode: 'query' | 'vector';
+    /** Omit to retain the API's contextual default ranking. */
+    resultOrder?: 'newest';
+    geo?: GeoSearchFilter | undefined;
+    page: number;
+    view: 'list' | 'map';
+};
+
+/** Visual theme for the Job Search UI. */
+export declare type JobSearchTheme = JobSearchPluginParams['theme'];
+
+export declare type JobSearchTranslationTerms = Parameters<typeof createTFunction>[0]['overrides'] | undefined;
+
+export declare interface PrerenderJobSearchPluginParams extends JobSearchPluginParams {
+    /** If true, the data needed to display the first page of results
+     *  will be fetched from the server. This is recommended if SEO is important
+     *  or you want your page to be progressively enhanced. */
+    withData: boolean;
+}
+
+export declare interface RenderJobSearchPluginParams extends JobSearchPluginParams {
+    /** When provided with initial data, the client side bundle will hydrate
+     * the already present SSR content, avoiding any loading.
+     */
+    initialData?: {
+        jobs: Awaited<ReturnType<typeof getJobSearchResults>>;
+    };
+    onStateChange: (partialState: Partial<JobSearchState>) => void;
+}
+
+/** Preact's `TargetedEvent`, spelled out so the published types don't need Preact's: the DOM event, with `currentTarget` typed. */
+declare type TargetedEvent<Target extends EventTarget, TypedEvent extends Event> = Omit<TypedEvent, 'currentTarget'> & {
+    readonly currentTarget: Target;
+};
+
+declare type Terms = Record<string, string | TranslationWithPlurals>;
+
+declare type TextStyle = keyof typeof textStyles;
+
+declare const textStyles: {
+    readonly filter: "filter";
+    readonly tag: "tag";
+    readonly input: "input";
+    readonly jobHeading: "jobHeading";
+};
+
+declare interface TFn<TTerms extends Terms> {
+    <K extends TranslationKeyWithParams<TTerms>>(key: K, options: TTerms[K] extends string ? {
+        [_Term in ExtractParams<TTerms[K]>]: number | string;
+    } : {
+        [_Term in ExtractParams<TTerms[K][keyof TTerms[K]] & string> | 'count']: number | string;
+    }): string;
+    <T extends Exclude<keyof (keyof TranslationDict<TTerms>), TranslationKeyWithParams<TTerms>>>(key: T): string;
+    <T extends keyof TranslationDict<TTerms>>(key: T, options?: {
+        [key: string]: string | number;
+    }): string;
+}
+
+declare type TFunction = ReturnType<typeof useTranslation>['t'];
+
+declare type TranslationDict<TTerms extends Terms> = {
+    [K in keyof TTerms]: TTerms[K] extends TranslationWithPlurals ? {
+        [J in keyof TTerms[K]]: HintedString<TTerms[K][J]>;
+    } : HintedString<TTerms[K]>;
+};
+
+declare type TranslationKeyWithParams<TTerms extends Terms> = {
+    [K in keyof TTerms]: TTerms[K] extends TranslationWithPlurals ? K : ExtractParams<TTerms[K] & string> extends never ? never : K;
+}[keyof TranslationDict<TTerms>];
+
+declare type TranslationWithPlurals = Partial<Record<Intl.LDMLPluralRule, string>>;
+
+declare const useTranslation: <T extends {
+    readonly type_to_search_jobs: "Type to search jobs";
+    readonly type_to_search: "Type to search";
+    readonly jobs_found: {
+        readonly one: "{{count}} job found";
+        readonly other: "{{count}} jobs found";
+    };
+    readonly no_jobs_found: "No jobs found";
+    readonly no_jobs_found_description: "We could not find any jobs matching your filtering criteria.";
+    readonly jobs_loading_error: "We’re having trouble loading available jobs.";
+    readonly filters_loading_error: "We’re having trouble loading available filters.";
+    readonly no_filter_options_available: "No filter options available.";
+    readonly clear: "Clear";
+    readonly selected: "selected";
+    readonly done: "Done";
+    readonly close: "Close";
+    readonly new: "NEW";
+    readonly posted: "Posted";
+    readonly distance_away: "{{distance}} away";
+    readonly retry: "Retry";
+    readonly widget_unavailable: "Sorry, this widget is unavailable at the moment.";
+    readonly load_more_count: "Load {{count}} more";
+    readonly of_remaining_count: "of {{count}} remaining";
+    readonly today: "today";
+    readonly over_30_days_ago: "over 30 days ago";
+    readonly in_over_30_days: "in over 30 days";
+    readonly up_to: "Up to";
+    readonly from: "From";
+    readonly invalid_salary: "Invalid salary";
+    readonly competitive: "Competitive";
+    readonly natural_language_input: "Type anything";
+    readonly great_match: "Great match";
+    readonly advanced_mode: "Filters";
+    readonly simple_mode: "Hide filters";
+    readonly ai_disclaimer: "Results may not be perfect. AI-powered search can occasionally suggest unrelated content.";
+    readonly geo_error_timeout: "Timed out. Please type your location manually.";
+    readonly geo_error_permission_denied: "Please allow location access to use this feature.";
+    readonly geo_error_position_unavailable: "Could not locate you. Please type your location manually.";
+    readonly geo_my_location: "My location";
+    readonly geo_locating: "Locating you...";
+    readonly geo_search_placeholder: "Search for a location";
+    readonly geo_clear_search: "Clear location search";
+    readonly location_provided: "Provided location";
+    readonly search_label: "What";
+    readonly geo_label: "Where";
+    readonly geo_range_label: "Within";
+    readonly geo_suggestions_error: "Could not get the suggested locations.";
+    readonly geo_no_match: "We couldn’t find that place. Try a town, city or postcode.";
+    readonly geo_query_too_short: "Type at least 3 letters of a town, city or postcode.";
+    readonly geo_choose_location: "Press Enter or choose a suggestion to search near this place.";
+    readonly geo_any_distance: "Any distance";
+    readonly feedback: "How was your search experience?";
+    readonly list: "List";
+    readonly map: "Map";
+    readonly map_gesture_windows: "Use Ctrl + scroll to zoom the map";
+    readonly map_gesture_mac: "Use ⌘ + scroll to zoom the map";
+    readonly map_gesture_mobile: "Use two fingers to move the map";
+    readonly map_unavailable: "Map unavailable";
+    readonly loading_jobs: "Loading jobs…";
+    readonly map_jobs_error: "We’re having trouble loading jobs in the area";
+    readonly map_has_more_title: "Not showing all the jobs in this area";
+    readonly map_has_more_description: "Zoom in to refine your search further";
+    readonly map_jobs_showing: {
+        readonly one: "Showing {{count}} job";
+        readonly other: "Showing {{count}} jobs";
+    };
+    readonly page: "Page";
+    readonly reset: "Reset";
+    readonly sort_by: "Sort by";
+    readonly sort_most_relevant: "Most relevant";
+    readonly sort_closest: "Closest";
+    readonly sort_newest: "Newest";
+    readonly 'job.employment_type.FULL_TIME': "Full-time";
+    readonly 'job.employment_type.PART_TIME': "Part-time";
+    readonly 'job.employment_type.CONTRACT': "Contractor";
+    readonly 'job.employment_type.TEMPORARY': "Temporary";
+    readonly 'job.employment_type.INTERN': "Internship";
+    readonly 'job.employment_type.VOLUNTEER': "Volunteer";
+    readonly 'job.employment_type.OTHER': "Other";
+    readonly 'job.location_type.LOCATION': "On-site";
+    readonly 'job.location_type.REMOTE': "Remote";
+    readonly 'job.location_type.HYBRID': "Hybrid";
+} = {
+    readonly type_to_search_jobs: "Type to search jobs";
+    readonly type_to_search: "Type to search";
+    readonly jobs_found: {
+        readonly one: "{{count}} job found";
+        readonly other: "{{count}} jobs found";
+    };
+    readonly no_jobs_found: "No jobs found";
+    readonly no_jobs_found_description: "We could not find any jobs matching your filtering criteria.";
+    readonly jobs_loading_error: "We’re having trouble loading available jobs.";
+    readonly filters_loading_error: "We’re having trouble loading available filters.";
+    readonly no_filter_options_available: "No filter options available.";
+    readonly clear: "Clear";
+    readonly selected: "selected";
+    readonly done: "Done";
+    readonly close: "Close";
+    readonly new: "NEW";
+    readonly posted: "Posted";
+    readonly distance_away: "{{distance}} away";
+    readonly retry: "Retry";
+    readonly widget_unavailable: "Sorry, this widget is unavailable at the moment.";
+    readonly load_more_count: "Load {{count}} more";
+    readonly of_remaining_count: "of {{count}} remaining";
+    readonly today: "today";
+    readonly over_30_days_ago: "over 30 days ago";
+    readonly in_over_30_days: "in over 30 days";
+    readonly up_to: "Up to";
+    readonly from: "From";
+    readonly invalid_salary: "Invalid salary";
+    readonly competitive: "Competitive";
+    readonly natural_language_input: "Type anything";
+    readonly great_match: "Great match";
+    readonly advanced_mode: "Filters";
+    readonly simple_mode: "Hide filters";
+    readonly ai_disclaimer: "Results may not be perfect. AI-powered search can occasionally suggest unrelated content.";
+    readonly geo_error_timeout: "Timed out. Please type your location manually.";
+    readonly geo_error_permission_denied: "Please allow location access to use this feature.";
+    readonly geo_error_position_unavailable: "Could not locate you. Please type your location manually.";
+    readonly geo_my_location: "My location";
+    readonly geo_locating: "Locating you...";
+    readonly geo_search_placeholder: "Search for a location";
+    readonly geo_clear_search: "Clear location search";
+    readonly location_provided: "Provided location";
+    readonly search_label: "What";
+    readonly geo_label: "Where";
+    readonly geo_range_label: "Within";
+    readonly geo_suggestions_error: "Could not get the suggested locations.";
+    readonly geo_no_match: "We couldn’t find that place. Try a town, city or postcode.";
+    readonly geo_query_too_short: "Type at least 3 letters of a town, city or postcode.";
+    readonly geo_choose_location: "Press Enter or choose a suggestion to search near this place.";
+    readonly geo_any_distance: "Any distance";
+    readonly feedback: "How was your search experience?";
+    readonly list: "List";
+    readonly map: "Map";
+    readonly map_gesture_windows: "Use Ctrl + scroll to zoom the map";
+    readonly map_gesture_mac: "Use ⌘ + scroll to zoom the map";
+    readonly map_gesture_mobile: "Use two fingers to move the map";
+    readonly map_unavailable: "Map unavailable";
+    readonly loading_jobs: "Loading jobs…";
+    readonly map_jobs_error: "We’re having trouble loading jobs in the area";
+    readonly map_has_more_title: "Not showing all the jobs in this area";
+    readonly map_has_more_description: "Zoom in to refine your search further";
+    readonly map_jobs_showing: {
+        readonly one: "Showing {{count}} job";
+        readonly other: "Showing {{count}} jobs";
+    };
+    readonly page: "Page";
+    readonly reset: "Reset";
+    readonly sort_by: "Sort by";
+    readonly sort_most_relevant: "Most relevant";
+    readonly sort_closest: "Closest";
+    readonly sort_newest: "Newest";
+    readonly 'job.employment_type.FULL_TIME': "Full-time";
+    readonly 'job.employment_type.PART_TIME': "Part-time";
+    readonly 'job.employment_type.CONTRACT': "Contractor";
+    readonly 'job.employment_type.TEMPORARY': "Temporary";
+    readonly 'job.employment_type.INTERN': "Internship";
+    readonly 'job.employment_type.VOLUNTEER': "Volunteer";
+    readonly 'job.employment_type.OTHER': "Other";
+    readonly 'job.location_type.LOCATION': "On-site";
+    readonly 'job.location_type.REMOTE': "Remote";
+    readonly 'job.location_type.HYBRID': "Hybrid";
+}>() => {
+    t: TFn<T>;
+    locale: string | undefined;
+};
+
+export { }