@inploi/plugin-job-search 0.2.0 → 0.3.0

package/dist/job-search.d.ts

@@ -1,3 +1,4 @@
+import { getJobSearchResults } from './job-search.api.ts';
 import { IconName } from './components/icon.tsx';
 import { HintedString } from './lib/type-utils.ts';
 type FontSettings = {
@@ -72,11 +73,25 @@ export type JobSearchPluginParams = {
         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;
@@ -84,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 {};