@inploi/plugin-job-search 0.1.5 → 0.3.0

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

@@ -25,9 +25,13 @@ declare const JobSearchResponseSchema: import("valibot").SchemaWithTransform<imp
             [x: string]: any;
         } | null>;
         href: import("valibot").StringSchema<string>;
+        industry: import("valibot").OptionalSchema<import("valibot").StringSchema<string>, undefined, string | undefined>;
+        category: import("valibot").OptionalSchema<import("valibot").StringSchema<string>, undefined, string | undefined>;
+        skills: import("valibot").OptionalSchema<import("valibot").StringSchema<string>, undefined, string | undefined>;
+        town: import("valibot").OptionalSchema<import("valibot").StringSchema<string>, undefined, string | undefined>;
+        city: import("valibot").OptionalSchema<import("valibot").StringSchema<string>, undefined, string | undefined>;
+        country: import("valibot").OptionalSchema<import("valibot").StringSchema<string>, undefined, string | undefined>;
     }, undefined, {
-        title: string;
-        href: string;
         id: number;
         company_name: string;
         employment_type: string;
@@ -40,12 +44,47 @@ declare const JobSearchResponseSchema: import("valibot").SchemaWithTransform<imp
         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 | undefined;
+        category?: string | undefined;
+        skills?: string | undefined;
+        town?: string | undefined;
+        city?: string | undefined;
+        country?: string | undefined;
     }>, {
+        raw: {
+            id: number;
+            company_name: string;
+            employment_type: string;
+            location_type: "LOCATION" | "REMOTE" | "HYBRID";
+            pay_type: "ANNUALLY" | "HOURLY" | "MONTHLY" | "WEEKLY" | "DAILY";
+            pay_currency: string;
+            pay_mask: boolean;
+            pay_display: boolean;
+            pay: string | null;
+            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 | undefined;
+            category?: string | undefined;
+            skills?: string | undefined;
+            town?: string | undefined;
+            city?: string | undefined;
+            country?: string | undefined;
+        };
         id: number;
         isNew: boolean;
         company: {
@@ -63,6 +102,33 @@ declare const JobSearchResponseSchema: import("valibot").SchemaWithTransform<imp
             [x: string]: any;
         } | null;
     }>, {
+        raw: {
+            id: number;
+            company_name: string;
+            employment_type: string;
+            location_type: "LOCATION" | "REMOTE" | "HYBRID";
+            pay_type: "ANNUALLY" | "HOURLY" | "MONTHLY" | "WEEKLY" | "DAILY";
+            pay_currency: string;
+            pay_mask: boolean;
+            pay_display: boolean;
+            pay: string | null;
+            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 | undefined;
+            category?: string | undefined;
+            skills?: string | undefined;
+            town?: string | undefined;
+            city?: string | undefined;
+            country?: string | undefined;
+        };
         id: number;
         isNew: boolean;
         company: {
@@ -93,6 +159,33 @@ declare const JobSearchResponseSchema: import("valibot").SchemaWithTransform<imp
     }>;
 }, undefined, {
     data: {
+        raw: {
+            id: number;
+            company_name: string;
+            employment_type: string;
+            location_type: "LOCATION" | "REMOTE" | "HYBRID";
+            pay_type: "ANNUALLY" | "HOURLY" | "MONTHLY" | "WEEKLY" | "DAILY";
+            pay_currency: string;
+            pay_mask: boolean;
+            pay_display: boolean;
+            pay: string | null;
+            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 | undefined;
+            category?: string | undefined;
+            skills?: string | undefined;
+            town?: string | undefined;
+            city?: string | undefined;
+            country?: string | undefined;
+        };
         id: number;
         isNew: boolean;
         company: {
@@ -124,6 +217,33 @@ declare const JobSearchResponseSchema: import("valibot").SchemaWithTransform<imp
         last_page: number;
     };
     results: {
+        raw: {
+            id: number;
+            company_name: string;
+            employment_type: string;
+            location_type: "LOCATION" | "REMOTE" | "HYBRID";
+            pay_type: "ANNUALLY" | "HOURLY" | "MONTHLY" | "WEEKLY" | "DAILY";
+            pay_currency: string;
+            pay_mask: boolean;
+            pay_display: boolean;
+            pay: string | null;
+            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 | undefined;
+            category?: string | undefined;
+            skills?: string | undefined;
+            town?: string | undefined;
+            city?: string | undefined;
+            country?: string | undefined;
+        };
         id: number;
         isNew: boolean;
         company: {
@@ -169,6 +289,33 @@ export declare const getJobSearchResults: ({ apiClient, logger, signal, filters,
         last_page: number;
     };
     results: {
+        raw: {
+            id: number;
+            company_name: string;
+            employment_type: string;
+            location_type: "LOCATION" | "REMOTE" | "HYBRID";
+            pay_type: "ANNUALLY" | "HOURLY" | "MONTHLY" | "WEEKLY" | "DAILY";
+            pay_currency: string;
+            pay_mask: boolean;
+            pay_display: boolean;
+            pay: string | null;
+            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 | undefined;
+            category?: string | undefined;
+            skills?: string | undefined;
+            town?: string | undefined;
+            city?: string | undefined;
+            country?: string | undefined;
+        };
         id: number;
         isNew: boolean;
         company: {

package/dist/job-search.d.ts

@@ -1,4 +1,6 @@
+import { getJobSearchResults } from './job-search.api.ts';
 import { IconName } from './components/icon.tsx';
+import { HintedString } from './lib/type-utils.ts';
 type FontSettings = {
     fontFamily: string;
     weight: 'normal' | 'bold' | 'lighter' | 'bolder' | number;
@@ -11,8 +13,8 @@ declare const textStyles: {
     readonly jobHeading: "jobHeading";
 };
 type TextStyle = keyof typeof textStyles;
-export declare const FILTER_KEYS: readonly ["company_id", "company_name", "industry", "employment_type", "location_type", "pay_type", "pay_currency", "pay_mask", "pay", "pay_min", "pay_max", "title", "category", "skills", "address_1", "address_2", "town", "city", "postcode", "country", "contract_type", "pay_display"];
-export type FilterKey = (typeof FILTER_KEYS)[number] | (string & {});
+export declare const FILTER_KEYS: readonly ["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 type FilterKey = HintedString<(typeof FILTER_KEYS)[number]>;
 export type FilterProperty = {
     key: FilterKey;
     /** The label to display for the property.
@@ -38,6 +40,10 @@ export type FilterProperty = {
      */
     select: 'one' | 'many';
 };
+export type DisplayableFilterProperty = FilterKey | {
+    key: string;
+    transform: (value: string | undefined) => string | null;
+};
 export type JobSearchPluginParams = {
     theme: {
         mode: 'light' | 'dark';
@@ -62,12 +68,30 @@ export type JobSearchPluginParams = {
     };
     /** Array of properties because _order matters_ to display them. */
     properties: FilterProperty[];
+    jobCard: {
+        subheading: DisplayableFilterProperty;
+        infoTags: DisplayableFilterProperty[];
+    };
 };
+export interface SSRJobSearchPluginParams 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 interface CSRJobSearchPluginParams 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>>;
+    };
+}
 export declare const createJobSearchDomManager: () => {
     getRenderTargetElement: () => Element;
 };
 export type ChatbotDomManager = ReturnType<typeof createJobSearchDomManager>;
-export declare const jobSearchPlugin: (params: JobSearchPluginParams) => ({ apiClient, logger, analytics }: {
+export declare const jobSearchPlugin: () => ({ apiClient, logger, analytics }: {
     apiClient: import("@inploi/sdk").ApiClient;
     logger: import("@inploi/sdk").Logger;
     analytics: import("@inploi/sdk").AnalyticsService;
@@ -75,8 +99,65 @@ export declare const jobSearchPlugin: (params: JobSearchPluginParams) => ({ apiC
     /** Returns a string with the initial rendering state of the UI.
      *  Useful when server-side rendering to avoid CLS.
      */
-    renderToString: () => string;
+    prerender: (params: SSRJobSearchPluginParams) => Promise<{
+        html: string;
+        data: {
+            jobs: {
+                pagination: {
+                    total: number;
+                    current_page: number;
+                    per_page: number;
+                    last_page: number;
+                };
+                results: {
+                    raw: {
+                        id: number;
+                        company_name: string;
+                        employment_type: string;
+                        location_type: "LOCATION" | "REMOTE" | "HYBRID";
+                        pay_type: "ANNUALLY" | "HOURLY" | "MONTHLY" | "WEEKLY" | "DAILY";
+                        pay_currency: string;
+                        pay_mask: boolean;
+                        pay_display: boolean;
+                        pay: string | null;
+                        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 | undefined;
+                        category?: string | undefined;
+                        skills?: string | undefined;
+                        town?: string | undefined;
+                        city?: string | undefined;
+                        country?: string | undefined;
+                    };
+                    id: number;
+                    isNew: boolean;
+                    company: {
+                        name: string;
+                    };
+                    employmentType: string;
+                    locationType: "LOCATION" | "REMOTE" | "HYBRID";
+                    pay: string | undefined;
+                    description: string;
+                    title: string;
+                    contractType: string | null;
+                    href: string;
+                    relativePostedDate: string;
+                    customData: {
+                        [x: string]: any;
+                    } | null;
+                }[];
+            };
+        } | undefined;
+    }>;
     /** Renders the Job Search Plugin inside the container element. */
-    render: () => Promise<void>;
+    render: (params: CSRJobSearchPluginParams) => Promise<void>;
 };
 export {};

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

@@ -50,9 +50,13 @@ export declare const JobSchema: import("valibot").SchemaWithTransform<import("va
         [x: string]: any;
     } | null>;
     href: import("valibot").StringSchema<string>;
+    industry: import("valibot").OptionalSchema<import("valibot").StringSchema<string>, undefined, string | undefined>;
+    category: import("valibot").OptionalSchema<import("valibot").StringSchema<string>, undefined, string | undefined>;
+    skills: import("valibot").OptionalSchema<import("valibot").StringSchema<string>, undefined, string | undefined>;
+    town: import("valibot").OptionalSchema<import("valibot").StringSchema<string>, undefined, string | undefined>;
+    city: import("valibot").OptionalSchema<import("valibot").StringSchema<string>, undefined, string | undefined>;
+    country: import("valibot").OptionalSchema<import("valibot").StringSchema<string>, undefined, string | undefined>;
 }, undefined, {
-    title: string;
-    href: string;
     id: number;
     company_name: string;
     employment_type: string;
@@ -65,12 +69,47 @@ export declare const JobSchema: import("valibot").SchemaWithTransform<import("va
     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 | undefined;
+    category?: string | undefined;
+    skills?: string | undefined;
+    town?: string | undefined;
+    city?: string | undefined;
+    country?: string | undefined;
 }>, {
+    raw: {
+        id: number;
+        company_name: string;
+        employment_type: string;
+        location_type: "LOCATION" | "REMOTE" | "HYBRID";
+        pay_type: "ANNUALLY" | "HOURLY" | "MONTHLY" | "WEEKLY" | "DAILY";
+        pay_currency: string;
+        pay_mask: boolean;
+        pay_display: boolean;
+        pay: string | null;
+        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 | undefined;
+        category?: string | undefined;
+        skills?: string | undefined;
+        town?: string | undefined;
+        city?: string | undefined;
+        country?: string | undefined;
+    };
     id: number;
     isNew: boolean;
     company: {