@inploi/plugin-chatbot 14.18.0 → 14.18.2

package/dist/index.d.cts

@@ -0,0 +1,547 @@
+import type { AnalyticsService } from '@inploi/sdk' with { 'resolution-mode': 'import' };
+import type { ApiClient } from '@inploi/sdk' with { 'resolution-mode': 'import' };
+import type { FeedbackPlugin } from '@inploi/plugin-feedback' with { 'resolution-mode': 'import' };
+import type { feedbackPlugin } from '@inploi/plugin-feedback' with { 'resolution-mode': 'import' };
+import type { FeedbackPluginParams } from '@inploi/plugin-feedback' with { 'resolution-mode': 'import' };
+import type { Flow } from '@inploi/flows/endpoints' with { 'resolution-mode': 'import' };
+import type { InploiRpcClient } from '@inploi/sdk' with { 'resolution-mode': 'import' };
+import type { InploiSdkEnvironment } from '@inploi/sdk' with { 'resolution-mode': 'import' };
+import type { Logger } from '@inploi/sdk' with { 'resolution-mode': 'import' };
+
+export declare type Chatbot = ReturnType<ReturnType<ChatbotPlugin>>;
+
+declare type ChatbotDomManager = ReturnType<typeof createChatbotDomManager>;
+
+export declare type ChatbotFeedback = {
+    plugin: FeedbackPlugin | Promise<{
+        feedbackPlugin: typeof feedbackPlugin;
+    }>;
+    params?: Pick<FeedbackPluginParams, 'terms'>;
+};
+
+export declare type ChatbotPlugin = typeof chatbotPlugin;
+
+export declare const chatbotPlugin: ({ _internal_domManager: dom, theme, terms, feedback, jobAlerts, }: InternalChatbotPluginParams) => ({ apiClient, rpcClient, logger, analytics, publishableKey, env }: {
+    apiClient: ApiClient;
+    rpcClient: InploiRpcClient;
+    logger: Logger;
+    analytics: AnalyticsService;
+    publishableKey?: string;
+    env?: InploiSdkEnvironment;
+}) => {
+    /** Optionally eagerly renders the interface ahead of needing the chatbot. */
+    prepare: () => Promise<void>;
+    /** Fetches a flow by job ID.
+     *  @param jobId - The job ID to fetch the flow for. This is the job ID according to the **ATS**, and not the inploi job ID.
+     */
+    fetchFlowByJobId: (jobId: string, additionalProperties?: FetchFlowByJobIdAdditionalProperties) => Promise<OpenChatbotParams>;
+    fetchFlowById: (flowId: string, additionalProperties?: FetchFlowByIdAdditionalProperties) => Promise<OpenChatbotParams>;
+    open: (params: OpenChatbotParams | Promise<OpenChatbotParams>) => Promise<void>;
+    /**
+     * Whether this browser holds an application in progress that `open(params)` would load: the same saved state
+     * under the same key, unfinished, with an answer, including one whose submit started. The candidate loader
+     * keeps such a candidate on this chatbot rather than move them mid-application (PROD-7342).
+     */
+    hasApplicationInProgress: (params: OpenChatbotParams) => Promise<boolean>;
+    /**
+     * Whether this browser holds an application in progress for any job: the candidate loader's question when it
+     * cannot load this page's flow to ask `hasApplicationInProgress` (CF-06). Without the flow's nodes, any saved
+     * answer counts.
+     */
+    hasAnyApplicationInProgress: () => Promise<boolean>;
+    close: () => Promise<void>;
+    destroy: () => void;
+};
+
+export declare type ChatbotPluginParams = RemoveInternal<InternalChatbotPluginParams>;
+
+export declare type ChatbotTheme = {
+    /** Rotation for the hue. Between 0 and 360. */
+    hue: number;
+    /** Chroma multiplier. Values between 0 and 1.5 work best. */
+    chroma?: number;
+    mode: 'light' | 'dark';
+};
+
+/** Dictionary of translation terms for the chatbot plugin */
+export declare type ChatbotTranslationTerms = Parameters<typeof createTFunction>[0]['overrides'] | undefined;
+
+declare const createChatbotDomManager: () => {
+    getChatbotElement: () => HTMLDivElement | null;
+    getOrCreateChatbotElement: () => HTMLDivElement;
+};
+
+declare const createTFunction: <T extends {
+    readonly error_heading: "Something unexpected happened";
+    readonly flow_closed: "This role is no longer accepting applications.";
+    readonly undo: "Change answer";
+    readonly job_alerts_offer: "Want to hear about similar roles? We can email you at {{email}} when new ones open.";
+    readonly job_alerts_accept: "Get job alerts";
+    readonly job_alerts_decline: "No thanks";
+    readonly job_alerts_privacy: "We'll use your email only for these alerts. You can unsubscribe at any time.";
+    readonly job_alerts_privacy_sender: "{{employer}} will email you new jobs like this one. Every email has an unsubscribe link.";
+    readonly job_alerts_success: "Done. We'll email you about similar roles.";
+    readonly job_alerts_error: "Sorry, we couldn't set that up. Please try again later.";
+    readonly submission_duplicate: "You've already applied for this role, so we haven't submitted a second application. If that doesn't sound right, check your email for a confirmation or try again in a few minutes.";
+    readonly submission_retryable: "We couldn't submit your application. Please try again.";
+    readonly submission_unknown: "We couldn't confirm whether your application was sent. Please check your email for a confirmation. If nothing arrives, choose Restart to apply again.";
+    readonly maximize: "Maximise";
+    readonly submit: "Submit";
+    readonly file_more: {
+        readonly one: "+{{count}} file";
+        readonly other: "+{{count}} files";
+    };
+    readonly conversation_history: string;
+    readonly jump_to_current: string;
+    readonly send: string;
+    readonly submitting: string;
+    readonly skip: string;
+    readonly skipped: string;
+    readonly submission_closed: string;
+    readonly submission_duplicate_earlier_attempt: string;
+    readonly submission_failed: string;
+    readonly submission_unknown_do_not_resubmit: string;
+    readonly submission_unreadable_document: string;
+    readonly submission_cooldown: {
+        one: string;
+        other: string;
+    };
+    readonly submission_cooldown_ready: string;
+    readonly captcha_check: string;
+    readonly submission_still_working: string;
+    readonly file_preparing: {
+        one: string;
+        other: string;
+    };
+    readonly file_ready: {
+        one: string;
+        other: string;
+    };
+    readonly file_read_error: string;
+    readonly file_read_error_replacement: string;
+    readonly address_error: string;
+    readonly address_searching: string;
+    readonly address_no_results: string;
+    readonly restart: string;
+    readonly chat_messages: string;
+    readonly file_name: string;
+    readonly file_size: string;
+    readonly file_total_size: string;
+    readonly loading: string;
+    readonly minimize: string;
+    readonly submission_redirect_message: "One last step: finish your application on the employer's site.";
+    readonly complete_submission: "Continue on the employer's site";
+    readonly submission_completed: "Submission completed!";
+    readonly submission_pending: "Thanks, we've received your application and are processing it.";
+    readonly submission_provider_maintenance: "Sorry, our recruitment system is down for scheduled maintenance until about {{time}}. Please keep this page open and try again when maintenance ends. We apologise for the inconvenience.";
+    readonly submission_provider_maintenance_later: "Sorry, our recruitment system is down for scheduled maintenance until later today. Please keep this page open and try again when maintenance ends. We apologise for the inconvenience.";
+    readonly submission_available_at: "Submit will be available again at {{time}}.";
+    readonly resume_prompt: "You have an unfinished application for this role. Continue where you left off?";
+    readonly resume_continue: "Continue";
+    readonly resume_start_again: "Start again";
+    readonly captcha_failed: "Cloudflare seems to think you're a robot. If that's not the case, please try again in a moment.";
+    readonly close_application: "Close application";
+    readonly invalid_state: "Invalid application state";
+    readonly redirect_url_error: "Couldn\u2019t get the redirect URL.";
+    readonly upload_file: {
+        readonly one: "Select file to upload";
+        readonly other: "Select files to upload";
+    };
+    readonly file_max_size: "max {{size}}";
+    readonly file_extensions: "Accepted file extensions";
+    readonly address_search: "Type and search for places\u2026";
+    readonly address_manual: "Fill in manually";
+    readonly back: "Back";
+    readonly search: "Search";
+    readonly unknown_error: "An error occurred";
+    readonly line1: "Line 1";
+    readonly line2: "Line 2";
+    readonly line3: "Line 3";
+    readonly city: "City";
+    readonly state: "State";
+    readonly postcode: "Postcode";
+    readonly country: "Country";
+    readonly select_country: "Select a country";
+    readonly validation_empty: "Please enter a value";
+    readonly validation_date: "Please enter a valid date (YYYY-MM-DD)";
+    readonly validation_email: "That doesn\u2019t look like a valid email address";
+    readonly validation_url: "That doesn\u2019t look like a valid URL";
+    readonly validation_max_chars: "Please enter no more than {{count}} characters";
+    readonly validation_min_chars: "Please enter {{count}} or more characters";
+    readonly validation_phone: "Please enter a valid phone number";
+    readonly validation_phone_min_chars: "Your phone number must be at least {{count}} digits long";
+    readonly validation_country_code: "Please select a country code";
+    readonly validation_number: "Please enter a valid number";
+    readonly validation_number_min: "Please enter a number greater than or equal to {{min}}";
+    readonly validation_number_max: "Please enter a number less than or equal to {{max}}";
+    readonly validation_number_whole: "Enter a whole number";
+    readonly validation_number_decimal_cases: "Please enter a number with at most {{count}} decimal cases";
+    readonly validation_file: "Please select a file";
+    readonly validation_file_ext: "Please only upload {{ext}} files";
+    readonly validation_file_min: {
+        readonly one: "Please upload at least one file";
+        readonly other: "Please only upload at least {{count}} files";
+    };
+    readonly validation_file_max: {
+        readonly one: "Please only upload one file";
+        readonly other: "Please only upload up to {{count}} files";
+    };
+    readonly validation_file_size: "Your file is too big. Please upload a file smaller than {{size}}";
+    readonly validation_file_empty: "This file is empty. If it\u2019s saved in iCloud, Google Drive or OneDrive, download it to your device, then select it again.";
+    readonly validation_required: "This field is required.";
+    readonly validation_multiple_choice_min: {
+        readonly one: "Please select at least {{count}} option";
+        readonly other: "Please select at least {{count}} options";
+    };
+    readonly validation_multiple_choice_max: {
+        readonly one: "Please select at most {{count}} option";
+        readonly other: "Please select at most {{count}} options";
+    };
+    readonly optional: "optional";
+} = {
+    readonly error_heading: "Something unexpected happened";
+    readonly flow_closed: "This role is no longer accepting applications.";
+    readonly undo: "Change answer";
+    readonly job_alerts_offer: "Want to hear about similar roles? We can email you at {{email}} when new ones open.";
+    readonly job_alerts_accept: "Get job alerts";
+    readonly job_alerts_decline: "No thanks";
+    readonly job_alerts_privacy: "We'll use your email only for these alerts. You can unsubscribe at any time.";
+    readonly job_alerts_privacy_sender: "{{employer}} will email you new jobs like this one. Every email has an unsubscribe link.";
+    readonly job_alerts_success: "Done. We'll email you about similar roles.";
+    readonly job_alerts_error: "Sorry, we couldn't set that up. Please try again later.";
+    readonly submission_duplicate: "You've already applied for this role, so we haven't submitted a second application. If that doesn't sound right, check your email for a confirmation or try again in a few minutes.";
+    readonly submission_retryable: "We couldn't submit your application. Please try again.";
+    readonly submission_unknown: "We couldn't confirm whether your application was sent. Please check your email for a confirmation. If nothing arrives, choose Restart to apply again.";
+    readonly maximize: "Maximise";
+    readonly submit: "Submit";
+    readonly file_more: {
+        readonly one: "+{{count}} file";
+        readonly other: "+{{count}} files";
+    };
+    readonly conversation_history: string;
+    readonly jump_to_current: string;
+    readonly send: string;
+    readonly submitting: string;
+    readonly skip: string;
+    readonly skipped: string;
+    readonly submission_closed: string;
+    readonly submission_duplicate_earlier_attempt: string;
+    readonly submission_failed: string;
+    readonly submission_unknown_do_not_resubmit: string;
+    readonly submission_unreadable_document: string;
+    readonly submission_cooldown: {
+        one: string;
+        other: string;
+    };
+    readonly submission_cooldown_ready: string;
+    readonly captcha_check: string;
+    readonly submission_still_working: string;
+    readonly file_preparing: {
+        one: string;
+        other: string;
+    };
+    readonly file_ready: {
+        one: string;
+        other: string;
+    };
+    readonly file_read_error: string;
+    readonly file_read_error_replacement: string;
+    readonly address_error: string;
+    readonly address_searching: string;
+    readonly address_no_results: string;
+    readonly restart: string;
+    readonly chat_messages: string;
+    readonly file_name: string;
+    readonly file_size: string;
+    readonly file_total_size: string;
+    readonly loading: string;
+    readonly minimize: string;
+    readonly submission_redirect_message: "One last step: finish your application on the employer's site.";
+    readonly complete_submission: "Continue on the employer's site";
+    readonly submission_completed: "Submission completed!";
+    readonly submission_pending: "Thanks, we've received your application and are processing it.";
+    readonly submission_provider_maintenance: "Sorry, our recruitment system is down for scheduled maintenance until about {{time}}. Please keep this page open and try again when maintenance ends. We apologise for the inconvenience.";
+    readonly submission_provider_maintenance_later: "Sorry, our recruitment system is down for scheduled maintenance until later today. Please keep this page open and try again when maintenance ends. We apologise for the inconvenience.";
+    readonly submission_available_at: "Submit will be available again at {{time}}.";
+    readonly resume_prompt: "You have an unfinished application for this role. Continue where you left off?";
+    readonly resume_continue: "Continue";
+    readonly resume_start_again: "Start again";
+    readonly captcha_failed: "Cloudflare seems to think you're a robot. If that's not the case, please try again in a moment.";
+    readonly close_application: "Close application";
+    readonly invalid_state: "Invalid application state";
+    readonly redirect_url_error: "Couldn\u2019t get the redirect URL.";
+    readonly upload_file: {
+        readonly one: "Select file to upload";
+        readonly other: "Select files to upload";
+    };
+    readonly file_max_size: "max {{size}}";
+    readonly file_extensions: "Accepted file extensions";
+    readonly address_search: "Type and search for places\u2026";
+    readonly address_manual: "Fill in manually";
+    readonly back: "Back";
+    readonly search: "Search";
+    readonly unknown_error: "An error occurred";
+    readonly line1: "Line 1";
+    readonly line2: "Line 2";
+    readonly line3: "Line 3";
+    readonly city: "City";
+    readonly state: "State";
+    readonly postcode: "Postcode";
+    readonly country: "Country";
+    readonly select_country: "Select a country";
+    readonly validation_empty: "Please enter a value";
+    readonly validation_date: "Please enter a valid date (YYYY-MM-DD)";
+    readonly validation_email: "That doesn\u2019t look like a valid email address";
+    readonly validation_url: "That doesn\u2019t look like a valid URL";
+    readonly validation_max_chars: "Please enter no more than {{count}} characters";
+    readonly validation_min_chars: "Please enter {{count}} or more characters";
+    readonly validation_phone: "Please enter a valid phone number";
+    readonly validation_phone_min_chars: "Your phone number must be at least {{count}} digits long";
+    readonly validation_country_code: "Please select a country code";
+    readonly validation_number: "Please enter a valid number";
+    readonly validation_number_min: "Please enter a number greater than or equal to {{min}}";
+    readonly validation_number_max: "Please enter a number less than or equal to {{max}}";
+    readonly validation_number_whole: "Enter a whole number";
+    readonly validation_number_decimal_cases: "Please enter a number with at most {{count}} decimal cases";
+    readonly validation_file: "Please select a file";
+    readonly validation_file_ext: "Please only upload {{ext}} files";
+    readonly validation_file_min: {
+        readonly one: "Please upload at least one file";
+        readonly other: "Please only upload at least {{count}} files";
+    };
+    readonly validation_file_max: {
+        readonly one: "Please only upload one file";
+        readonly other: "Please only upload up to {{count}} files";
+    };
+    readonly validation_file_size: "Your file is too big. Please upload a file smaller than {{size}}";
+    readonly validation_file_empty: "This file is empty. If it\u2019s saved in iCloud, Google Drive or OneDrive, download it to your device, then select it again.";
+    readonly validation_required: "This field is required.";
+    readonly validation_multiple_choice_min: {
+        readonly one: "Please select at least {{count}} option";
+        readonly other: "Please select at least {{count}} options";
+    };
+    readonly validation_multiple_choice_max: {
+        readonly one: "Please select at most {{count}} option";
+        readonly other: "Please select at most {{count}} options";
+    };
+    readonly optional: "optional";
+}>(options: {
+    overrides: Partial<TranslationDict<    {
+    readonly error_heading: "Something unexpected happened";
+    readonly flow_closed: "This role is no longer accepting applications.";
+    readonly undo: "Change answer";
+    readonly job_alerts_offer: "Want to hear about similar roles? We can email you at {{email}} when new ones open.";
+    readonly job_alerts_accept: "Get job alerts";
+    readonly job_alerts_decline: "No thanks";
+    readonly job_alerts_privacy: "We'll use your email only for these alerts. You can unsubscribe at any time.";
+    readonly job_alerts_privacy_sender: "{{employer}} will email you new jobs like this one. Every email has an unsubscribe link.";
+    readonly job_alerts_success: "Done. We'll email you about similar roles.";
+    readonly job_alerts_error: "Sorry, we couldn't set that up. Please try again later.";
+    readonly submission_duplicate: "You've already applied for this role, so we haven't submitted a second application. If that doesn't sound right, check your email for a confirmation or try again in a few minutes.";
+    readonly submission_retryable: "We couldn't submit your application. Please try again.";
+    readonly submission_unknown: "We couldn't confirm whether your application was sent. Please check your email for a confirmation. If nothing arrives, choose Restart to apply again.";
+    readonly maximize: "Maximise";
+    readonly submit: "Submit";
+    readonly file_more: {
+    readonly one: "+{{count}} file";
+    readonly other: "+{{count}} files";
+    };
+    readonly conversation_history: string;
+    readonly jump_to_current: string;
+    readonly send: string;
+    readonly submitting: string;
+    readonly skip: string;
+    readonly skipped: string;
+    readonly submission_closed: string;
+    readonly submission_duplicate_earlier_attempt: string;
+    readonly submission_failed: string;
+    readonly submission_unknown_do_not_resubmit: string;
+    readonly submission_unreadable_document: string;
+    readonly submission_cooldown: {
+    one: string;
+    other: string;
+    };
+    readonly submission_cooldown_ready: string;
+    readonly captcha_check: string;
+    readonly submission_still_working: string;
+    readonly file_preparing: {
+    one: string;
+    other: string;
+    };
+    readonly file_ready: {
+    one: string;
+    other: string;
+    };
+    readonly file_read_error: string;
+    readonly file_read_error_replacement: string;
+    readonly address_error: string;
+    readonly address_searching: string;
+    readonly address_no_results: string;
+    readonly restart: string;
+    readonly chat_messages: string;
+    readonly file_name: string;
+    readonly file_size: string;
+    readonly file_total_size: string;
+    readonly loading: string;
+    readonly minimize: string;
+    readonly submission_redirect_message: "One last step: finish your application on the employer's site.";
+    readonly complete_submission: "Continue on the employer's site";
+    readonly submission_completed: "Submission completed!";
+    readonly submission_pending: "Thanks, we've received your application and are processing it.";
+    readonly submission_provider_maintenance: "Sorry, our recruitment system is down for scheduled maintenance until about {{time}}. Please keep this page open and try again when maintenance ends. We apologise for the inconvenience.";
+    readonly submission_provider_maintenance_later: "Sorry, our recruitment system is down for scheduled maintenance until later today. Please keep this page open and try again when maintenance ends. We apologise for the inconvenience.";
+    readonly submission_available_at: "Submit will be available again at {{time}}.";
+    readonly resume_prompt: "You have an unfinished application for this role. Continue where you left off?";
+    readonly resume_continue: "Continue";
+    readonly resume_start_again: "Start again";
+    readonly captcha_failed: "Cloudflare seems to think you're a robot. If that's not the case, please try again in a moment.";
+    readonly close_application: "Close application";
+    readonly invalid_state: "Invalid application state";
+    readonly redirect_url_error: "Couldn\u2019t get the redirect URL.";
+    readonly upload_file: {
+    readonly one: "Select file to upload";
+    readonly other: "Select files to upload";
+    };
+    readonly file_max_size: "max {{size}}";
+    readonly file_extensions: "Accepted file extensions";
+    readonly address_search: "Type and search for places\u2026";
+    readonly address_manual: "Fill in manually";
+    readonly back: "Back";
+    readonly search: "Search";
+    readonly unknown_error: "An error occurred";
+    readonly line1: "Line 1";
+    readonly line2: "Line 2";
+    readonly line3: "Line 3";
+    readonly city: "City";
+    readonly state: "State";
+    readonly postcode: "Postcode";
+    readonly country: "Country";
+    readonly select_country: "Select a country";
+    readonly validation_empty: "Please enter a value";
+    readonly validation_date: "Please enter a valid date (YYYY-MM-DD)";
+    readonly validation_email: "That doesn\u2019t look like a valid email address";
+    readonly validation_url: "That doesn\u2019t look like a valid URL";
+    readonly validation_max_chars: "Please enter no more than {{count}} characters";
+    readonly validation_min_chars: "Please enter {{count}} or more characters";
+    readonly validation_phone: "Please enter a valid phone number";
+    readonly validation_phone_min_chars: "Your phone number must be at least {{count}} digits long";
+    readonly validation_country_code: "Please select a country code";
+    readonly validation_number: "Please enter a valid number";
+    readonly validation_number_min: "Please enter a number greater than or equal to {{min}}";
+    readonly validation_number_max: "Please enter a number less than or equal to {{max}}";
+    readonly validation_number_whole: "Enter a whole number";
+    readonly validation_number_decimal_cases: "Please enter a number with at most {{count}} decimal cases";
+    readonly validation_file: "Please select a file";
+    readonly validation_file_ext: "Please only upload {{ext}} files";
+    readonly validation_file_min: {
+    readonly one: "Please upload at least one file";
+    readonly other: "Please only upload at least {{count}} files";
+    };
+    readonly validation_file_max: {
+    readonly one: "Please only upload one file";
+    readonly other: "Please only upload up to {{count}} files";
+    };
+    readonly validation_file_size: "Your file is too big. Please upload a file smaller than {{size}}";
+    readonly validation_file_empty: "This file is empty. If it\u2019s saved in iCloud, Google Drive or OneDrive, download it to your device, then select it again.";
+    readonly validation_required: "This field is required.";
+    readonly validation_multiple_choice_min: {
+    readonly one: "Please select at least {{count}} option";
+    readonly other: "Please select at least {{count}} options";
+    };
+    readonly validation_multiple_choice_max: {
+    readonly one: "Please select at most {{count}} option";
+    readonly other: "Please select at most {{count}} options";
+    };
+    readonly optional: "optional";
+    }>>;
+    locale: string | undefined;
+}) => TFn<T>;
+
+/** Given a string with double curly braces, returns the content of all curly braces. */
+declare type ExtractParams<T extends string> = T extends `${infer Head}{{${infer Param}}}${infer Tail}` ? Param | ExtractParams<Tail> : never;
+
+export declare type FetchFlowByIdAdditionalProperties = Partial<OpenChatbotParams>;
+
+export declare type FetchFlowByJobIdAdditionalProperties = Partial<OpenChatbotParams & {
+    /** What type of id to use. Defaults to `ats` */
+    idType: 'inploi' | 'ats';
+}>;
+
+declare type HintedString<KnownValues> = (string & {}) | KnownValues;
+
+declare type InternalChatbotPluginParams = {
+    theme: ChatbotTheme;
+    feedback?: ChatbotFeedback;
+    terms?: ChatbotTranslationTerms;
+    /** Offer email alerts after a submitted application reports that the role closed. */
+    jobAlerts?: boolean;
+    /** @deprecated For internal usage only */
+    _internal_domManager?: ChatbotDomManager;
+};
+
+export declare type OpenChatbotParams = {
+    /** Overrides the plugin's job-alert offer for this application. */
+    jobAlerts?: boolean;
+    /** The application flow to be interpreted */
+    flow: Flow;
+    /** Specify the cache keys for restoring this flow from local state.
+     *  This will be appended *in addition* to the flow id and version passed to `flow` property.
+     *  @example [job.id] if you want the flows to be unique per job.
+     */
+    flowKeys: string[];
+    analytics?: {
+        /** Data to be forwarded to analytics events as custom properties. */
+        customProperties?: Record<string, unknown>;
+    };
+    /** Job context returned by the API; host context wins at every leaf. */
+    jobContext?: Record<string, unknown>;
+    /** Host context to be used by nodes internally and to identify saved drafts. */
+    context?: Record<string, unknown>;
+    /** Title to display in the status bar */
+    title: string;
+    /** Who sends the job alerts the closed-role offer sets up: the api's company name, which their emails come from. */
+    employer?: string;
+    job?: {
+        id: string;
+        /** Whether the job id is an internal (inploi) or external.
+         *  Use `external` if unsure */
+        id_type: 'internal' | 'external';
+    };
+    /** Coordinates used to order address suggestions by proximity */
+    locationOrigin?: {
+        lat?: number;
+        lng?: number;
+    };
+};
+
+declare type RemoveInternal<T extends object> = {
+    [P in keyof T as string extends P ? never : P extends `_${string}` ? never : P]: T[P];
+};
+
+declare type Terms = Record<string, string | TranslationWithPlurals>;
+
+declare interface TFn<TTerms extends Terms> {
+    <K extends TranslationKeyWithParams<TTerms>>(key: K, options: TTerms[K] extends string ? {
+        [_Term in ExtractParams<TTerms[K]>]: number | string;
+    } : {
+        [_Term in ExtractParams<TTerms[K][keyof TTerms[K]] & string> | 'count']: number | string;
+    }): string;
+    <T extends Exclude<keyof (keyof TranslationDict<TTerms>), TranslationKeyWithParams<TTerms>>>(key: T): string;
+    <T extends keyof TranslationDict<TTerms>>(key: T, options?: {
+        [key: string]: string | number;
+    }): string;
+}
+
+declare type TranslationDict<TTerms extends Terms> = {
+    [K in keyof TTerms]: TTerms[K] extends TranslationWithPlurals ? {
+        [J in keyof TTerms[K]]: HintedString<TTerms[K][J]>;
+    } : HintedString<TTerms[K]>;
+};
+
+declare type TranslationKeyWithParams<TTerms extends Terms> = {
+    [K in keyof TTerms]: TTerms[K] extends TranslationWithPlurals ? K : ExtractParams<TTerms[K] & string> extends never ? never : K;
+}[keyof TranslationDict<TTerms>];
+
+declare type TranslationWithPlurals = Partial<Record<Intl.LDMLPluralRule, string>>;
+
+export { }