@inploi/plugin-job-search 0.0.6 → 0.1.0

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

@@ -1,6 +1,8 @@
 import { ApiClient, Logger } from '@inploi/sdk';
+import { SWRResponse } from 'swr';
+import { Input } from 'valibot';
 import { FilterValue } from './components/filter';
-export declare const JobSearchResponseSchema: import("valibot").ObjectSchema<{
+declare const JobSearchResponseSchema: import("valibot").SchemaWithTransform<import("valibot").ObjectSchema<{
     data: import("valibot").ObjectSchema<{
         results: import("valibot").ArraySchema<import("valibot").SchemaWithTransform<import("valibot").ObjectSchema<{
             id: import("valibot").NumberSchema<number>;
@@ -25,14 +27,16 @@ export declare const JobSearchResponseSchema: import("valibot").ObjectSchema<{
                 lng: number;
             }>;
             contract_type: import("valibot").NullableSchema<import("valibot").StringSchema<string>, undefined, string | null>;
-            created_at: import("valibot").StringSchema<string>;
+            created_at: import("valibot").NullableSchema<import("valibot").StringSchema<string>, undefined, string | null>;
             custom_data: import("valibot").NullableSchema<import("valibot").RecordSchema<import("valibot").StringSchema<string>, import("valibot").AnySchema<any>, {
                 [x: string]: any;
             }>, undefined, {
                 [x: string]: any;
             } | null>;
+            href: import("valibot").StringSchema<string>;
         }, undefined, {
             title: string;
+            href: string;
             id: number;
             company_name: string;
             company_logo: string;
@@ -51,7 +55,7 @@ export declare const JobSearchResponseSchema: import("valibot").ObjectSchema<{
                 lng: number;
             };
             contract_type: string | null;
-            created_at: string;
+            created_at: string | null;
             custom_data: {
                 [x: string]: any;
             } | null;
@@ -72,6 +76,7 @@ export declare const JobSearchResponseSchema: import("valibot").ObjectSchema<{
                 lng: number;
             };
             contractType: string | null;
+            href: string;
             relativePostedDate: string;
             customData: {
                 [x: string]: any;
@@ -93,13 +98,20 @@ export declare const JobSearchResponseSchema: import("valibot").ObjectSchema<{
                 lng: number;
             };
             contractType: string | null;
+            href: string;
             relativePostedDate: string;
             customData: {
                 [x: string]: any;
             } | null;
         }[]>;
-        available_properties: import("valibot").RecordSchema<import("valibot").StringSchema<string>, import("valibot").ArraySchema<import("valibot").StringSchema<string>, string[]>, {
-            [x: string]: string[];
+        available_properties: import("valibot").RecordSchema<import("valibot").StringSchema<string>, import("valibot").SchemaWithTransform<import("valibot").ArraySchema<import("valibot").StringSchema<string>, string[]>, {
+            value: string;
+            label: string;
+        }[]>, {
+            [x: string]: {
+                value: string;
+                label: string;
+            }[];
         }>;
     }, undefined, {
         results: {
@@ -119,13 +131,17 @@ export declare const JobSearchResponseSchema: import("valibot").ObjectSchema<{
                 lng: number;
             };
             contractType: string | null;
+            href: string;
             relativePostedDate: string;
             customData: {
                 [x: string]: any;
             } | null;
         }[];
         available_properties: {
-            [x: string]: string[];
+            [x: string]: {
+                value: string;
+                label: string;
+            }[];
         };
     }>;
     pagination: import("valibot").ObjectSchema<{
@@ -158,13 +174,17 @@ export declare const JobSearchResponseSchema: import("valibot").ObjectSchema<{
                 lng: number;
             };
             contractType: string | null;
+            href: string;
             relativePostedDate: string;
             customData: {
                 [x: string]: any;
             } | null;
         }[];
         available_properties: {
-            [x: string]: string[];
+            [x: string]: {
+                value: string;
+                label: string;
+            }[];
         };
     };
     pagination: {
@@ -173,44 +193,109 @@ export declare const JobSearchResponseSchema: import("valibot").ObjectSchema<{
         per_page: number;
         last_page: number;
     };
+}>, {
+    pagination: {
+        total: number;
+        current_page: number;
+        per_page: number;
+        last_page: number;
+    };
+    results: {
+        id: number;
+        isNew: boolean;
+        company: {
+            name: string;
+            logo: string;
+        };
+        employmentType: "FULL_TIME" | "PART_TIME" | "TEMPORARY" | "CONTRACTOR" | "INTERN" | "VOLUNTEER" | "OTHER";
+        locationType: "LOCATION" | "REMOTE" | "HYBRID";
+        pay: string | undefined;
+        description: string;
+        title: string;
+        coordinates: {
+            lat: number;
+            lng: number;
+        };
+        contractType: string | null;
+        href: string;
+        relativePostedDate: string;
+        customData: {
+            [x: string]: any;
+        } | null;
+    }[];
+    availableProperties: {
+        [x: string]: {
+            value: string;
+            label: string;
+        }[];
+    };
 }>;
-export declare const getJobSearchResults: ({ apiClient, logger, signal, filters, }: {
+export type JobSearchResponsePayload = Input<typeof JobSearchResponseSchema>;
+export declare const getJobSearchResults: ({ apiClient, logger, signal, filters, page, }: {
     apiClient: ApiClient;
     logger: Logger;
     signal?: AbortSignal | undefined;
     filters: Record<string, FilterValue | undefined>;
+    page?: number | undefined;
 }) => Promise<{
-    data: {
-        results: {
-            id: number;
-            isNew: boolean;
-            company: {
-                name: string;
-                logo: string;
-            };
-            employmentType: "FULL_TIME" | "PART_TIME" | "TEMPORARY" | "CONTRACTOR" | "INTERN" | "VOLUNTEER" | "OTHER";
-            locationType: "LOCATION" | "REMOTE" | "HYBRID";
-            pay: string | undefined;
-            description: string;
-            title: string;
-            coordinates: {
-                lat: number;
-                lng: number;
-            };
-            contractType: string | null;
-            relativePostedDate: string;
-            customData: {
-                [x: string]: any;
-            } | null;
-        }[];
-        available_properties: {
-            [x: string]: string[];
-        };
-    };
     pagination: {
         total: number;
         current_page: number;
         per_page: number;
         last_page: number;
     };
+    results: {
+        id: number;
+        isNew: boolean;
+        company: {
+            name: string;
+            logo: string;
+        };
+        employmentType: "FULL_TIME" | "PART_TIME" | "TEMPORARY" | "CONTRACTOR" | "INTERN" | "VOLUNTEER" | "OTHER";
+        locationType: "LOCATION" | "REMOTE" | "HYBRID";
+        pay: string | undefined;
+        description: string;
+        title: string;
+        coordinates: {
+            lat: number;
+            lng: number;
+        };
+        contractType: string | null;
+        href: string;
+        relativePostedDate: string;
+        customData: {
+            [x: string]: any;
+        } | null;
+    }[];
+    availableProperties: {
+        [x: string]: {
+            value: string;
+            label: string;
+        }[];
+    };
 }>;
+export declare const getDataState: <T>(swr: SWRResponse<T, any, any>) => {
+    state: "error";
+    error: unknown;
+    data: T | undefined;
+} | {
+    state: "loading";
+    data: T | undefined;
+    error?: undefined;
+} | {
+    state: "revalidating";
+    data: NonNullable<T>;
+    error?: undefined;
+} | {
+    state: "loaded";
+    data: NonNullable<T>;
+    error?: undefined;
+};
+export declare const SWR_SETTINGS: {
+    readonly keepPreviousData: true;
+    readonly revalidateOnFocus: false;
+    readonly revalidateOnReconnect: false;
+    readonly revalidateIfStale: false;
+    readonly revalidateFirstPage: false;
+};
+export {};

package/dist/job-search.d.ts

@@ -43,7 +43,6 @@ export type JobSearchPluginParams = {
         mode: 'light' | 'dark';
         corners: 'rounded' | 'soft' | 'sharp';
         highlights: 'stroke' | 'fill';
-        highcontrast: boolean;
         typography: Partial<FontSettings> & Partial<Record<TextStyle, Partial<FontSettings>>>;
         accent: {
             /** Number between 0 and 360. Number above or below range will loop. */
@@ -51,6 +50,15 @@ export type JobSearchPluginParams = {
             /** Float between 0 and 2. Acts as a multiplier to the original generated palette. */
             chroma: number;
         };
+        /** 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[];

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

@@ -1,8 +1,15 @@
 import { Output } from 'valibot';
-export declare const AvailablePropertiesSchema: import("valibot").RecordSchema<import("valibot").StringSchema<string>, import("valibot").ArraySchema<import("valibot").StringSchema<string>, string[]>, {
-    [x: string]: string[];
+export declare const AvailablePropertiesSchema: import("valibot").RecordSchema<import("valibot").StringSchema<string>, import("valibot").SchemaWithTransform<import("valibot").ArraySchema<import("valibot").StringSchema<string>, string[]>, {
+    value: string;
+    label: string;
+}[]>, {
+    [x: string]: {
+        value: string;
+        label: string;
+    }[];
 }>;
 export type AvailablePropertiesSchema = Output<typeof AvailablePropertiesSchema>;
+export type FilterSuggestion = AvailablePropertiesSchema[keyof AvailablePropertiesSchema][number];
 export declare const PaginationSchema: import("valibot").ObjectSchema<{
     total: import("valibot").NumberSchema<number>;
     current_page: import("valibot").NumberSchema<number>;
@@ -38,14 +45,16 @@ export declare const JobSchema: import("valibot").SchemaWithTransform<import("va
         lng: number;
     }>;
     contract_type: import("valibot").NullableSchema<import("valibot").StringSchema<string>, undefined, string | null>;
-    created_at: import("valibot").StringSchema<string>;
+    created_at: import("valibot").NullableSchema<import("valibot").StringSchema<string>, undefined, string | null>;
     custom_data: import("valibot").NullableSchema<import("valibot").RecordSchema<import("valibot").StringSchema<string>, import("valibot").AnySchema<any>, {
         [x: string]: any;
     }>, undefined, {
         [x: string]: any;
     } | null>;
+    href: import("valibot").StringSchema<string>;
 }, undefined, {
     title: string;
+    href: string;
     id: number;
     company_name: string;
     company_logo: string;
@@ -64,7 +73,7 @@ export declare const JobSchema: import("valibot").SchemaWithTransform<import("va
         lng: number;
     };
     contract_type: string | null;
-    created_at: string;
+    created_at: string | null;
     custom_data: {
         [x: string]: any;
     } | null;
@@ -85,6 +94,7 @@ export declare const JobSchema: import("valibot").SchemaWithTransform<import("va
         lng: number;
     };
     contractType: string | null;
+    href: string;
     relativePostedDate: string;
     customData: {
         [x: string]: any;