@inploi/plugin-job-alerts 5.2.1 → 5.3.1

package/dist/index.d.ts

@@ -1 +1,104 @@
-export * from './job-alerts';
+import { AnalyticsService } from '@inploi/sdk';
+import { ApiClient } from '@inploi/sdk';
+import { InploiRpcClient } from '@inploi/sdk';
+import { InploiSdkEnvironment } from '@inploi/sdk';
+import { JobAlertsFilters } from '@inploi/sdk';
+import { Logger } from '@inploi/sdk';
+
+export declare const createJobAlertsDomManager: () => {
+    getRenderTargetElement: () => Element;
+};
+
+/** English defaults for every job alerts term. Kept free of type imports so the published declarations stand alone. */
+export declare const defaultTerms: {
+    readonly DAILY: "Daily";
+    readonly WEEKLY: "Weekly";
+    readonly MONTHLY: "Monthly";
+    readonly email: "Email";
+    readonly email_placeholder: "jane.doe@example.com";
+    readonly name: "Name";
+    readonly name_placeholder: "Jane Doe";
+    readonly save: "Save";
+    readonly save_alert: "Save Alert";
+    readonly frequency: "Frequency";
+    readonly create_alert: "Create Alert";
+    readonly create_alert_error: "Failed to create alert. Please try again later.";
+    readonly privacy_policy_link: "How we use your personal data";
+    readonly alert_notice_sender: "{{company}} will email you new jobs matching this search, as often as you choose. Every email has an unsubscribe link.";
+    readonly alert_notice: "You'll get new jobs matching this search by email, as often as you choose. Every email has an unsubscribe link.";
+};
+
+export declare type JobAlertsConfig = {
+    /** Button label */
+    label: string;
+    /** Header to be displayed above the form */
+    headerText: string;
+    /** Linked under the form, before the candidate confirms, so they can read how their personal data is used. */
+    privacyPolicyUrl?: string;
+    /**
+     * Who sends the alert emails, named in the notice above the submit button. Pass the company's display name, the
+     * same name the emails come from. Without it the notice still says what arrives and how to unsubscribe.
+     */
+    employerName?: string;
+};
+
+export declare type JobAlertsDomManager = ReturnType<typeof createJobAlertsDomManager>;
+
+export { JobAlertsFilters }
+
+export declare const jobAlertsPlugin: () => ({ rpcClient, logger, analytics }: {
+    apiClient: ApiClient;
+    rpcClient: InploiRpcClient;
+    logger: Logger;
+    analytics: AnalyticsService;
+    publishableKey?: string;
+    env?: InploiSdkEnvironment;
+}) => {
+    /** Returns a string with the initial rendering state of the UI.
+     *  Useful when server-side rendering to avoid CLS.
+     */
+    prerender: (params: JobAlertsPluginParams) => Promise<{
+        html: string;
+    }>;
+    /** Renders the Job Alerts Plugin inside the container element. */
+    render: (params: JobAlertsPluginParams) => Promise<void>;
+    setFilters: (newFilters: JobAlertsFilters) => {
+        [x: string]: string | string[] | {
+            type: "provided";
+            lat: number;
+            lng: number;
+            radius: number;
+            unit?: "miles" | "km" | undefined;
+            label?: string | undefined;
+        };
+    };
+    setConfig: (newConfig: JobAlertsConfig | ((oldConfig: JobAlertsConfig) => JobAlertsConfig)) => JobAlertsConfig;
+    '~brand': "@inploi/plugin-job-alerts";
+};
+
+export declare type jobAlertsPlugin = ReturnType<typeof jobAlertsPlugin>;
+
+export declare type JobAlertsPluginParams = {
+    theme: {
+        mode: 'light' | 'dark';
+        corners: 'rounded' | 'soft' | 'sharp';
+        highlights: 'stroke' | 'fill';
+        accent: {
+            /** Number between 0 and 360. Number above or below range will loop. */
+            hue: number;
+            /** Float between 0 and 2. Acts as a multiplier to the original generated palette. */
+            chroma: number;
+        };
+    };
+    config: JobAlertsConfig;
+    initialFilters: JobAlertsFilters;
+    terms?: JobAlertsTranslationTerms;
+};
+
+/** Visual theme for the Job Alerts UI. */
+export declare type JobAlertsTheme = JobAlertsPluginParams['theme'];
+
+/** Host overrides for any job alerts term. */
+export declare type JobAlertsTranslationTerms = Partial<Record<keyof typeof defaultTerms, string>>;
+
+export { }