@pitcher/js-api 1.28.0 → 1.29.0

package/lib/sdk/payload.types.d.ts

@@ -662,3 +662,183 @@ export interface PiaSearchAnswerResult {
      */
     source: 'on_device' | 'online';
 }
+/**
+ * Error codes returned on a rejected `stt.start` / `stt.stop` — cross-platform
+ * (iOS bridge AND the web host engines). Surfaced verbatim in the rejected
+ * request's error body (iOS: `error_code`/`errorCode`; web: the error `message` /
+ * `reason` string — read them uniformly via `api.sttErrorCode`).
+ *
+ * - `STT_DISABLED` — the `enable_stt_dictation` config flag is off for this instance.
+ * - `STT_DEVICE_UNSUPPORTED` — the device can't run the on-device model.
+ * - `STT_MODEL_NOT_READY` — the whisper model isn't downloaded yet. Trigger a
+ *   model download (`ai.download_model` with `"whisper"`), then retry `stt.start`.
+ * - `STT_BUSY` — the mic is held by another session (a live call recording, or
+ *   another dictation). Surface a "mic in use" hint / prompt to stop the other session.
+ * - `STT_MIC_PERMISSION_DENIED` — microphone permission was denied.
+ * - `STT_NOT_RECORDING` — `stt.stop` for a `session_id` that isn't active.
+ * - `STT_CAPTURE_FAILED` / `STT_ERROR` — generic capture / other failure.
+ */
+export type SttErrorCode = 'STT_DISABLED' | 'STT_DEVICE_UNSUPPORTED' | 'STT_MODEL_NOT_READY' | 'STT_BUSY' | 'STT_MIC_PERMISSION_DENIED' | 'STT_NOT_RECORDING' | 'STT_CAPTURE_FAILED' | 'STT_ERROR';
+/**
+ * Payload for `stt.start` — cross-platform (identical shape on iOS and web).
+ * Keys are already snake_case, so `LowLevelApi`'s `snakeCaseKeys` transform is a
+ * no-op (no `RAW_PAYLOAD_METHODS` entry needed; the `vocabulary` string values
+ * are left untouched by the key-only transform).
+ */
+export interface SttStartPayload {
+    /**
+     * Caller-chosen session id. All `stt.partial` / `stt.interrupted` events and
+     * the matching `stt.stop` are keyed by it. Re-starting with the same id
+     * replaces that session.
+     */
+    session_id: string;
+    /**
+     * ISO 639-1 code (e.g. `"en"`) to force a language. Omit/`null` for
+     * auto-detect (the default, like native iOS dictation).
+     */
+    language?: string | null;
+    /**
+     * Proper nouns likely to be spoken (the current call's CRM contact / account
+     * / product names). Biases recognition toward correct spelling (e.g.
+     * "Dr. Sarah O'Brien" instead of "Dr. Starwhop Brine"). Send the relevant
+     * names, not the whole CRM — it's length-capped on the native side.
+     */
+    vocabulary?: string[];
+}
+/**
+ * Payload for `stt.stop` — cross-platform.
+ */
+export interface SttStopPayload {
+    /**
+     * The `session_id` passed to the matching `stt.start`.
+     */
+    session_id: string;
+}
+/**
+ * Result of `stt.stop` — cross-platform.
+ */
+export interface SttStopResult {
+    /**
+     * The final, full transcript for the session.
+     */
+    transcript: string;
+}
+/**
+ * Body of the `stt.partial` event (host → JS; native bridge on iOS, the Impact
+ * host engine on web). Fires roughly every ~2s while recording.
+ */
+export interface SttPartialEvent {
+    /**
+     * Session the partial belongs to.
+     */
+    session_id: string;
+    /**
+     * The FULL transcript so far — NOT a delta. Replace the field's dictation
+     * content with it, don't append.
+     */
+    text: string;
+    /**
+     * Per-session monotonic counter (only advances when `text` changes) for
+     * ordering / de-dupe.
+     */
+    index: number;
+}
+/**
+ * Body of the `stt.interrupted` event (host → JS; native bridge on iOS, the
+ * Impact host engine on web). Fires only when a session ends WITHOUT a
+ * `stt.stop` — a normal `stt.stop` does NOT fire this.
+ */
+export interface SttInterruptedEvent {
+    /**
+     * Session that was interrupted.
+     */
+    session_id: string;
+    /**
+     * Why the session ended — an opaque, host-specific string; don't parse it,
+     * just stop waiting for partials and reset the field. Known values:
+     * - iOS: `"preempted"` — a higher-priority call recording took the mic.
+     * - web: `"error:capture_ended"` (mic/track ended), `"error:<code>"` (a fatal
+     *   Web Speech recognition error, e.g. `"error:network"`), `"error:restart_failed"`.
+     */
+    reason: string;
+}
+/**
+ * Which engine answers `stt.start` on the current platform: `"native"` (iOS
+ * on-device Speech), `"whisper"` (web on-device Whisper) or `"webspeech"` (web
+ * cloud fallback, audio leaves the device).
+ */
+export type SttEngineKind = 'native' | 'whisper' | 'webspeech';
+/**
+ * Why dictation is unavailable: `"disabled"` (the `enable_stt_dictation`
+ * instance flag is off) or `"unsupported"` (no engine can run on this device).
+ */
+export type SttUnavailableReason = 'disabled' | 'unsupported';
+/**
+ * Result of `stt.availability` — a side-effect-free capability check an app
+ * should call BEFORE offering a mic button. It does NOT prompt for the
+ * microphone or download any model; it only reports whether dictation could be
+ * started, so the UI can hide/disable the control up front.
+ */
+export interface SttAvailabilityResult {
+    /**
+     * Dictation can be started right now — the feature is enabled AND an engine
+     * can run on this device.
+     */
+    available: boolean;
+    /**
+     * The engine that would answer `stt.start`, or `null` when unavailable. Note
+     * `"webspeech"` sends audio off-device, so a UI may want to reflect that.
+     */
+    engine: SttEngineKind | null;
+    /**
+     * Present when `available` is `false`: `"disabled"` (feature flag off) or
+     * `"unsupported"` (no engine on this device / browser).
+     */
+    reason?: SttUnavailableReason;
+}
+/**
+ * Error codes returned on `tts.speak` — as a bridge APIError
+ * (`{ code, message, details }`) on iOS, or in the host `{ reason }` on web.
+ *
+ * - `TTS_EMPTY_TEXT` — no text was provided.
+ * - `TTS_VOICE_UNAVAILABLE` — a `language` was requested but no installed voice
+ *   matches. The message tells the user to download it (iOS Settings ›
+ *   Accessibility › Spoken Content › Voices) — surface it so the UI can prompt.
+ * - `TTS_ERROR` — unexpected fallback.
+ */
+export type TtsErrorCode = 'TTS_EMPTY_TEXT' | 'TTS_VOICE_UNAVAILABLE' | 'TTS_ERROR';
+/**
+ * Payload for `tts.speak`. The exact native wire contract — keys are single
+ * words, so LowLevelApi's `snakeCaseKeys` transform is a no-op; no
+ * `RAW_PAYLOAD_METHODS` entry is needed.
+ */
+export interface TtsSpeakPayload {
+    /**
+     * The text to speak. Empty/whitespace rejects with `TTS_EMPTY_TEXT`.
+     */
+    text: string;
+    /**
+     * BCP-47/ISO language tag (e.g. `"en-US"`). If given, an installed offline
+     * voice is required, else the call rejects with `TTS_VOICE_UNAVAILABLE`. Omit
+     * to use the system voice.
+     */
+    language?: string;
+    /**
+     * Speech rate; clamped to the platform min…max.
+     */
+    rate?: number;
+    /**
+     * Speech pitch; clamped `0.5`…`2.0` (`1.0` = normal).
+     */
+    pitch?: number;
+}
+/**
+ * Result of `tts.speak`. The promise resolves when the utterance FINISHES.
+ */
+export interface TtsSpeakResult {
+    /**
+     * `true` → finished speaking naturally; `false` → it was stopped (`tts.stop`)
+     * or replaced by a newer `tts.speak` (only one utterance is active at a time).
+     */
+    completed: boolean;
+}

