@inploi/plugin-job-search 1.2.2 → 2.0.0

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

@@ -58,6 +58,12 @@ declare const getJobSearchResponseSchema: (t: import('@inploi/i18n/translation')
     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";
 }>) => import('valibot').SchemaWithTransform<import('valibot').ObjectSchema<{
     data: import('valibot').ArraySchema<import('valibot').SchemaWithTransform<import('valibot').ObjectSchema<{
         id: import('valibot').NumberSchema<number>;
@@ -516,6 +522,12 @@ declare const getJobSearchMapSchema: (t: import('@inploi/i18n/translation').TFn<
     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";
 }>) => import('valibot').SchemaWithTransform<import('valibot').ObjectSchema<{
     data: import('valibot').ArraySchema<import('valibot').SchemaWithTransform<import('valibot').ObjectSchema<{
         id: import('valibot').NumberSchema<number>;

package/dist/job-search.d.ts

@@ -3,9 +3,8 @@ import { JobAlertsPluginParams, jobAlertsPlugin } from '@inploi/plugin-job-alert
 import { Logger } from '@inploi/sdk';
 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 { JobSearchState } from './components/job-search.tsx';
 import { JobSearchTranslationTerms } from './lib/i18n.ts';
 
 type FontSettings = {
@@ -90,7 +89,7 @@ type ColorPaletteConfig = {
     /** Float between 0 and 2. Acts as a multiplier to the original generated palette. */
     chroma: number;
 };
-export type JobSearchPluginParams = {
+export 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: {
@@ -140,8 +139,7 @@ export type JobSearchPluginParams = {
          */
         openJob?: 'redirect' | 'redirect-new-tab';
     };
-    defaultSearchKeyword?: string;
-    defaultGeolocation?: GeoSearchFilter;
+    initialState: JobSearchState | ((params: Omit<JobSearchPluginParams, 'initialState'>) => JobSearchState);
     /** Enables searching for jobs by keyword */
     enableKeywordSearch?: boolean;
     /** Translation terms */
@@ -175,7 +173,7 @@ export type JobSearchPluginParams = {
         pinColor?: string;
         defaultCenter?: [number, number];
     };
-};
+}
 export 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
@@ -189,9 +187,7 @@ export interface RenderJobSearchPluginParams extends JobSearchPluginParams {
     initialData?: {
         jobs: Awaited<ReturnType<typeof getJobSearchResults>>;
     };
-    onFilterChange: (params: Record<string, FilterValue | undefined>) => void;
-    onKeywordChange: (keyword: string | undefined) => void;
-    onGeolocationChange: (geo: GeoSearchFilter | undefined) => void;
+    onStateChange: (partialState: Partial<JobSearchState>) => void;
 }
 export declare const createJobSearchDomManager: (logger: Logger) => {
     getRenderTargetElement: (widgetId: string | undefined) => Element;

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

@@ -163,6 +163,12 @@ export declare const getJobSchema: (t: import('@inploi/i18n/translation').TFn<{
     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";
 }>) => import('valibot').SchemaWithTransform<import('valibot').ObjectSchema<{
     id: import('valibot').NumberSchema<number>;
     company_name: import('valibot').StringSchema<string>;

package/dist/lib/i18n.d.ts

@@ -52,6 +52,12 @@ export declare const TranslationProvider: (props: {
         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";
     }>> | undefined;
     locale: string | undefined;
     children?: import('preact').ComponentChildren;
@@ -108,6 +114,12 @@ export declare const TranslationProvider: (props: {
     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 type_to_search_jobs: "Type to search jobs";
     readonly type_to_search: "Type to search";
@@ -161,6 +173,12 @@ export declare const TranslationProvider: (props: {
     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";
 }>() => {
     t: import('@inploi/i18n/translation').TFn<T>;
     locale: string | undefined;
@@ -217,6 +235,12 @@ export declare const TranslationProvider: (props: {
     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 type_to_search_jobs: "Type to search jobs";
     readonly type_to_search: "Type to search";
@@ -270,6 +294,12 @@ export declare const TranslationProvider: (props: {
     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";
 }>(options: {
     overrides: Partial<import('@inploi/i18n/translation').TranslationDict<{
         readonly type_to_search_jobs: "Type to search jobs";
@@ -324,6 +354,12 @@ export declare const TranslationProvider: (props: {
         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";
     }>>;
     locale: string | undefined;
 }) => import('@inploi/i18n/translation').TFn<T>;

package/dist/lib/utils.d.ts

@@ -1,7 +1,16 @@
 import { GeoSearchFilter } from '../components/geo-search';
-import { FilterProperty } from '..';
+import { JobSearchState } from '../components/job-search';
+import { FilterProperty, JobSearchPluginParams } from '..';
 
 /** Reads from search params provided and adds to list of filters. */
 export declare const getStatefulPropertiesFromSearchParams: (properties: FilterProperty[], searchParams: URLSearchParams) => FilterProperty[];
-export declare const getGeolocationFromSearchParams: (searchParams: URLSearchParams) => GeoSearchFilter;
+export declare const getModeFromSearchParams: (searchParams: URLSearchParams) => JobSearchState['mode'];
+export declare const getViewFromSearchParams: (searchParams: URLSearchParams) => JobSearchState['view'];
+/** Returns a function that can be used to get the initial state of the widget from the search params. */
+export declare const getWidgetStateFromSearchParams: ({ searchParams }: {
+    searchParams: URLSearchParams;
+}) => JobSearchPluginParams['initialState'];
+/** Modifies the searchParams instance in place to reflect the current state of the widget. */
+export declare const setWidgetStateToSearchParams: (partialState: Partial<JobSearchState>, searchParams: URLSearchParams) => void;
+export declare const getGeolocationFromSearchParams: (searchParams: URLSearchParams) => GeoSearchFilter | undefined;
 export declare const useDebouncedValue: <T>(value: T, timeout?: number) => T;

package/dist/lib/utils.test.d.ts

@@ -0,0 +1 @@
+export {};