update types

TudorCRL · TudorCRL · commit b8bf53be221f · 2025-06-26T14:16:48.000+01:00
diff --git a/packages/flow-client-react/package.json b/packages/flow-client-react/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@speechmatics/flow-client-react",
-  "version": "1.0.0-rc.4",
+  "version": "1.0.0-rc.5",
   "description": "React hooks for interacting with the Speechmatics Flow API",
   "main": "dist/index.cjs",
   "module": "dist/index.js",
diff --git a/packages/flow-client/models/AudioFormat.ts b/packages/flow-client/models/AudioFormat.ts
@@ -0,0 +1,7 @@
+import type { AudioFormatRawEncodingEnum } from './AudioFormatRawEncodingEnum';
+interface AudioFormat {
+  type: 'raw';
+  encoding?: AudioFormatRawEncodingEnum;
+  sample_rate?: number;
+}
+export type { AudioFormat };
diff --git a/packages/flow-client/models/AudioFormatFile.ts b/packages/flow-client/models/AudioFormatFile.ts
diff --git a/packages/flow-client/models/AudioFormatFileTypeEnum.ts b/packages/flow-client/models/AudioFormatFileTypeEnum.ts
diff --git a/packages/flow-client/models/AudioFormatRaw.ts b/packages/flow-client/models/AudioFormatRaw.ts
diff --git a/packages/flow-client/models/AudioFormatRawTypeEnum.ts b/packages/flow-client/models/AudioFormatRawTypeEnum.ts
diff --git a/packages/flow-client/models/ConcurrentSessionUsageInfo.ts b/packages/flow-client/models/ConcurrentSessionUsageInfo.ts
@@ -0,0 +1,8 @@
+interface ConcurrentSessionUsageInfo {
+  message: 'Info';
+  type: 'concurrent_session_usage';
+  usage: number;
+  quota: number;
+  last_udpated?: string;
+}
+export type { ConcurrentSessionUsageInfo };
diff --git a/packages/flow-client/models/ConversationDurationLimitInfo.ts b/packages/flow-client/models/ConversationDurationLimitInfo.ts
@@ -0,0 +1,6 @@
+interface ConversationDurationLimitInfo {
+  message: 'Info';
+  type: 'conversation_duration_limit';
+  conversation_duration_limit: number;
+}
+export type { ConversationDurationLimitInfo };
diff --git a/packages/flow-client/models/ConversationEnding.ts b/packages/flow-client/models/ConversationEnding.ts
@@ -1,5 +1,4 @@
 interface ConversationEnding {
   message: 'ConversationEnding';
-  reason?: string;
 }
 export type { ConversationEnding };
diff --git a/packages/flow-client/models/ConversationStarted.ts b/packages/flow-client/models/ConversationStarted.ts
@@ -1,6 +1,8 @@
+import type { LanguagePackInfo } from './LanguagePackInfo';
 interface ConversationStarted {
   message: 'ConversationStarted';
-  orchestrator_version?: string;
   id?: string;
+  asr_session_id?: string;
+  language_pack_info?: LanguagePackInfo;
 }
 export type { ConversationStarted };
diff --git a/packages/flow-client/models/ConversationTermination.ts b/packages/flow-client/models/ConversationTermination.ts
@@ -0,0 +1,8 @@
+import type { WarningTypeEnum } from './WarningTypeEnum';
+interface ConversationTermination {
+  message: 'Warning';
+  type: WarningTypeEnum;
+  reason: string;
+  conversation_termination: number;
+}
+export type { ConversationTermination };
diff --git a/packages/flow-client/models/DefaultWarning.ts b/packages/flow-client/models/DefaultWarning.ts
@@ -1,10 +1,7 @@
 import type { WarningTypeEnum } from './WarningTypeEnum';