package/lib/types/canvases.d.ts

@@ -1,4 +1,3 @@
-import { CanvasRetrieve, User } from '../../types/openapi';
 export interface GetCanvasesParams {
     search?: string;
     account__id?: string;
@@ -19,11 +18,9 @@ export interface GetCanvasesParams {
     template__id?: string;
 }
 export interface CanvasMetadataRetrieve {
-    canvas_id: CanvasRetrieve['id'];
     config: Record<string, any> & {
         presentation_component_metadata: Record<string, any>;
     };
-    owner_id: User['id'];
 }
 export declare enum CanvasesViewsTypes {
     SAVED = "saved",

package/lib/types/launchDarkly.types.d.ts

@@ -1,4 +1,4 @@
-export type LaunchDarklyBooleanFlagKey = 'ai_image_generation_model' | 'ai_video_generation_model' | 'allow_ai_prompts_in_canvas_text' | 'allow_bulk_actions_canvases_files' | 'allow_content_grid_autofill' | 'allow_canvas_duplication' | 'allow_canvases_tables_columns_settings' | 'allow_table_column_resizing' | 'allow_creating_canvas_with_no_template' | 'allow_dynamic_data_table_for_scribble_component' | 'allow_html_for_scribble_component' | 'allow_embeddable_for_scribble_component' | 'allow_embeddable_hiding' | 'allow_multimedia_for_scribble_component' | 'allow_note_taking' | 'allow_rep_canvas_metadata_edit' | 'allow_rep_file_distributions' | 'allow_rep_file_rating' | 'allow_rep_file_upload' | 'allow_saving_annotations_in_personal_layer' | 'allow_user_to_edit_font_size_and_color_in_canvas_tokens' | 'are_sections_system_controlled' | 'enable_canvas_core_distributions' | 'copy_context_to_canvas' | 'copy_template_metadata_to_canvas' | 'disable_canvas_edit_for_reps' | 'disable_custom_tooltips' | 'disable_file_edit_content' | 'enable_inline_wopi_edit_button' | 'disable_fullscreen_canvas_builder' | 'disable_impact_web_browser_fullscreen' | 'disable_user_invitations' | 'display_section_list_name' | 'disable_download_canvas' | 'enable_ai_generated_thumbnails' | 'enable_analytics' | 'enable_app_developer_role' | 'enable_algolia_search' | 'enable_background_image_theme_options' | 'enable_better_canvas_builder_control_bars_on_zoom' | 'enable_bulk_update_file_attributes' | 'enable_canvas_as_home' | 'enable_canvas_blocks' | 'enable_canvas_node_debugging' | 'enable_canvas_freeze' | 'enable_canvas_locks' | 'enable_canvas_template_edit_in_impact' | 'enable_canvas_tokens' | 'enable_collaborations' | 'enable_collection_player_data_accessor' | 'enable_content_grid_data_accessor' | 'enable_content_type_change_in_content_selector' | 'enable_cross_tab_instance_reload_for_ld_sync' | 'enable_create_section_from_section_template' | 'enable_custom_display_overrides' | 'enable_default_crm_shape' | 'enable_detailed_date_format' | 'enable_dsr_readonly_annotations' | 'enable_dnd_html_editor' | 'enable_dynamic_content_component' | 'enable_dynamic_data_table_component' | 'enable_custom_data_tables' | 'enable_embedded_video_autoplay' | 'enable_embedded_video' | 'enable_enhanced_canvas_drawer_app' | 'enable_enhanced_indicators' | 'enable_enhanced_section_execution_states' | 'enable_experimental_canvas_builder_dnd' | 'enable_extra_file_data' | 'enable_file_copy' | 'enable_file_pages_metadata' | 'enable_file_revisions' | 'enable_file_divisible_permission' | 'enable_folder_details_edit' | 'enable_folder_distributions' | 'enable_handlebar_template_support' | 'enable_height_in_component_theming' | 'enable_home_customization' | 'enable_hotspot_visibility' | 'enable_improved_canvas_node_updating' | 'enable_individual_users_in_file_distribution' | 'enable_inline_filter_options' | 'enable_insearch_in_section_selector' | 'enable_instance_cloner' | 'enable_advanced_cloner' | 'enable_content_promotion' | 'enable_instance_editor_role' | 'enable_instance_navigation_from_management' | 'enable_knock_notifications' | 'enable_maintain_section_theme_control' | 'enable_metadata_in_file_uploads_with_default_values' | 'enable_more_intuitive_component_spacing' | 'enable_multi_destination_upload' | 'enable_multimedia_component_ai_images' | 'enable_new_meeting_bar' | 'enable_provider_agnostic_meeting_bar' | 'enable_original_pdf_link' | 'enable_scale_content' | 'enable_sorting_in_tiptap_table' | 'enable_theme_assets' | 'enable_toc_enhancements_to_support_same_section_in_section_list' | 'enable_pia_assistant' | 'enable_pipe_character_multi_search' | 'enable_popup_apps' | 'enable_pre_send_validation' | 'enable_reorder_search' | 'enable_reorder_scribble_isolation' | 'enable_reorder_component_options_menu' | 'enable_resizable_multimedia_component' | 'enable_responsive_scribble_component' | 'enable_saved_canvases_filters' | 'enable_short_tag_column_in_tables' | 'enable_scribble_component' | 'enable_scribble_content_as_background' | 'enable_search_and_filters_in_multimedia_component' | 'enable_section_context_in_dsr' | 'enable_selectors_dnd' | 'enable_section_selector_edit_section' | 'enable_smart_folders' | 'enable_smart_folders_for_sections' | 'enable_smart_folders_in_section_selector' | 'enable_smart_folders_in_files' | 'enable_sorting_in_sections' | 'enable_suggested_tags' | 'enable_template_component_permissions' | 'enable_template_folders' | 'enable_theme_options_border_radius' | 'enable_themes' | 'hide_asset_uploader' | 'hide_user_feedback_widget' | 'include_files_content_in_print' | 'interpolate_rep_canvases_on_edit_mode' | 'is_timeline_component_allowed' | 'launch_in_full_screen_on_present_mode' | 'prefer_online_handlers' | 'restrict_owned_files_from_admins' | 'show_asset_manager_for_multimedia' | 'show_clear_all_annotations_button' | 'show_content_selector_list_view' | 'show_metadata_filters_in_all_canvas_things' | 'show_only_preview_mode_for_html_component' | 'show_popularity_icons' | 'use_core_endpoint_for_analytics' | 'convert_pptx_to_section_with_scribble_pdfjs' | 'use_short_url_for_shared_link' | 'use_zoho_instead_of_ms_wopi' | 'enable_new_section_list' | 'enable_sharebox_apps' | 'enable_sharebox_bulk_filtering' | 'enable_back_to_previous_location_in_canvas' | 'enable_crm_shape_for_external_links' | 'enable_adaptive_popup_apps' | 'enable_file_version_polling' | 'skip_pspdfkit_wait_for_high_res_thumbs' | 'enable_reactive_scribble_component_toolbar' | 'enable_embeddable_full_screen_mode' | 'enable_enhanced_user_management' | 'enable_impersonation' | 'enable_instance_admin_user_assignment' | 'keep_static_pptx_editable' | 'enable_canvas_pdf_dimensions' | 'enable_editable_pptx_of_canvas' | 'enable_editable_pptx_of_canvas_with_fonts' | 'enable_aspose_pptx_of_canvas' | 'enable_canvas_control_bars_collapse' | 'enable_rep_app_visibility_order' | 'enable_file_sharing_print_permissions' | 'enable_section_sharing_print_permissions' | 'enable_marketplace_tab' | 'enable_sfdc_account_visibility_for_canvases' | 'sfdc_offline_enabled' | 'enable_granular_permissions' | 'enable_hub_collections' | 'enable_hub_recommended_smart_folder' | 'enable_custom_user_properties';
+export type LaunchDarklyBooleanFlagKey = 'ai_image_generation_model' | 'ai_video_generation_model' | 'allow_ai_prompts_in_canvas_text' | 'allow_bulk_actions_canvases_files' | 'allow_content_grid_autofill' | 'allow_canvas_duplication' | 'allow_canvases_tables_columns_settings' | 'allow_table_column_resizing' | 'allow_creating_canvas_with_no_template' | 'allow_dynamic_data_table_for_scribble_component' | 'allow_html_for_scribble_component' | 'allow_embeddable_for_scribble_component' | 'allow_embeddable_hiding' | 'allow_multimedia_for_scribble_component' | 'allow_note_taking' | 'allow_rep_canvas_metadata_edit' | 'allow_rep_file_distributions' | 'allow_rep_file_rating' | 'allow_rep_file_upload' | 'allow_saving_annotations_in_personal_layer' | 'allow_user_to_edit_font_size_and_color_in_canvas_tokens' | 'are_sections_system_controlled' | 'enable_canvas_core_distributions' | 'copy_context_to_canvas' | 'copy_template_metadata_to_canvas' | 'disable_canvas_edit_for_reps' | 'disable_custom_tooltips' | 'disable_file_edit_content' | 'enable_inline_wopi_edit_button' | 'disable_fullscreen_canvas_builder' | 'disable_impact_web_browser_fullscreen' | 'disable_user_invitations' | 'display_section_list_name' | 'disable_download_canvas' | 'enable_ai_generated_thumbnails' | 'enable_analytics' | 'enable_app_developer_role' | 'enable_algolia_search' | 'enable_background_image_theme_options' | 'enable_better_canvas_builder_control_bars_on_zoom' | 'enable_bulk_update_file_attributes' | 'enable_canvas_as_home' | 'enable_canvas_blocks' | 'enable_canvas_node_debugging' | 'enable_canvas_freeze' | 'enable_canvas_locks' | 'enable_canvas_template_edit_in_impact' | 'enable_canvas_tokens' | 'enable_collaborations' | 'enable_collection_player_data_accessor' | 'enable_content_grid_data_accessor' | 'enable_content_type_change_in_content_selector' | 'enable_cross_tab_instance_reload_for_ld_sync' | 'enable_create_section_from_section_template' | 'enable_custom_display_overrides' | 'enable_default_crm_shape' | 'enable_detailed_date_format' | 'enable_dsr_readonly_annotations' | 'enable_dnd_html_editor' | 'enable_dynamic_content_component' | 'enable_dynamic_data_table_component' | 'enable_custom_data_tables' | 'enable_embedded_video_autoplay' | 'enable_embedded_video' | 'enable_enhanced_canvas_drawer_app' | 'enable_enhanced_indicators' | 'enable_enhanced_section_execution_states' | 'enable_experimental_canvas_builder_dnd' | 'enable_extra_file_data' | 'enable_file_copy' | 'enable_file_pages_metadata' | 'enable_file_revisions' | 'enable_file_divisible_permission' | 'enable_folder_details_edit' | 'enable_folder_distributions' | 'enable_handlebar_template_support' | 'enable_height_in_component_theming' | 'enable_home_customization' | 'enable_hotspot_visibility' | 'enable_improved_canvas_node_updating' | 'enable_individual_users_in_file_distribution' | 'enable_inline_filter_options' | 'enable_insearch_in_section_selector' | 'enable_instance_cloner' | 'enable_advanced_cloner' | 'enable_content_promotion' | 'enable_instance_editor_role' | 'enable_instance_navigation_from_management' | 'enable_knock_notifications' | 'enable_maintain_section_theme_control' | 'enable_metadata_in_file_uploads_with_default_values' | 'enable_more_intuitive_component_spacing' | 'enable_multi_destination_upload' | 'enable_multimedia_component_ai_images' | 'enable_new_meeting_bar' | 'enable_provider_agnostic_meeting_bar' | 'enable_original_pdf_link' | 'enable_scale_content' | 'enable_sorting_in_tiptap_table' | 'enable_stt_dictation' | 'enable_cloud_stt_fallback' | 'enable_theme_assets' | 'enable_toc_enhancements_to_support_same_section_in_section_list' | 'enable_pia_assistant' | 'enable_pipe_character_multi_search' | 'enable_popup_apps' | 'enable_pre_send_validation' | 'enable_reorder_search' | 'enable_reorder_scribble_isolation' | 'enable_reorder_component_options_menu' | 'enable_resizable_multimedia_component' | 'enable_responsive_scribble_component' | 'enable_saved_canvases_filters' | 'enable_short_tag_column_in_tables' | 'enable_scribble_component' | 'enable_scribble_content_as_background' | 'enable_search_and_filters_in_multimedia_component' | 'enable_section_context_in_dsr' | 'enable_selectors_dnd' | 'enable_section_selector_edit_section' | 'enable_smart_folders' | 'enable_smart_folders_for_sections' | 'enable_smart_folders_in_section_selector' | 'enable_smart_folders_in_files' | 'enable_sorting_in_sections' | 'enable_suggested_tags' | 'enable_template_component_permissions' | 'enable_template_folders' | 'enable_theme_options_border_radius' | 'enable_themes' | 'hide_asset_uploader' | 'hide_user_feedback_widget' | 'include_files_content_in_print' | 'interpolate_rep_canvases_on_edit_mode' | 'is_timeline_component_allowed' | 'launch_in_full_screen_on_present_mode' | 'prefer_online_handlers' | 'restrict_owned_files_from_admins' | 'show_asset_manager_for_multimedia' | 'show_clear_all_annotations_button' | 'show_content_selector_list_view' | 'show_metadata_filters_in_all_canvas_things' | 'show_only_preview_mode_for_html_component' | 'show_popularity_icons' | 'use_core_endpoint_for_analytics' | 'convert_pptx_to_section_with_scribble_pdfjs' | 'use_short_url_for_shared_link' | 'use_zoho_instead_of_ms_wopi' | 'enable_new_section_list' | 'enable_sharebox_apps' | 'enable_sharebox_bulk_filtering' | 'enable_back_to_previous_location_in_canvas' | 'enable_crm_shape_for_external_links' | 'enable_adaptive_popup_apps' | 'enable_file_version_polling' | 'skip_pspdfkit_wait_for_high_res_thumbs' | 'skip_pspdfkit_tile_size_workaround' | 'enable_reactive_scribble_component_toolbar' | 'enable_embeddable_full_screen_mode' | 'enable_enhanced_user_management' | 'enable_impersonation' | 'enable_instance_admin_user_assignment' | 'keep_static_pptx_editable' | 'enable_canvas_pdf_dimensions' | 'enable_editable_pptx_of_canvas' | 'enable_editable_pptx_of_canvas_with_fonts' | 'enable_aspose_pptx_of_canvas' | 'enable_canvas_control_bars_collapse' | 'enable_rep_app_visibility_order' | 'enable_file_sharing_print_permissions' | 'enable_section_sharing_print_permissions' | 'enable_marketplace_tab' | 'enable_sfdc_account_visibility_for_canvases' | 'sfdc_offline_enabled' | 'enable_granular_permissions' | 'enable_hub_collections' | 'enable_hub_recommended_smart_folder' | 'enable_custom_user_properties';
 export type LaunchDarklyNumberFlagKey = 'canvas_section_selector_page_size' | 'canvas_section_selector_selected_items_with_thumbnail_size';
 /** How PIA Search serves inference (PIT-6863). */
 export type PiaSearchMode = 'off' | 'on_device' | 'online';

package/lib/types/sfdc.d.ts

@@ -96,6 +96,21 @@ export type SfContact = {
     MailingAddress?: string;
     Phone?: string;
 };
+/**
+ * Meeting-bar contacts live in a dual id-space: `Id` is the roster record the
+ * user picked — a standard Contact (`003…`) when the org's
+ * `contact_visibility_query` targets Contact, or a custom-object record (e.g.
+ * Demant's `Contact_Customer_Detail__c`, `a1i…`). `ContactMirrorId` is the
+ * standard Contact (`003…`) the roster record mirrors (its `Contact__r`
+ * lookup), when known — the only id that may ever be written to
+ * `Event.WhoId` / `EventWhoIds`. For standard-Contact rosters the roster id IS
+ * the mirror id. Hoisted in slotty-ui-ng's `resolveCustomAccountRelation`;
+ * synthetic (never written back to Salesforce), deliberately not `__c`-suffixed
+ * so it can't collide with a real custom field API name. PIT-7250.
+ */
+export type SfRosterContact = SfContact & {
+    ContactMirrorId?: string | null;
+};
 export interface SfContactBasic {
     AccountId: string;
     Email: string;

package/lib/util/soql.util.d.ts

@@ -1,4 +1,40 @@
+/**
+ * Escape a user-typed search term for interpolation into a SOQL LIKE pattern or
+ * SOSL FIND term. Escapes the LIKE wildcards `%` and `_` in addition to quotes
+ * and control characters — do NOT use it for equality/IN comparison values,
+ * where escaping the wildcards would change the compared value; use
+ * `soqlLiteral` / `soqlIn` / `soqlEq` for those.
+ */
 export declare const escapeSoqlString: (input: string) => string;
+/**
+ * Quote a value as a SOQL string literal for equality/IN comparisons, e.g.
+ * `WHERE Id = ${soqlLiteral(id)}`. Escapes backslashes (first, so escaped
+ * quotes aren't doubled), single quotes, and newline/tab control characters.
+ * Deliberately does NOT escape the LIKE wildcards `%`/`_` — inside an equality
+ * literal those are ordinary characters, and escaping them would change the
+ * compared value. For LIKE patterns / SOSL FIND terms use `escapeSoqlString`.
+ */
+export declare const soqlLiteral: (value: string) => string;
+/**
+ * Build the parenthesized value list for a SOQL IN clause, e.g.
+ * `WHERE Id IN ${soqlIn(ids)}`. An empty input yields `('')` — valid SOQL that
+ * matches no record — so callers don't need an empty-array branch.
+ */
+export declare const soqlIn: (values: string[]) => string;
+/**
+ * True when `name` is a plain SObject field API name (letters, digits,
+ * underscores, leading letter). Field identifiers cannot be escaped as string
+ * literals, so anything interpolated as a field/relationship name must pass
+ * this gate (relationship paths like `Contact__r.Id` need each dotted segment
+ * validated separately).
+ */
+export declare const isSoqlFieldIdentifier: (name: string) => boolean;
+/**
+ * Build a `field = 'value'` SOQL condition with the field validated via
+ * `isSoqlFieldIdentifier` and the value quoted via `soqlLiteral`. Throws on an
+ * invalid field name — field identifiers cannot be escaped, only rejected.
+ */
+export declare const soqlEq: (field: string, value: string) => string;
 export declare const convertToSosl: (soqlQuery: string, searchString: string, searchInField?: string) => string | null;
 export interface AccountSortPriority {
     field: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pitcher/js-api",
-  "version": "1.28.0",
+  "version": "1.29.0",
   "type": "module",
   "main": "js-api.umd.min.js",
   "module": "js-api.esm.js",

package/types/openapi/index.d.ts

@@ -134,7 +134,6 @@ export type { InstanceUpdateRequest } from './models/InstanceUpdateRequest';
 export type { Invitation } from './models/Invitation';
 export type { InvitationRequest } from './models/InvitationRequest';
 export { InvitationStatusEnum } from './models/InvitationStatusEnum';
-export { LanguageEnum } from './models/LanguageEnum';
 export type { MetadataTemplate } from './models/MetadataTemplate';
 export type { MetadataTemplateField } from './models/MetadataTemplateField';
 export type { MetadataTemplateFieldRequest } from './models/MetadataTemplateFieldRequest';

package/types/openapi/models/PatchedUserRequest.d.ts

@@ -1,10 +1,9 @@
-import { LanguageEnum } from './LanguageEnum';
 import { UserRoleEnum } from './UserRoleEnum';
 export type PatchedUserRequest = {
     first_name?: string;
     last_name?: string;
     role?: UserRoleEnum;
-    language?: LanguageEnum;
+    language?: string;
     preferred_username?: string;
     timezone?: string;
     tags?: Array<string> | null;

package/types/openapi/models/User.d.ts

@@ -1,5 +1,4 @@
 import { ConnectedService } from './ConnectedService';
-import { LanguageEnum } from './LanguageEnum';
 import { UserRoleEnum } from './UserRoleEnum';
 export type User = {
     readonly id: number;
@@ -16,7 +15,7 @@ export type User = {
     readonly deactivated_at: string | null;
     readonly activated_at: string | null;
     readonly is_active: boolean;
-    language?: LanguageEnum;
+    language?: string;
     readonly connected_services: Array<ConnectedService>;
     preferred_username?: string;
     readonly picture: string | null;

package/types/openapi/models/UserRequest.d.ts

@@ -1,10 +1,9 @@
-import { LanguageEnum } from './LanguageEnum';
 import { UserRoleEnum } from './UserRoleEnum';
 export type UserRequest = {
     first_name?: string;
     last_name?: string;
     role?: UserRoleEnum;
-    language?: LanguageEnum;
+    language?: string;
     preferred_username?: string;
     timezone?: string;
     tags?: Array<string> | null;

package/lib/sdk/api/modules/languages.d.ts

@@ -1,8 +0,0 @@
-export type Language = [
-    string,
-    string
-];
-/**
- * Fetches available languages for the logged-in user
- */
-export declare function getLanguages(): Promise<Language[]>;

package/types/openapi/models/LanguageEnum.d.ts

@@ -1,12 +0,0 @@
-/**
- * * `en` - English
- * * `de` - Deutsch
- * * `pl` - Polski
- * * `tr` - Türkçe
- */
-export declare enum LanguageEnum {
-    EN = "en",
-    DE = "de",
-    PL = "pl",
-    TR = "tr"
-}