@inploi/plugin-job-search 0.24.0 → 0.25.1

package/dist/job-search.api.d.ts

@@ -1,10 +1,58 @@
 import { ApiClient, Logger } from '@inploi/sdk';
 import { SWRResponse } from 'swr';
 import { Input, Output } from 'valibot';
-import { FilterValue } from './components/filter';
-import { TFunction } from './lib/translation.terms';
+import { JobSearchState } from './components/job-search';
+import { TFunction } from './lib/i18n';
 
-declare const getJobSearchResponseSchema: (t: TFunction) => import('valibot').SchemaWithTransform<import('valibot').ObjectSchema<{
+declare const getJobSearchResponseSchema: (t: import('@inploi/i18n/translation').TFn<{
+    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 skip: "Skip";
+    readonly new: "NEW";
+    readonly posted: "Posted";
+    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 create_alert: "Create alert";
+    readonly alert_header_text: "You will be alerted for new jobs matching the filters currently set";
+    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.";
+}>) => import('valibot').SchemaWithTransform<import('valibot').ObjectSchema<{
     data: import('valibot').ArraySchema<import('valibot').SchemaWithTransform<import('valibot').ObjectSchema<{
         id: import('valibot').NumberSchema<number>;
         company_name: import('valibot').StringSchema<string>;
@@ -36,6 +84,8 @@ declare const getJobSearchResponseSchema: (t: TFunction) => import('valibot').Sc
         country: import('valibot').NullableSchema<import('valibot').StringSchema<string>, undefined, string | null>;
         vector_distance: import('valibot').OptionalSchema<import('valibot').NullableSchema<import('valibot').StringSchema<string>, undefined, string | null>, undefined, string | null | undefined>;
     }, undefined, {
+        title: string;
+        href: string;
         id: number;
         company_name: string;
         employment_type: string;
@@ -48,13 +98,11 @@ declare const getJobSearchResponseSchema: (t: TFunction) => import('valibot').Sc
         pay_min: string | null;
         pay_max: string | null;
         description: string;
-        title: string;
         contract_type: string | null;
         created_at: string | null;
         custom_data: {
             [x: string]: any;
         } | null;
-        href: string;
         industry: string | null;
         category: string | null;
         city: string | null;
@@ -82,6 +130,8 @@ declare const getJobSearchResponseSchema: (t: TFunction) => import('valibot').Sc
             [x: string]: any;
         } | null;
         raw: {
+            title: string;
+            href: string;
             id: number;
             company_name: string;
             employment_type: string;
@@ -94,13 +144,11 @@ declare const getJobSearchResponseSchema: (t: TFunction) => import('valibot').Sc
             pay_min: string | null;
             pay_max: string | null;
             description: string;
-            title: string;
             contract_type: string | null;
             created_at: string | null;
             custom_data: {
                 [x: string]: any;
             } | null;
-            href: string;
             industry: string | null;
             category: string | null;
             city: string | null;
@@ -130,6 +178,8 @@ declare const getJobSearchResponseSchema: (t: TFunction) => import('valibot').Sc
             [x: string]: any;
         } | null;
         raw: {
+            title: string;
+            href: string;
             id: number;
             company_name: string;
             employment_type: string;
@@ -142,13 +192,11 @@ declare const getJobSearchResponseSchema: (t: TFunction) => import('valibot').Sc
             pay_min: string | null;
             pay_max: string | null;
             description: string;
-            title: string;
             contract_type: string | null;
             created_at: string | null;
             custom_data: {
                 [x: string]: any;
             } | null;
-            href: string;
             industry: string | null;
             category: string | null;
             city: string | null;
@@ -191,6 +239,8 @@ declare const getJobSearchResponseSchema: (t: TFunction) => import('valibot').Sc
             [x: string]: any;
         } | null;
         raw: {
+            title: string;
+            href: string;
             id: number;
             company_name: string;
             employment_type: string;
@@ -203,13 +253,11 @@ declare const getJobSearchResponseSchema: (t: TFunction) => import('valibot').Sc
             pay_min: string | null;
             pay_max: string | null;
             description: string;
-            title: string;
             contract_type: string | null;
             created_at: string | null;
             custom_data: {
                 [x: string]: any;
             } | null;
-            href: string;
             industry: string | null;
             category: string | null;
             city: string | null;
@@ -253,6 +301,8 @@ declare const getJobSearchResponseSchema: (t: TFunction) => import('valibot').Sc
             [x: string]: any;
         } | null;
         raw: {
+            title: string;
+            href: string;
             id: number;
             company_name: string;
             employment_type: string;
@@ -265,13 +315,11 @@ declare const getJobSearchResponseSchema: (t: TFunction) => import('valibot').Sc
             pay_min: string | null;
             pay_max: string | null;
             description: string;
-            title: string;
             contract_type: string | null;
             created_at: string | null;
             custom_data: {
                 [x: string]: any;
             } | null;
-            href: string;
             industry: string | null;
             category: string | null;
             city: string | null;
@@ -287,13 +335,18 @@ declare const getJobSearchResponseSchema: (t: TFunction) => import('valibot').Sc
 export type JobSearchResponsePayloadInput = Input<ReturnType<typeof getJobSearchResponseSchema>>;
 export type JobSearchResponsePayloadOutput = Output<ReturnType<typeof getJobSearchResponseSchema>>;
 export declare const getFilterValue: (filterValue: string | string[] | undefined) => string | string[] | null;
-export declare const filtersToPayload: (filters: Record<string, FilterValue | undefined>) => Record<string, string | string[] | null>;
-export declare const getAvailableFilters: ({ apiClient, filters, keyword, logger, signal, }: {
+type GeoSearchApiParams = {
+    lat?: number;
+    lng?: number;
+    radius?: number;
+    type?: 'provided' | 'ip';
+};
+export declare const filtersToPayload: (state: JobSearchState) => Record<string, string | string[] | GeoSearchApiParams | null | undefined>;
+export declare const getAvailableFilters: ({ apiClient, state, logger, signal, }: {
     apiClient: ApiClient;
     logger: Logger;
-    keyword: string | undefined;
     signal?: AbortSignal;
-    filters: Record<string, FilterValue | undefined>;
+    state: JobSearchState;
 }) => Promise<{
     [x: string]: {
         label: string;
@@ -302,15 +355,13 @@ export declare const getAvailableFilters: ({ apiClient, filters, keyword, logger
     }[];
 }>;
 export type GetAvailableFiltersResponse = Awaited<ReturnType<typeof getAvailableFilters>>;
-export declare const getJobSearchResults: ({ apiClient, logger, signal, filters, query, page, t, mode, }: {
+export declare const getJobSearchResults: ({ apiClient, logger, signal, state, page, t, }: {
     apiClient: ApiClient;
     logger: Logger;
     signal?: AbortSignal;
-    filters: Record<string, FilterValue | undefined>;
-    query?: string;
+    state: JobSearchState;
     page?: number;
     t: TFunction;
-    mode: 'query' | 'vector';
 }) => Promise<{
     pagination: {
         total: number;
@@ -337,6 +388,8 @@ export declare const getJobSearchResults: ({ apiClient, logger, signal, filters,
             [x: string]: any;
         } | null;
         raw: {
+            title: string;
+            href: string;
             id: number;
             company_name: string;
             employment_type: string;
@@ -349,13 +402,11 @@ export declare const getJobSearchResults: ({ apiClient, logger, signal, filters,
             pay_min: string | null;
             pay_max: string | null;
             description: string;
-            title: string;
             contract_type: string | null;
             created_at: string | null;
             custom_data: {
                 [x: string]: any;
             } | null;
-            href: string;
             industry: string | null;
             category: string | null;
             city: string | null;
@@ -370,22 +421,27 @@ export declare const getJobSearchResults: ({ apiClient, logger, signal, filters,
 }>;
 export type GetJobSearchResponse = Awaited<ReturnType<typeof getJobSearchResults>>;
 export type QueryState<T> = {
-    state: 'error';
+    queryState: 'idle';
+    data?: never;
+    error?: never;
+    swr: SWRResponse<T>;
+} | {
+    queryState: 'error';
     data?: never;
     error: unknown;
     swr: SWRResponse<T>;
 } | {
-    state: 'loading';
+    queryState: 'loading';
     data?: never;
     error?: never;
     swr: SWRResponse<T>;
 } | {
-    state: 'revalidating';
+    queryState: 'revalidating';
     data: T;
     error?: never;
     swr: SWRResponse<T>;
 } | {
-    state: 'loaded';
+    queryState: 'loaded';
     data: T;
     error?: never;
     swr: SWRResponse<T>;

package/dist/job-search.d.ts

@@ -1,8 +1,9 @@
 import { TargetedEvent } from 'preact/compat';
 import { getJobSearchResults } from './job-search.api.ts';
 import { FilterValue } from './components/filter.tsx';
+import { GeoSearchFilter } from './components/geo-search.tsx';
 import { IconName } from './components/icon.tsx';
-import { JobSearchTranslationTerms } from './lib/translation.terms.ts';
+import { JobSearchTranslationTerms } from './lib/i18n.ts';
 
 type FontSettings = {
     fontFamily: string;
@@ -135,12 +136,16 @@ export type JobSearchPluginParams = {
         openJob?: 'redirect' | 'redirect-new-tab';
     };
     defaultSearchKeyword?: string;
+    defaultGeolocation?: GeoSearchFilter;
     /** Enables the job alerts button */
     enableJobAlerts?: boolean;
     /** Enables searching for jobs by keyword */
     enableKeywordSearch?: boolean;
     /** Translation terms */
     terms?: JobSearchTranslationTerms;
+    geolocation?: {
+        enabled: boolean;
+    };
     naturalLanguageSearch?: {
         /** Enables searching for jobs by natural language */
         enabled: boolean;
@@ -163,6 +168,7 @@ export interface RenderJobSearchPluginParams extends JobSearchPluginParams {
     };
     onFilterChange: (params: Record<string, FilterValue | undefined>) => void;
     onKeywordChange: (keyword: string | undefined) => void;
+    onGeolocationChange: (geo: GeoSearchFilter | undefined) => void;
 }
 export declare const createJobSearchDomManager: () => {
     getRenderTargetElement: () => Element;
@@ -193,6 +199,7 @@ export declare const jobSearchPlugin: () => ({ apiClient, logger, analytics }: {
                         name: string;
                         logo: string | null;
                     };
+                    /** The **fixed** value for the filter. Cannot be removed or changed. */
                     employmentType: string;
                     locationType: "LOCATION" | "REMOTE" | "HYBRID";
                     pay: string | null;
@@ -205,6 +212,8 @@ export declare const jobSearchPlugin: () => ({ apiClient, logger, analytics }: {
                         [x: string]: any;
                     } | null;
                     raw: {
+                        title: string;
+                        href: string;
                         id: number;
                         company_name: string;
                         employment_type: string;
@@ -217,13 +226,11 @@ export declare const jobSearchPlugin: () => ({ apiClient, logger, analytics }: {
                         pay_min: string | null;
                         pay_max: string | null;
                         description: string;
-                        title: string;
                         contract_type: string | null;
                         created_at: string | null;
                         custom_data: {
                             [x: string]: any;
                         } | null;
-                        href: string;
                         industry: string | null;
                         category: string | null;
                         city: string | null;

package/dist/job-search.schemas.d.ts

@@ -1,5 +1,4 @@
 import { Output } from 'valibot';
-import { TFunction } from './lib/translation.terms';
 
 export declare const AvailablePropertiesSchema: import('valibot').RecordSchema<import('valibot').StringSchema<string>, import('valibot').ArraySchema<import('valibot').ObjectSchema<{
     label: import('valibot').StringSchema<string>;
@@ -65,6 +64,8 @@ export declare const JobPayloadSchema: import('valibot').ObjectSchema<{
     country: import('valibot').NullableSchema<import('valibot').StringSchema<string>, undefined, string | null>;
     vector_distance: import('valibot').OptionalSchema<import('valibot').NullableSchema<import('valibot').StringSchema<string>, undefined, string | null>, undefined, string | null | undefined>;
 }, undefined, {
+    title: string;
+    href: string;
     id: number;
     company_name: string;
     employment_type: string;
@@ -77,13 +78,11 @@ export declare const JobPayloadSchema: import('valibot').ObjectSchema<{
     pay_min: string | null;
     pay_max: string | null;
     description: string;
-    title: string;
     contract_type: string | null;
     created_at: string | null;
     custom_data: {
         [x: string]: any;
     } | null;
-    href: string;
     industry: string | null;
     category: string | null;
     city: string | null;
@@ -94,7 +93,55 @@ export declare const JobPayloadSchema: import('valibot').ObjectSchema<{
     vector_distance?: string | null | undefined;
 }>;
 export type JobPayloadSchema = Output<typeof JobPayloadSchema>;
-export declare const getJobSchema: (t: TFunction) => import('valibot').SchemaWithTransform<import('valibot').ObjectSchema<{
+export declare const getJobSchema: (t: import('@inploi/i18n/translation').TFn<{
+    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 skip: "Skip";
+    readonly new: "NEW";
+    readonly posted: "Posted";
+    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 create_alert: "Create alert";
+    readonly alert_header_text: "You will be alerted for new jobs matching the filters currently set";
+    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.";
+}>) => import('valibot').SchemaWithTransform<import('valibot').ObjectSchema<{
     id: import('valibot').NumberSchema<number>;
     company_name: import('valibot').StringSchema<string>;
     company_logo: import('valibot').NullableSchema<import('valibot').OptionalSchema<import('valibot').StringSchema<string>, undefined, string | undefined>, undefined, string | undefined>;
@@ -125,6 +172,8 @@ export declare const getJobSchema: (t: TFunction) => import('valibot').SchemaWit
     country: import('valibot').NullableSchema<import('valibot').StringSchema<string>, undefined, string | null>;
     vector_distance: import('valibot').OptionalSchema<import('valibot').NullableSchema<import('valibot').StringSchema<string>, undefined, string | null>, undefined, string | null | undefined>;
 }, undefined, {
+    title: string;
+    href: string;
     id: number;
     company_name: string;
     employment_type: string;
@@ -137,13 +186,11 @@ export declare const getJobSchema: (t: TFunction) => import('valibot').SchemaWit
     pay_min: string | null;
     pay_max: string | null;
     description: string;
-    title: string;
     contract_type: string | null;
     created_at: string | null;
     custom_data: {
         [x: string]: any;
     } | null;
-    href: string;
     industry: string | null;
     category: string | null;
     city: string | null;
@@ -171,6 +218,8 @@ export declare const getJobSchema: (t: TFunction) => import('valibot').SchemaWit
         [x: string]: any;
     } | null;
     raw: {
+        title: string;
+        href: string;
         id: number;
         company_name: string;
         employment_type: string;
@@ -183,13 +232,11 @@ export declare const getJobSchema: (t: TFunction) => import('valibot').SchemaWit
         pay_min: string | null;
         pay_max: string | null;
         description: string;
-        title: string;
         contract_type: string | null;
         created_at: string | null;
         custom_data: {
             [x: string]: any;
         } | null;
-        href: string;
         industry: string | null;
         category: string | null;
         city: string | null;

package/dist/lib/cache-key.d.ts

@@ -1,7 +1,6 @@
-import { FilterValue } from '../components/filter';
+import { JobSearchState } from '../components/job-search';
 
 export declare const cacheKey: (value: {
-    filter: Record<string, FilterValue | undefined>;
+    state: JobSearchState;
     baseKey: string;
-    keyword: string | undefined;
 }) => string;

package/dist/lib/currency.d.ts

@@ -1,5 +1,5 @@
 import { JobPayloadSchema } from '../job-search.schemas';
-import { TFunction } from './translation.terms';
+import { TFunction } from './i18n';
 
 export declare const getSalaryAsText: (params: {
     salary: Pick<JobPayloadSchema, 'pay' | 'pay_min' | 'pay_mask' | 'pay_max' | 'pay_type' | 'pay_currency' | 'pay_display'>;

package/dist/lib/datetime.d.ts

@@ -1,4 +1,4 @@
-import { TFunction } from './translation.terms';
+import { TFunction } from './i18n';
 
 type Params = {
     from?: Date;