onehook-api-client 1.0.18 → 1.0.20

package/dist-types/telemetry/index.d.ts

@@ -0,0 +1,413 @@
+export declare const TELEMETRY_CATALOG_VERSION = "1.3.0";
+export declare const TELEMETRY_CATALOG_HASH = "25955dd2f9856888";
+/** Every signal type the ingest accepts. */
+export declare const SignalType: {
+    readonly SCREEN_VIEW: "screen_view";
+    readonly UI_INTERACTION: "ui_interaction";
+    readonly CARD_IMPRESSION: "card_impression";
+    readonly CARD_SWIPE_UI: "card_swipe_ui";
+    readonly PROMPT_VIEW: "prompt_view";
+    readonly MEDIA_VIEW: "media_view";
+    readonly MEDIA_FULLSCREEN_OPEN: "media_fullscreen_open";
+    readonly SECTION_VIEW: "section_view";
+    readonly NOTIFICATION_OPENED: "notification_opened";
+    readonly SESSION_HEARTBEAT: "session_heartbeat";
+    readonly LIKE_COMPOSER_OPEN: "like_composer_open";
+    readonly LIKE_COMMENT_ABANDONED: "like_comment_abandoned";
+    readonly CONVERSATION_OPENED: "conversation_opened";
+    readonly COMPOSE_ABANDONED: "compose_abandoned";
+    readonly PROFILE_REVISIT: "profile_revisit";
+    readonly HOOKED_STATE_VIEW: "hooked_state_view";
+    readonly LIKES_YOU_VIEW: "likes_you_view";
+    readonly SAFETY_UI_OPEN: "safety_ui_open";
+};
+export type SignalType = (typeof SignalType)[keyof typeof SignalType];
+/** Client platform (from the X-OneHook-Platform header). */
+export declare const Platform: {
+    readonly WEB: "web";
+    readonly IOS: "ios";
+    readonly ANDROID: "android";
+};
+export type Platform = (typeof Platform)[keyof typeof Platform];
+/** Any product surface (incl. non-viewable chrome). */
+export declare const Screen: {
+    readonly NAV: "NAV";
+    readonly LANDING: "LANDING";
+    readonly LOGIN: "LOGIN";
+    readonly REDEEM_INVITE: "REDEEM_INVITE";
+    readonly ONBOARDING: "ONBOARDING";
+    readonly DISCOVER: "DISCOVER";
+    readonly LIKE_COMPOSER: "LIKE_COMPOSER";
+    readonly LIKES_YOU: "LIKES_YOU";
+    readonly CHAT: "CHAT";
+    readonly CHAT_SETTINGS: "CHAT_SETTINGS";
+    readonly NOTIFICATIONS: "NOTIFICATIONS";
+    readonly PROFILE: "PROFILE";
+    readonly PROFILE_EDIT: "PROFILE_EDIT";
+    readonly PROFILE_PREVIEW: "PROFILE_PREVIEW";
+    readonly PREFERENCES: "PREFERENCES";
+    readonly SETTINGS: "SETTINGS";
+    readonly PAYWALL: "PAYWALL";
+    readonly LIVENESS: "LIVENESS";
+    readonly PHOTO_VIEWER: "PHOTO_VIEWER";
+    readonly SEARCH: "SEARCH";
+    readonly CREATE: "CREATE";
+    readonly SHARED: "SHARED";
+};
+export type Screen = (typeof Screen)[keyof typeof Screen];
+/** A surface that can be the subject of screen_view, or the `context` of another signal. */
+export declare const ViewableScreen: {
+    readonly LANDING: "LANDING";
+    readonly LOGIN: "LOGIN";
+    readonly REDEEM_INVITE: "REDEEM_INVITE";
+    readonly ONBOARDING: "ONBOARDING";
+    readonly DISCOVER: "DISCOVER";
+    readonly LIKE_COMPOSER: "LIKE_COMPOSER";
+    readonly LIKES_YOU: "LIKES_YOU";
+    readonly CHAT: "CHAT";
+    readonly CHAT_SETTINGS: "CHAT_SETTINGS";
+    readonly NOTIFICATIONS: "NOTIFICATIONS";
+    readonly PROFILE: "PROFILE";
+    readonly PROFILE_EDIT: "PROFILE_EDIT";
+    readonly PROFILE_PREVIEW: "PROFILE_PREVIEW";
+    readonly PREFERENCES: "PREFERENCES";
+    readonly SETTINGS: "SETTINGS";
+    readonly PAYWALL: "PAYWALL";
+    readonly LIVENESS: "LIVENESS";
+    readonly PHOTO_VIEWER: "PHOTO_VIEWER";
+    readonly SEARCH: "SEARCH";
+    readonly CREATE: "CREATE";
+};
+export type ViewableScreen = (typeof ViewableScreen)[keyof typeof ViewableScreen];
+/** Main-shell tabs. */
+export declare const TabScreen: {
+    readonly DISCOVER: "DISCOVER";
+    readonly LIKES_YOU: "LIKES_YOU";
+    readonly CHAT: "CHAT";
+    readonly PROFILE: "PROFILE";
+};
+export type TabScreen = (typeof TabScreen)[keyof typeof TabScreen];
+/** The standard verbs for a UI interaction. Every platform uses these and only these. */
+export declare const UiAction: {
+    readonly TAP: "tap";
+    readonly LONG_PRESS: "long_press";
+    readonly SUBMIT: "submit";
+    readonly TOGGLE: "toggle";
+    readonly SELECT: "select";
+    readonly DISMISS: "dismiss";
+};
+export type UiAction = (typeof UiAction)[keyof typeof UiAction];
+/** Kind of control (informational; drives the default action). */
+export declare const UiElementKind: {
+    readonly BUTTON: "button";
+    readonly TAB: "tab";
+    readonly TOGGLE: "toggle";
+    readonly LINK: "link";
+    readonly LIST_ITEM: "list_item";
+    readonly MENU_ITEM: "menu_item";
+    readonly DIALOG_BUTTON: "dialog_button";
+    readonly GESTURE: "gesture";
+    readonly SEGMENTED: "segmented";
+};
+export type UiElementKind = (typeof UiElementKind)[keyof typeof UiElementKind];
+/** Discovery decision direction: left = pass, right = like, up = rose/super. */
+export declare const SwipeDirection: {
+    readonly LEFT: "left";
+    readonly RIGHT: "right";
+    readonly UP: "up";
+};
+export type SwipeDirection = (typeof SwipeDirection)[keyof typeof SwipeDirection];
+/** Media element type. */
+export declare const MediaType: {
+    readonly IMAGE: "image";
+    readonly VIDEO: "video";
+    readonly VOICE: "voice";
+};
+export type MediaType = (typeof MediaType)[keyof typeof MediaType];
+/** Profile sections a viewer can dwell on. */
+export declare const ProfileSection: {
+    readonly PHOTOS: "PHOTOS";
+    readonly BIO: "BIO";
+    readonly INTERESTS: "INTERESTS";
+    readonly PROMPTS: "PROMPTS";
+    readonly VOICE: "VOICE";
+};
+export type ProfileSection = (typeof ProfileSection)[keyof typeof ProfileSection];
+/** Profile element a comment-to-like targets. */
+export declare const LikeTargetType: {
+    readonly PHOTO: "PHOTO";
+    readonly VIDEO: "VIDEO";
+    readonly VOICE: "VOICE";
+    readonly PROMPT: "PROMPT";
+    readonly INTEREST: "INTEREST";
+    readonly BIO: "BIO";
+};
+export type LikeTargetType = (typeof LikeTargetType)[keyof typeof LikeTargetType];
+/** Safety UI intents (the action itself is server-authoritative). */
+export declare const SafetyAction: {
+    readonly UNMATCH: "unmatch";
+    readonly BLOCK: "block";
+    readonly REPORT: "report";
+};
+export type SafetyAction = (typeof SafetyAction)[keyof typeof SafetyAction];
+/** Which discovery card design produced the signal (segment metrics by design). */
+export declare const CardVariant: {
+    readonly INTERLEAVED: "interleaved";
+    readonly SWIPE: "swipe";
+    readonly FEED: "feed";
+};
+export type CardVariant = (typeof CardVariant)[keyof typeof CardVariant];
+/** Kind of notification that was opened. */
+export declare const NotificationType: {
+    readonly NEW_MATCH: "new_match";
+    readonly NEW_LIKE: "new_like";
+    readonly NEW_MESSAGE: "new_message";
+    readonly REENGAGEMENT: "reengagement";
+    readonly OTHER: "other";
+};
+export type NotificationType = (typeof NotificationType)[keyof typeof NotificationType];
+/** Delivery channel of an opened notification. */
+export declare const NotificationChannel: {
+    readonly PUSH: "push";
+    readonly IN_APP: "in_app";
+};
+export type NotificationChannel = (typeof NotificationChannel)[keyof typeof NotificationChannel];
+/** Reaction to the "one connection at a time" (hooked) overlay. */
+export declare const HookedStateAction: {
+    readonly SHOWN: "shown";
+    readonly GO_TO_CHAT: "go_to_chat";
+    readonly DISMISS: "dismiss";
+};
+export type HookedStateAction = (typeof HookedStateAction)[keyof typeof HookedStateAction];
+/** Registered UI element ids (`<screen>.<subject>`). Use with trackUi / data-track-id. */
+export declare const UiElement: {
+    readonly NAV_TAB_SELECT: "nav.tab_select";
+    readonly NAV_SEARCH_OPEN: "nav.search_open";
+    readonly NAV_MENU_OPEN: "nav.menu_open";
+    readonly NAV_BACK: "nav.back";
+    readonly NAV_HOME_LOGO: "nav.home_logo";
+    readonly NAV_HOOKED_GO_TO_CHAT: "nav.hooked_go_to_chat";
+    readonly NAV_HOOKED_DISMISS: "nav.hooked_dismiss";
+    readonly LANDING_GET_STARTED: "landing.get_started";
+    readonly LANDING_LOGIN: "landing.login";
+    readonly LANDING_POLICY_LINK: "landing.policy_link";
+    readonly LANDING_HOME_LINK: "landing.home_link";
+    readonly LANDING_OPEN_IN_APP: "landing.open_in_app";
+    readonly LANDING_NAV_LINK: "landing.nav_link";
+    readonly LANDING_SOCIAL_LINK: "landing.social_link";
+    readonly LANDING_MOBILE_MENU_TOGGLE: "landing.mobile_menu_toggle";
+    readonly LANDING_SECTION_NAV: "landing.section_nav";
+    readonly LANDING_EMAIL_LINK: "landing.email_link";
+    readonly LANDING_PRICING_PERIOD_SELECT: "landing.pricing_period_select";
+    readonly LANDING_CAREERS_APPLY: "landing.careers_apply";
+    readonly LANDING_DEMO_INTERACT: "landing.demo_interact";
+    readonly LANDING_CHATBOT_WIDGET: "landing.chatbot_widget";
+    readonly LANDING_NOTICE_RETRY: "landing.notice_retry";
+    readonly LOGIN_SUBMIT: "login.submit";
+    readonly LOGIN_GOOGLE: "login.google";
+    readonly LOGIN_APPLE: "login.apple";
+    readonly LOGIN_PASSKEY: "login.passkey";
+    readonly LOGIN_IDENTIFIER_MODE: "login.identifier_mode";
+    readonly LOGIN_PASSWORD_MODE: "login.password_mode";
+    readonly LOGIN_FORGOT_PASSWORD: "login.forgot_password";
+    readonly LOGIN_RESEND_CODE: "login.resend_code";
+    readonly LOGIN_REDEEM_INVITE: "login.redeem_invite";
+    readonly LOGIN_CLOSE: "login.close";
+    readonly LOGIN_PASSKEY_SETUP: "login.passkey_setup";
+    readonly REDEEM_INVITE_SUBMIT: "redeem_invite.submit";
+    readonly REDEEM_INVITE_BACK: "redeem_invite.back";
+    readonly REDEEM_INVITE_LOGIN: "redeem_invite.login";
+    readonly REDEEM_INVITE_CLOSE: "redeem_invite.close";
+    readonly REDEEM_INVITE_RESEND_CODE: "redeem_invite.resend_code";
+    readonly ONBOARDING_NEXT: "onboarding.next";
+    readonly ONBOARDING_BACK: "onboarding.back";
+    readonly ONBOARDING_FINISH: "onboarding.finish";
+    readonly ONBOARDING_SKIP_SIGN_OUT: "onboarding.skip_sign_out";
+    readonly ONBOARDING_SKIP_SIGN_OUT_CONFIRM: "onboarding.skip_sign_out_confirm";
+    readonly ONBOARDING_PHOTO_ADD: "onboarding.photo_add";
+    readonly ONBOARDING_PHOTO_REMOVE: "onboarding.photo_remove";
+    readonly ONBOARDING_PHOTO_REMOVE_CONFIRM: "onboarding.photo_remove_confirm";
+    readonly ONBOARDING_PROMPT_ADD: "onboarding.prompt_add";
+    readonly ONBOARDING_PROMPT_REMOVE: "onboarding.prompt_remove";
+    readonly ONBOARDING_VOICE_ADD: "onboarding.voice_add";
+    readonly ONBOARDING_VOICE_REMOVE: "onboarding.voice_remove";
+    readonly ONBOARDING_CHOICE_SELECT: "onboarding.choice_select";
+    readonly DISCOVER_PASS_BUTTON: "discover.pass_button";
+    readonly DISCOVER_LIKE_BUTTON: "discover.like_button";
+    readonly DISCOVER_ROSE_BUTTON: "discover.rose_button";
+    readonly DISCOVER_UNDO_BUTTON: "discover.undo_button";
+    readonly DISCOVER_ELEMENT_LIKE: "discover.element_like";
+    readonly DISCOVER_PHOTO_OPEN: "discover.photo_open";
+    readonly DISCOVER_VOICE_PLAY: "discover.voice_play";
+    readonly DISCOVER_PREFERENCES_OPEN: "discover.preferences_open";
+    readonly DISCOVER_LIKES_YOU_OPEN: "discover.likes_you_open";
+    readonly DISCOVER_ADD_HOOK_OPEN: "discover.add_hook_open";
+    readonly DISCOVER_RETRY: "discover.retry";
+    readonly DISCOVER_ADD_HOOK_SUBMIT: "discover.add_hook_submit";
+    readonly DISCOVER_UPGRADE_OPEN: "discover.upgrade_open";
+    readonly LIKE_COMPOSER_SEND: "like_composer.send";
+    readonly LIKE_COMPOSER_SEND_WITHOUT_COMMENT: "like_composer.send_without_comment";
+    readonly LIKE_COMPOSER_CANCEL: "like_composer.cancel";
+    readonly LIKE_COMPOSER_UPGRADE: "like_composer.upgrade";
+    readonly LIKES_YOU_PROFILE_OPEN: "likes_you.profile_open";
+    readonly LIKES_YOU_LIKED_ITEM_OPEN: "likes_you.liked_item_open";
+    readonly LIKES_YOU_REFRESH: "likes_you.refresh";
+    readonly LIKES_YOU_RETRY: "likes_you.retry";
+    readonly LIKES_YOU_CLOSE: "likes_you.close";
+    readonly CHAT_SEND_BUTTON: "chat.send_button";
+    readonly CHAT_ATTACH_BUTTON: "chat.attach_button";
+    readonly CHAT_ATTACH_OPTION: "chat.attach_option";
+    readonly CHAT_CAPTURE_OPTION: "chat.capture_option";
+    readonly CHAT_VOICE_RECORD_START: "chat.voice_record_start";
+    readonly CHAT_VOICE_RECORD_STOP: "chat.voice_record_stop";
+    readonly CHAT_VOICE_RECORD_CANCEL: "chat.voice_record_cancel";
+    readonly CHAT_VOICE_SEND: "chat.voice_send";
+    readonly CHAT_CONVERSATION_SWITCH: "chat.conversation_switch";
+    readonly CHAT_CONVERSATION_SORT: "chat.conversation_sort";
+    readonly CHAT_CONVERSATION_SORT_OPEN: "chat.conversation_sort_open";
+    readonly CHAT_CONVERSATION_SWITCHER_OPEN: "chat.conversation_switcher_open";
+    readonly CHAT_PROFILE_OPEN: "chat.profile_open";
+    readonly CHAT_SAFETY_MENU_OPEN: "chat.safety_menu_open";
+    readonly CHAT_UNMATCH: "chat.unmatch";
+    readonly CHAT_REPORT_SPAM: "chat.report_spam";
+    readonly CHAT_REPORT_BLOCK: "chat.report_block";
+    readonly CHAT_BLOCK_CONFIRM: "chat.block_confirm";
+    readonly CHAT_SETTINGS_OPEN: "chat.settings_open";
+    readonly CHAT_WALLPAPER_OPEN: "chat.wallpaper_open";
+    readonly CHAT_ADD_HOOK_OPEN: "chat.add_hook_open";
+    readonly CHAT_PRIVACY_TOGGLE: "chat.privacy_toggle";
+    readonly CHAT_CALL: "chat.call";
+    readonly CHAT_VIDEO_CALL: "chat.video_call";
+    readonly CHAT_MEDIA_OPEN: "chat.media_open";
+    readonly CHAT_AUDIO_PLAY: "chat.audio_play";
+    readonly CHAT_FILE_OPEN: "chat.file_open";
+    readonly CHAT_MESSAGE_DELETE: "chat.message_delete";
+    readonly CHAT_MESSAGE_MENU_OPEN: "chat.message_menu_open";
+    readonly CHAT_REPORT_REASON_SELECT: "chat.report_reason_select";
+    readonly CHAT_SENSITIVE_REVEAL_CONFIRM: "chat.sensitive_reveal_confirm";
+    readonly CHAT_ATTACHMENT_RETRY: "chat.attachment_retry";
+    readonly CHAT_HISTORY_RECOVER: "chat.history_recover";
+    readonly CHAT_MR_ONEHOOK_OPEN: "chat.mr_onehook_open";
+    readonly CHAT_MR_ONEHOOK_CLOSE: "chat.mr_onehook_close";
+    readonly CHAT_RETRY: "chat.retry";
+    readonly CHAT_UNMATCH_CONFIRM: "chat.unmatch_confirm";
+    readonly CHAT_PROFILE_CLOSE: "chat.profile_close";
+    readonly CHAT_MR_ONEHOOK_CONTEXT_SHARE: "chat.mr_onehook_context_share";
+    readonly CHAT_MR_ONEHOOK_SCOPE_OPEN: "chat.mr_onehook_scope_open";
+    readonly CHAT_MR_ONEHOOK_SCOPE_SELECT: "chat.mr_onehook_scope_select";
+    readonly CHAT_INTRO_TOUR_OPEN: "chat.intro_tour_open";
+    readonly CHAT_INTRO_DISMISS: "chat.intro_dismiss";
+    readonly CHAT_INTRO_GET_STARTED: "chat.intro_get_started";
+    readonly CHAT_HISTORY_RECOVER_METHOD: "chat.history_recover_method";
+    readonly CHAT_HISTORY_RECOVER_STEP: "chat.history_recover_step";
+    readonly CHAT_HISTORY_RESET_CONFIRM: "chat.history_reset_confirm";
+    readonly CHAT_SETTINGS_LAST_SEEN_SELECT: "chat_settings.last_seen_select";
+    readonly CHAT_SETTINGS_DISAPPEARING_SELECT: "chat_settings.disappearing_select";
+    readonly CHAT_SETTINGS_NOTIFICATION_TOGGLE: "chat_settings.notification_toggle";
+    readonly CHAT_SETTINGS_PRIVACY_TOGGLE: "chat_settings.privacy_toggle";
+    readonly CHAT_SETTINGS_FONT_SIZE_SELECT: "chat_settings.font_size_select";
+    readonly CHAT_SETTINGS_WALLPAPER_SELECT: "chat_settings.wallpaper_select";
+    readonly CHAT_SETTINGS_EXPORT_CHAT: "chat_settings.export_chat";
+    readonly CHAT_SETTINGS_CLEAR_CACHE: "chat_settings.clear_cache";
+    readonly NOTIFICATIONS_ITEM_OPEN: "notifications.item_open";
+    readonly NOTIFICATIONS_ITEM_DISMISS: "notifications.item_dismiss";
+    readonly PROFILE_EDIT_OPEN: "profile.edit_open";
+    readonly PROFILE_PREVIEW_OPEN: "profile.preview_open";
+    readonly PROFILE_PREFERENCES_OPEN: "profile.preferences_open";
+    readonly PROFILE_SETTINGS_OPEN: "profile.settings_open";
+    readonly PROFILE_CHAT_SETTINGS_OPEN: "profile.chat_settings_open";
+    readonly PROFILE_CHAT_TOUR_OPEN: "profile.chat_tour_open";
+    readonly PROFILE_PHOTO_OPEN: "profile.photo_open";
+    readonly PROFILE_VERIFY_IDENTITY: "profile.verify_identity";
+    readonly PROFILE_SHARE_INVITE: "profile.share_invite";
+    readonly PROFILE_INVITE_CODE_COPY: "profile.invite_code_copy";
+    readonly PROFILE_INVITE_CODE_SHARE: "profile.invite_code_share";
+    readonly PROFILE_UPGRADE_OPEN: "profile.upgrade_open";
+    readonly PROFILE_UNHOOK: "profile.unhook";
+    readonly PROFILE_UNHOOK_CONFIRM: "profile.unhook_confirm";
+    readonly PROFILE_TAB_SELECT: "profile.tab_select";
+    readonly PROFILE_RETRY: "profile.retry";
+    readonly PROFILE_VOICE_PLAY: "profile.voice_play";
+    readonly PROFILE_EDIT_SAVE: "profile_edit.save";
+    readonly PROFILE_EDIT_PREVIEW: "profile_edit.preview";
+    readonly PROFILE_EDIT_PHOTO_ADD: "profile_edit.photo_add";
+    readonly PROFILE_EDIT_PHOTO_REMOVE: "profile_edit.photo_remove";
+    readonly PROFILE_EDIT_PHOTO_REMOVE_CONFIRM: "profile_edit.photo_remove_confirm";
+    readonly PROFILE_EDIT_PHOTO_SET_PRIMARY: "profile_edit.photo_set_primary";
+    readonly PROFILE_EDIT_PHOTO_ADJUST: "profile_edit.photo_adjust";
+    readonly PROFILE_EDIT_PHOTO_REORDER: "profile_edit.photo_reorder";
+    readonly PROFILE_EDIT_PROMPT_ADD: "profile_edit.prompt_add";
+    readonly PROFILE_EDIT_PROMPT_REMOVE: "profile_edit.prompt_remove";
+    readonly PROFILE_EDIT_VOICE_ADD: "profile_edit.voice_add";
+    readonly PROFILE_EDIT_VOICE_REMOVE: "profile_edit.voice_remove";
+    readonly PROFILE_EDIT_CHOICE_SELECT: "profile_edit.choice_select";
+    readonly PREFERENCES_SAVE: "preferences.save";
+    readonly PREFERENCES_UPGRADE_OPEN: "preferences.upgrade_open";
+    readonly PREFERENCES_LOCKED_FILTER_TAP: "preferences.locked_filter_tap";
+    readonly SETTINGS_EMAIL_MANAGE: "settings.email_manage";
+    readonly SETTINGS_PHONE_UPDATE: "settings.phone_update";
+    readonly SETTINGS_GOOGLE_LINK: "settings.google_link";
+    readonly SETTINGS_APPLE_LINK: "settings.apple_link";
+    readonly SETTINGS_PASSKEY_ADD: "settings.passkey_add";
+    readonly SETTINGS_PASSWORD_SET: "settings.password_set";
+    readonly SETTINGS_RECOVERY_SETUP: "settings.recovery_setup";
+    readonly SETTINGS_DEVICE_REVOKE: "settings.device_revoke";
+    readonly SETTINGS_DEVICE_REVOKE_CONFIRM: "settings.device_revoke_confirm";
+    readonly SETTINGS_SAFETY_OPEN: "settings.safety_open";
+    readonly SETTINGS_THEME_SELECT: "settings.theme_select";
+    readonly SETTINGS_THEME_OPEN: "settings.theme_open";
+    readonly SETTINGS_SIGN_OUT: "settings.sign_out";
+    readonly SETTINGS_SIGN_OUT_CONFIRM: "settings.sign_out_confirm";
+    readonly SETTINGS_DELETE_ACCOUNT_OPEN: "settings.delete_account_open";
+    readonly SETTINGS_DELETE_ACCOUNT_CONFIRM: "settings.delete_account_confirm";
+    readonly SETTINGS_UNBLOCK_USER: "settings.unblock_user";
+    readonly SETTINGS_UNBLOCK_CONFIRM: "settings.unblock_confirm";
+    readonly SETTINGS_VERIFY_CODE_SUBMIT: "settings.verify_code_submit";
+    readonly SETTINGS_PASSWORD_SET_CONFIRM: "settings.password_set_confirm";
+    readonly SETTINGS_HELP_LINK: "settings.help_link";
+    readonly SETTINGS_RECOVERY_APPROVE: "settings.recovery_approve";
+    readonly SETTINGS_RECOVERY_QR_SAVE: "settings.recovery_qr_save";
+    readonly SETTINGS_RECOVERY_QR_SHARE: "settings.recovery_qr_share";
+    readonly PAYWALL_PURCHASE: "paywall.purchase";
+    readonly PAYWALL_RESTORE: "paywall.restore";
+    readonly PAYWALL_FEATURES_EXPAND: "paywall.features_expand";
+    readonly PHOTO_VIEWER_CLOSE: "photo_viewer.close";
+    readonly PHOTO_VIEWER_PREVIOUS: "photo_viewer.previous";
+    readonly PHOTO_VIEWER_NEXT: "photo_viewer.next";
+    readonly SEARCH_CLOSE: "search.close";
+    readonly SEARCH_QUERY_CLEAR: "search.query_clear";
+    readonly SEARCH_FILTER_SELECT: "search.filter_select";
+    readonly SEARCH_RESULT_OPEN: "search.result_open";
+    readonly CREATE_CLOSE: "create.close";
+    readonly CREATE_OPTION_SELECT: "create.option_select";
+    readonly SHARED_ALERT_DISMISS: "shared.alert_dismiss";
+    readonly SHARED_ERROR_RECOVER: "shared.error_recover";
+    readonly SHARED_COUNTRY_CODE_OPEN: "shared.country_code_open";
+    readonly SHARED_COUNTRY_CODE_SELECT: "shared.country_code_select";
+    readonly SHARED_VOICE_RECORDER: "shared.voice_recorder";
+    readonly SHARED_PROMPT_PRESET_SELECT: "shared.prompt_preset_select";
+    readonly LIVENESS_BEGIN: "liveness.begin";
+    readonly LIVENESS_DISMISS: "liveness.dismiss";
+    readonly LIVENESS_RETRY: "liveness.retry";
+    readonly LIVENESS_OPEN_SETTINGS: "liveness.open_settings";
+    readonly LIVENESS_CLOSE: "liveness.close";
+};
+export type UiElementId = (typeof UiElement)[keyof typeof UiElement];
+export interface UiElementSpec {
+    readonly screen: Screen;
+    readonly kind: UiElementKind;
+    /** Allowed actions; the first is the default. */
+    readonly actions: readonly UiAction[];
+    /** When non-null, `value` is required and must be one of these. */
+    readonly values: readonly string[] | null;
+    /** Platforms this element is in scope for (parity contract; see PLATFORM_GAPS in the catalog). */
+    readonly platforms: readonly Platform[];
+}
+export declare const UI_ELEMENTS: {
+    readonly [K in UiElementId]: UiElementSpec;
+};
+/** UI element ids in scope for `platform` (what its coverage test must find instrumented). */
+export declare function uiElementsForPlatform(platform: Platform): UiElementId[];
+/** The only allowed `telemetry-exempt: <category>: <reason>` categories (see the catalog). */
+export declare const TELEMETRY_EXEMPT_CATEGORIES: readonly ["duplicate", "backdrop", "gesture", "continuous", "disabled"];
+export declare function isUiElementId(v: unknown): v is UiElementId;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "onehook-api-client",
   "description": "OneHook API Client",
-  "version": "1.0.18",
+  "version": "1.0.20",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -72,7 +72,8 @@
     }
   },
   "files": [
-    "dist-*/**"
+    "dist-*/**",
+    "telemetry/**"
   ],
   "browser": {
     "./dist-es/runtimeConfig": "./dist-es/runtimeConfig.browser"
@@ -92,6 +93,14 @@
       "import": "./dist-es/graphql/types.js",
       "require": "./dist-cjs/graphql/types.js"
     },
+    "./telemetry": {
+      "types": "./dist-types/telemetry/index.d.ts",
+      "import": "./dist-es/telemetry/index.js",
+      "require": "./dist-cjs/telemetry/index.js"
+    },
+    "./telemetry/TelemetryCatalog.swift": "./telemetry/TelemetryCatalog.swift",
+    "./telemetry/TelemetryCatalog.kt": "./telemetry/TelemetryCatalog.kt",
+    "./telemetry/telemetry-catalog.json": "./telemetry/telemetry-catalog.json",
     "./package.json": "./package.json"
   },
   "license": "UNLICENSED",