Fern upgrade (#567)

Co-authored-by: fern-api[bot] <115122769+fern-api[bot]@users.noreply.github.com>

Author: twitchard

.fernignore

@@ -7,29 +7,67 @@ CONTRIBUTING.md
 
 # Tooling
 eslint.config.mjs
-jest.config.mjs
+#jest.config.mjs
 justfile
 tsconfig.dev.json
 .nvmrc
 .github
 .prettierignore
 
-# Wrapper client
-src/wrapper
-src/index.ts
 
 # EVI WebSocket
+# Supplier.ts - sync version required to keep EVI chat client .connect() method synchronous
 src/core/fetcher/Supplier.ts
-src/Client.ts
-src/api/resources/empathicVoice/client/Client.ts
-src/api/resources/empathicVoice/resources/chat/index.ts
-src/api/resources/empathicVoice/resources/chat/client
-src/core/websocket
-src/core/index.ts
+# src/Client.ts
+# src/api/resources/empathicVoice/client/Client.ts
+# src/api/resources/empathicVoice/resources/chat/index.ts
+# src/api/resources/empathicVoice/resources/chat/client
+# src/core/websocket
+# src/core/index.ts
+# EVI Chat Client - manually maintained to preserve backward compatibility
+# Client.ts changes from generated version:
+# - ConnectArgs.sessionSettings is optional (was required)
+# - ConnectArgs.configVersion accepts string | number (was only number)
+# - ConnectArgs.voiceId added back as deprecated parameter
+# - ConnectArgs.queryParams added for arbitrary query parameters
+# - connect() args parameter is optional with default {}
+# - Handles voiceId parameter (maps to voice_id query param)
+# - Handles flexible configVersion types (both string and number)
+# - Conditional sessionSettings serialization (only if provided)
+# - Merges custom queryParams into query parameters
+src/api/resources/empathicVoice/resources/chat/client/Client.ts
+
+# Socket.ts changes from generated version:
+# - Response type includes receivedAt: Date timestamp
+# - handleMessage adds receivedAt timestamp to messages
+# - Restored 8 convenience methods that wrap sendPublish():
+#   - sendAudioInput(), sendSessionSettings(), sendAssistantInput()
+#   - pauseAssistant(), resumeAssistant()
+#   - sendToolResponseMessage(), sendToolErrorMessage(), sendUserInput()
+# - Added tillSocketOpen() as deprecated alias for waitForOpen()
+src/api/resources/empathicVoice/resources/chat/client/Socket.ts
+
+# index.ts - manually maintained to export Chat and ChatSocket
+# Generated version exports nothing (export {}), but we need to export
+# our manually maintained Client and Socket classes
+src/api/resources/empathicVoice/resources/chat/client/index.ts
+
+# Manually added tests
+tests/unit/url-resolution.test.ts
+tests/expressionMeasurement/batch.test.ts
+tests/expressionMeasurement/streaming.test.ts
 
-# Tests
-tests/empathicVoice
-tests/expressionMeasurement
+# Required manual edits for Node 18 compatibility
+tests/unit/fetcher/Fetcher.test.ts
+tests/unit/file/file.test.ts
 
 # Needed because node 18 doesn't actually have a global.File
 tests/BrowserTestEnvironment.ts
+
+# Needed to send apiKey on websocket queryParams
+# See https://github.com/fern-demo/hume-typescript-sdk/pull/1
+src/core/websocket/ws.ts
+
+# Needed to export the utilities under src/wrapper
+src/wrapper
+src/index.ts

.mock/definition/api.yml

@@ -1,9 +1,15 @@
 name: api
 error-discrimination:
   strategy: status-code
-default-environment: Production
+default-environment: prod
+default-url: Base
 environments:
-  Production: https://api.hume.ai
+  prod:
+    urls:
+      Base: https://api.hume.ai/
+      evi: wss://api.hume.ai/v0/evi
+      tts: wss://api.hume.ai/v0/tts
+      stream: wss://api.hume.ai/v0/stream
 auth: HeaderAuthScheme
 auth-schemes:
   HeaderAuthScheme:

.mock/definition/empathic-voice/__package__.yml

@@ -600,8 +600,7 @@ types:
           When provided, EVI will use this key instead of Hume's API key for the
           supplemental LLM. This allows you to bypass rate limits and utilize
           your own API key as needed.
-      metadata:
-        type: optional<map<string, unknown>>
+      metadata: optional<map<string, unknown>>
       system_prompt:
         type: optional<string>
         docs: >-
@@ -1003,6 +1002,69 @@ types:
       - type: ToolErrorMessage
     source:
       openapi: evi-asyncapi.json
+  ConnectSessionSettingsAudio:
+    properties:
+      channels:
+        type: optional<integer>
+      encoding:
+        type: optional<string>
+      sample_rate:
+        type: optional<integer>
+    source:
+      openapi: evi-asyncapi.json
+    inline: true
+  ConnectSessionSettingsContext:
+    properties:
+      text:
+        type: optional<string>
+      type:
+        type: optional<string>
+    source:
+      openapi: evi-asyncapi.json
+    inline: true
+  ConnectSessionSettingsVariablesValue:
+    discriminated: false
+    union:
+      - string
+      - double
+      - boolean
+    source:
+      openapi: evi-asyncapi.json
+    inline: true
+  ConnectSessionSettings:
+    properties:
+      audio: optional<ConnectSessionSettingsAudio>
+      context: optional<ConnectSessionSettingsContext>
+      custom_session_id:
+        type: optional<string>
+      event_limit:
+        type: optional<integer>
+      language_model_api_key:
+        type: optional<string>
+      system_prompt:
+        type: optional<string>
+      variables:
+        type: optional<map<string, ConnectSessionSettingsVariablesValue>>
+        docs: >-
+          This field allows you to assign values to dynamic variables referenced
+          in your system prompt.
+
+
+          Each key represents the variable name, and the corresponding value is
+          the specific content you wish to assign to that variable within the
+          session. While the values for variables can be strings, numbers, or
+          booleans, the value will ultimately be converted to a string when
+          injected into your system prompt.
+
+
+          Using this field, you can personalize responses based on
+          session-specific details. For more guidance, see our [guide on using
+          dynamic
+          variables](/docs/speech-to-speech-evi/features/dynamic-variables).
+      voice_id:
+        type: optional<string>
+    source:
+      openapi: evi-asyncapi.json
   HTTPValidationError:
     properties:
       detail:

.mock/definition/empathic-voice/chat.yml

@@ -1,6 +1,8 @@
+imports:
+  root: __package__.yml
 channel:
   path: /chat
-  url: prod
+  url: evi
   auth: false
   docs: Chat with Empathic Voice Interface (EVI)
   query-parameters:
@@ -98,111 +100,6 @@ channel:
         Use the GET `/v0/evi/chat_groups` endpoint to obtain the Chat Group IDs
         of all Chat Groups associated with an API key. This endpoint returns a
         list of all available chat groups.
-    session_settings[audio][channels]:
-      type: optional<integer>
-      docs: Sets number of audio channels for audio input.
-    session_settings[audio][encoding]:
-      type: optional<string>
-      docs: Sets encoding format of the audio input, such as `linear16`.
-    session_settings[audio][sample_rate]:
-      type: optional<integer>
-      docs: >-
-        Sets the sample rate for audio input. (Number of samples per second in
-        the audio input, measured in Hertz.)
-    session_settings[context][text]:
-      type: optional<string>
-      docs: >-
-        The context to be injected into the conversation. Helps inform the LLM's
-        response by providing relevant information about the ongoing
-        conversation.
-
-
-        This text will be appended to the end of
-        [user_messages](/reference/speech-to-speech-evi/chat#receive.UserMessage.message.content)
-        based on the chosen persistence level. For example, if you want to
-        remind EVI of its role as a helpful weather assistant, the context you
-        insert will be appended to the end of user messages as `{Context: You
-        are a helpful weather assistant}`.
-    session_settings[context][type]:
-      type: optional<string>
-      docs: >-
-        The persistence level of the injected context. Specifies how long the
-        injected context will remain active in the session.
-
-
-        - **Temporary**: Context that is only applied to the following assistant
-        response.
-
-
-        - **Persistent**: Context that is applied to all subsequent assistant
-        responses for the remainder of the Chat.
-    session_settings[custom_session_id]:
-      type: optional<string>
-      docs: >-
-        Used to manage conversational state, correlate frontend and backend
-        data, and persist conversations across EVI sessions.
-    session_settings[event_limit]:
-      type: optional<integer>
-      docs: >-
-        The maximum number of chat events to return from chat history. By
-        default, the system returns up to 300 events (100 events per page × 3
-        pages). Set this parameter to a smaller value to limit the number of
-        events returned.
-    session_settings[language_model_api_key]:
-      type: optional<string>
-      docs: >-
-        Third party API key for the supplemental language model.
-
-
-        When provided, EVI will use this key instead of Hume's API key for the
-        supplemental LLM. This allows you to bypass rate limits and utilize your
-        own API key as needed.
-    session_settings[system_prompt]:
-      type: optional<string>
-      docs: >-
-        Instructions used to shape EVI's behavior, responses, and style for the
-        session.
-
-
-        When included in a Session Settings message, the provided Prompt
-        overrides the existing one specified in the EVI configuration. If no
-        Prompt was defined in the configuration, this Prompt will be the one
-        used for the session.
-
-
-        You can use the Prompt to define a specific goal or role for EVI,
-        specifying how it should act or what it should focus on during the
-        conversation. For example, EVI can be instructed to act as a customer
-        support representative, a fitness coach, or a travel advisor, each with
-        its own set of behaviors and response styles.
-
-
-        For help writing a system prompt, see our [Prompting
-        Guide](/docs/speech-to-speech-evi/guides/prompting).
-    session_settings[variables]:
-      type: optional<string>
-      docs: >-
-        This field allows you to assign values to dynamic variables referenced
-        in your system prompt.
-
-
-        Each key represents the variable name, and the corresponding value is
-        the specific content you wish to assign to that variable within the
-        session. While the values for variables can be strings, numbers, or
-        booleans, the value will ultimately be converted to a string when
-        injected into your system prompt.
-
-
-        Using this field, you can personalize responses based on
-        session-specific details. For more guidance, see our [guide on using
-        dynamic
-        variables](/docs/speech-to-speech-evi/features/dynamic-variables).
-    session_settings[voice_id]:
-      type: optional<string>
-      docs: >-
-        The name or ID of the voice from the `Voice Library` to be used as the
-        speaker for this EVI session. This will override the speaker set in the
-        selected configuration.
     verbose_transcription:
       type: optional<boolean>
       default: false
@@ -214,12 +111,6 @@ channel:
         field on a
         [UserMessage](/reference/speech-to-speech-evi/chat#receive.UserMessage)
         denotes whether the message is "interim" or "final."
-    voice_id:
-      type: optional<string>
-      docs: >-
-        The name or ID of the voice from the `Voice Library` to be used as the
-        speaker for this EVI session. This will override the speaker set in the
-        selected configuration.
     api_key:
       type: optional<string>
       default: ''
@@ -230,24 +121,14 @@ channel:
 
         For more details, refer to the [Authentication Strategies
         Guide](/docs/introduction/api-key#authentication-strategies).
+    session_settings: root.ConnectSessionSettings
   messages:
     publish:
       origin: client
       body: PublishEvent
     subscribe:
       origin: server
       body: SubscribeEvent
-  examples:
-    - messages:
-        - type: publish
-          body:
-            data: data
-            type: audio_input
-        - type: subscribe
-          body:
-            type: assistant_end
-imports:
-  root: __package__.yml
 types:
   PublishEvent:
     discriminated: false

.mock/definition/empathic-voice/chatGroups.yml

@@ -7,7 +7,6 @@ service:
     list-chat-groups:
       path: /v0/evi/chat_groups
       method: GET
-      auth: true
       docs: Fetches a paginated list of **Chat Groups**.
       pagination:
         offset: $request.page_number
@@ -86,7 +85,6 @@ service:
     get-chat-group:
       path: /v0/evi/chat_groups/{id}
       method: GET
-      auth: true
       docs: >-
         Fetches a **ChatGroup** by ID, including a paginated list of **Chats**
         associated with the **ChatGroup**.
@@ -166,7 +164,6 @@ service:
     list-chat-group-events:
       path: /v0/evi/chat_groups/{id}/events
       method: GET
-      auth: true
       docs: >-
         Fetches a paginated list of **Chat** events associated with a **Chat
         Group**.
@@ -547,7 +544,6 @@ service:
     get-audio:
       path: /v0/evi/chat_groups/{id}/audio
       method: GET
-      auth: true
       docs: >-
         Fetches a paginated list of audio for each **Chat** within the specified
         **Chat Group**. For more details, see our guide on audio reconstruction

.mock/definition/empathic-voice/chatWebhooks.yml

@@ -11,6 +11,9 @@ webhooks:
       - payload:
           chat_group_id: chat_group_id
           chat_id: chat_id
+          config_id: null
+          caller_number: null
+          custom_session_id: null
           duration_seconds: 1
           end_reason: ACTIVE
           end_time: 1
@@ -25,6 +28,9 @@ webhooks:
       - payload:
           chat_group_id: chat_group_id
           chat_id: chat_id
+          config_id: null
+          caller_number: null
           chat_start_type: new_chat_group
+          custom_session_id: null
           start_time: 1
     docs: Sent when an EVI chat is started.