-interface Warning {
+interface DefaultWarning {
   message: 'Warning';
   type: WarningTypeEnum;
   reason: string;
-  code?: number;
-  seq_no?: number;
-  duration_limit?: number;
 }
-export type { Warning };
+export type { DefaultWarning };
diff --git a/packages/flow-client/models/ErrorType.ts b/packages/flow-client/models/ErrorType.ts
@@ -3,7 +3,5 @@ interface ErrorType {
   message: 'Error';
   type: ErrorTypeEnum;
   reason: string;
-  code?: number;
-  seq_no?: number;
 }
 export type { ErrorType };
diff --git a/packages/flow-client/models/ErrorTypeEnum.ts b/packages/flow-client/models/ErrorTypeEnum.ts
@@ -1,17 +1,14 @@
 type ErrorTypeEnum =
-  | 'invalid_message'
-  | 'invalid_model'
-  | 'invalid_config'
-  | 'invalid_audio_type'
-  | 'not_authorised'
-  | 'insufficient_funds'
-  | 'not_allowed'
-  | 'job_error'
-  | 'data_error'
-  | 'buffer_error'
+  | 'asr_error'
   | 'protocol_error'
-  | 'timelimit_exceeded'
+  | 'config_error'
+  | 'idle_timeout'
+  | 'session_timeout'
+  | 'not_allowed'
+  | 'not_authorised'
   | 'quota_exceeded'
-  | 'unknown_error'
-  | 'llm_error';
+  | 'timelimit_exceeded'
+  | 'job_error'
+  | 'internal_error'
+  | 'unknown_error';
 export type { ErrorTypeEnum };
diff --git a/packages/flow-client/models/FlowServerMessage.ts b/packages/flow-client/models/FlowServerMessage.ts
@@ -7,8 +7,12 @@ import type { ResponseCompleted } from './ResponseCompleted';
 import type { ResponseInterrupted } from './ResponseInterrupted';
 import type { ToolInvoke } from './ToolInvoke';
 import type { ErrorType } from './ErrorType';
-import type { Warning } from './Warning';
+import type { DefaultWarning } from './DefaultWarning';
+import type { ConversationTermination } from './ConversationTermination';
 import type { Info } from './Info';
+import type { StatusUpdateInfo } from './StatusUpdateInfo';
+import type { ConversationDurationLimitInfo } from './ConversationDurationLimitInfo';
+import type { ConcurrentSessionUsageInfo } from './ConcurrentSessionUsageInfo';
 import type { ConversationEnding } from './ConversationEnding';
 import type { ConversationEnded } from './ConversationEnded';
 type FlowServerMessage =
@@ -21,8 +25,12 @@ type FlowServerMessage =
   | ResponseInterrupted
   | ToolInvoke
   | ErrorType
-  | Warning
+  | DefaultWarning
+  | ConversationTermination
   | Info
+  | StatusUpdateInfo
+  | ConversationDurationLimitInfo
+  | ConcurrentSessionUsageInfo
   | ConversationEnding
   | ConversationEnded;
 export type { FlowServerMessage };
diff --git a/packages/flow-client/models/Info.ts b/packages/flow-client/models/Info.ts
@@ -1,10 +1,6 @@
-import type { InfoTypeEnum } from './InfoTypeEnum';
 interface Info {
   message: 'Info';
-  type: InfoTypeEnum;
+  type: string;
   reason: string;
-  code?: number;
-  seq_no?: number;
-  quality?: string;
 }
 export type { Info };
diff --git a/packages/flow-client/models/InfoTypeEnum.ts b/packages/flow-client/models/InfoTypeEnum.ts
diff --git a/packages/flow-client/models/LanguagePackInfo.ts b/packages/flow-client/models/LanguagePackInfo.ts
@@ -0,0 +1,9 @@
+import type { WritingDirectionEnum } from './WritingDirectionEnum';
+interface LanguagePackInfo {
+  language_description?: string;
+  word_delimiter: string;
+  writing_direction?: WritingDirectionEnum;
+  itn?: boolean;
+  adapted?: boolean;
+}
+export type { LanguagePackInfo };
diff --git a/packages/flow-client/models/StartConversation.ts b/packages/flow-client/models/StartConversation.ts
@@ -1,11 +1,10 @@
-import type { AudioFormatRaw } from './AudioFormatRaw';
-import type { AudioFormatFile } from './AudioFormatFile';
+import type { AudioFormat } from './AudioFormat';
 import type { ConversationConfig } from './ConversationConfig';
 import type { ToolConfig } from './ToolConfig';
 import type { DebugObject } from './DebugObject';
 interface StartConversation {
   message: 'StartConversation';
-  audio_format: AudioFormatRaw | AudioFormatFile;
+  audio_format?: AudioFormat;
   conversation_config: ConversationConfig;
   tools?: ToolConfig[];
   debug?: DebugObject;
diff --git a/packages/flow-client/models/StatusUpdateInfo.ts b/packages/flow-client/models/StatusUpdateInfo.ts
@@ -0,0 +1,7 @@
+import type { StatusUpdateInfoEvent } from './StatusUpdateInfoEvent';
+interface StatusUpdateInfo {
+  message: 'Info';
+  type: 'status_update';
+  event: StatusUpdateInfoEvent;
+}
+export type { StatusUpdateInfo };
diff --git a/packages/flow-client/models/StatusUpdateInfoEvent.ts b/packages/flow-client/models/StatusUpdateInfoEvent.ts
@@ -0,0 +1,5 @@
+interface StatusUpdateInfoEvent {
+  prev_status: string;
+  status: string;
+}
+export type { StatusUpdateInfoEvent };
diff --git a/packages/flow-client/models/ToolFunction.ts b/packages/flow-client/models/ToolFunction.ts
@@ -1,5 +1,5 @@
 interface ToolFunction {
   name: string;
-  arguments: { [name: string]: string | number | boolean };
+  arguments: { [name: string]: string };
 }
 export type { ToolFunction };
diff --git a/packages/flow-client/models/ToolFunctionParameter.ts b/packages/flow-client/models/ToolFunctionParameter.ts
@@ -3,6 +3,6 @@ interface ToolFunctionParameter {
   type: ToolFunctionParameterTypeEnum;
   description?: string;
   enum?: (string | number)[];
-  example?: string | boolean | number;
+  example?: unknown;
 }
 export type { ToolFunctionParameter };
diff --git a/packages/flow-client/models/ToolInvoke.ts b/packages/flow-client/models/ToolInvoke.ts
@@ -2,6 +2,7 @@ import type { ToolFunction } from './ToolFunction';
 interface ToolInvoke {
   message: 'ToolInvoke';
   id: string;
+  type: 'function';
   function: ToolFunction;
 }
 export type { ToolInvoke };
diff --git a/packages/flow-client/models/WarningTypeEnum.ts b/packages/flow-client/models/WarningTypeEnum.ts
@@ -1,2 +1,12 @@
-type WarningTypeEnum = 'duration_limit_exceeded' | 'llm_error';
+type WarningTypeEnum =
+  | 'conversation_termination'
+  | 'high_asr_latency'
+  | 'llm_error'
+  | 'high_llm_latency'
+  | 'llm_request_content_filter'
+  | 'tts_error'
+  | 'high_tts_latency'
+  | 'protocol_error'
+  | 'idle_timeout'
+  | 'session_timeout';
 export type { WarningTypeEnum };
diff --git a/packages/flow-client/models/WritingDirectionEnum.ts b/packages/flow-client/models/WritingDirectionEnum.ts
@@ -0,0 +1,2 @@
+type WritingDirectionEnum = 'left-to-right' | 'right-to-left';
+export type { WritingDirectionEnum };
diff --git a/packages/flow-client/models/index.ts b/packages/flow-client/models/index.ts
@@ -1,11 +1,8 @@
 export * from './FlowClientMessage';
 export * from './FlowServerMessage';
 export * from './StartConversation';
-export * from './AudioFormatRaw';
-export * from './AudioFormatRawTypeEnum';
+export * from './AudioFormat';
 export * from './AudioFormatRawEncodingEnum';
-export * from './AudioFormatFile';
-export * from './AudioFormatFileTypeEnum';
 export * from './ConversationConfig';
 export * from './ToolConfig';
 export * from './ToolTypeEnum';
@@ -21,6 +18,8 @@ export * from './AddInput';
 export * from './ToolResult';
 export * from './StatusEnum';
 export * from './ConversationStarted';
+export * from './LanguagePackInfo';
+export * from './WritingDirectionEnum';
 export * from './AudioAdded';
 export * from './AddPartialTranscript';
 export * from './RecognitionMetadata';
@@ -38,9 +37,13 @@ export * from './ToolInvoke';
 export * from './ToolFunction';
 export * from './ErrorType';
 export * from './ErrorTypeEnum';
-export * from './Warning';
+export * from './DefaultWarning';
 export * from './WarningTypeEnum';
+export * from './ConversationTermination';
 export * from './Info';
-export * from './InfoTypeEnum';
+export * from './StatusUpdateInfo';
+export * from './StatusUpdateInfoEvent';
+export * from './ConversationDurationLimitInfo';
+export * from './ConcurrentSessionUsageInfo';
 export * from './ConversationEnding';
 export * from './ConversationEnded';
diff --git a/packages/flow-client/package.json b/packages/flow-client/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@speechmatics/flow-client",
-  "version": "1.0.0-rc.4",
+  "version": "1.0.0-rc.5",
   "description": "Javascript client for the Speechmatics Flow API",
   "main": "dist/index.js",
   "files": ["dist/", "README.md"],
diff --git a/packages/flow-client/schema/flow.yml b/packages/flow-client/schema/flow.yml
diff --git a/packages/flow-client/scripts/generate-models.ts b/packages/flow-client/scripts/generate-models.ts
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@speechmatics/flow-client-react",`
`3`		`- "version": "1.0.0-rc.4",`
	`3`	`+ "version": "1.0.0-rc.5",`
`4`	`4`	`"description": "React hooks for interacting with the Speechmatics Flow API",`
`5`	`5`	`"main": "dist/index.cjs",`
`6`	`6`	`"module": "dist/index.js",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`interface ConversationEnding {`
`2`	`2`	`message: 'ConversationEnding';`
`3`		`- reason?: string;`
`4`	`3`	`}`
`5`	`4`	`export type { ConversationEnding };`