@fugood/bricks-project 2.24.0-beta.4 → 2.24.0-beta.41

package/types/generators/SpeechToTextGgml.ts

@@ -1,4 +1,13 @@
-/* Auto generated by build script */
+/* Auto generated by build script
+ *
+ * Local Speech-to-Text (STT) inference based on GGML and [whisper.cpp](https://github.com/ggerganov/whisper.cpp)
+ *
+ *  ## Notice
+ *  - iOS: Supported GPU acceleration, recommended use M1+ / A17+ chip device
+ *  - macOS: Supported GPU acceleration, recommended use M1+ chip device
+ *  - Android: Currently not supported GPU acceleration (Coming soon), recommended use Android 13+ system
+ *  - Linux / Windows: Supported GPU acceleration, you can choose `vulkan` or `cuda` backend in Accel Variant property
+ */
 import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
 import type { Data, DataLink } from '../data'
 import type {
@@ -10,6 +19,7 @@ import type {
   Action,
   EventProperty,
 } from '../common'
+import type { TemplateEventPropsMap } from '../../utils/event-props'
 
 /* Load the model */
 export type GeneratorSpeechInferenceActionLoadModel = Action & {
@@ -109,15 +119,15 @@ Default property:
 }
   */
   property?: {
-    /* Initialize the Whisper context on generator initialization  
+    /* Initialize the Whisper context on generator initialization
  Please note that it will take some RAM depending on the model size */
     init?: boolean | DataLink
-    /* Accelerator variant (Only for desktop)  
+    /* Accelerator variant (Only for desktop)
  `default` - CPU / Metal (macOS)  
  `vulkan` - Use Vulkan  
  `cuda` - Use CUDA */
     accelVariant?: 'default' | 'vulkan' | 'cuda' | DataLink
-    /* Use model name,  the model download progress will be done in preload stage or  the generator initialization stage.  
+    /* Use model name,  the model download progress will be done in preload stage or  the generator initialization stage.
  We used `ggml` format model, please refer to https://huggingface.co/BricksDisplay/whisper-ggml  
  You can also choose `custom` option and set `Model URL` and `Model MD5` to use your own model */
     modelName?:
@@ -168,7 +178,7 @@ Default property:
       | 'distil-large-v3-q5_0'
       | 'distil-large-v3-q8_0'
       | DataLink
-    /* The URL or path of model  
+    /* The URL or path of model
  We used `ggml` format model, please refer to https://github.com/ggerganov/whisper.cpp/tree/master/models */
     modelUrl?: string | DataLink
     /* Hash type of model */
@@ -302,7 +312,7 @@ Default property:
     inferOffset?: number | DataLink
     /* Audio duration of audio to process in milliseconds */
     inferDuration?: number | DataLink
-    /* The file URL or path to be inferred.  
+    /* The file URL or path to be inferred.
  It only supported `wav` format with 16kHz sample rate & single (mono) channel */
     inferFileUrl?: string | DataLink
     /* MD5 of file to be inferred */
@@ -319,33 +329,57 @@ Default property:
   }
   events?: {
     /* Event triggered when context state changes */
-    onContextStateChange?: Array<EventAction>
+    onContextStateChange?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['SpeechInference']['onContextStateChange']>
+    >
     /* Event triggered when error occurs */
-    onError?: Array<EventAction>
+    onError?: Array<EventAction<string & keyof TemplateEventPropsMap['SpeechInference']['onError']>>
     /* Event triggered when got transcribe result */
-    onTranscribed?: Array<EventAction>
+    onTranscribed?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['SpeechInference']['onTranscribed']>
+    >
     /* Event triggered when transcribe realtime done */
     onRealtimeStop?: Array<EventAction>
   }
   outlets?: {
     /* Context state */
-    contextState?: () => Data
+    contextState?: () => Data<string>
     /* Context details */
-    contextDetails?: () => Data
+    contextDetails?: () => Data<{
+      state?: string
+      contextId?: string
+      gpu?: string
+      reasonNoGPU?: string
+      [key: string]: any
+    }>
     /* Is transcribing */
-    isTranscribing?: () => Data
+    isTranscribing?: () => Data<boolean>
     /* Progress of transcribe audio (0-100) */
-    transcribeProgress?: () => Data
+    transcribeProgress?: () => Data<number>
     /* Inference result */
-    transcribeResult?: () => Data
+    transcribeResult?: () => Data<string>
     /* Inference result details */
-    transcribeDetails?: () => Data
+    transcribeDetails?: () => Data<{
+      result?: string
+      segments?: Array<{
+        start?: number
+        end?: number
+        confidence?: number
+        t0?: number
+        t1?: number
+        [key: string]: any
+      }>
+      time?: number
+      startTime?: number
+      endTime?: number
+      [key: string]: any
+    }>
     /* Recorded audio file path of transcribe realtime (if `Save Audio` is enabled) */
-    recordedPath?: () => Data
+    recordedPath?: () => Data<string>
   }
 }
 
-/* Local Speech-to-Text (STT) inference based on GGML and [whisper.cpp](https://github.com/ggerganov/whisper.cpp)  
+/* Local Speech-to-Text (STT) inference based on GGML and [whisper.cpp](https://github.com/ggerganov/whisper.cpp)
 
  ## Notice  
  - iOS: Supported GPU acceleration, recommended use M1+ / A17+ chip device  
@@ -355,7 +389,7 @@ Default property:
 export type GeneratorSpeechInference = Generator &
   GeneratorSpeechInferenceDef & {
     templateKey: 'GENERATOR_SPEECH_INFERENCE'
-    switches: Array<
+    switches?: Array<
       SwitchDef &
         GeneratorSpeechInferenceDef & {
           conds?: Array<{

package/types/generators/SpeechToTextOnnx.ts

@@ -1,4 +1,8 @@
-/* Auto generated by build script */
+/* Auto generated by build script
+ *
+ * Local STT inference based on [transformers.js](https://huggingface.co/docs/transformers.js)
+ *  You can use any converted model on HuggingFace.
+ */
 import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
 import type { Data, DataLink } from '../data'
 import type {
@@ -10,6 +14,7 @@ import type {
   Action,
   EventProperty,
 } from '../common'
+import type { TemplateEventPropsMap } from '../../utils/event-props'
 
 /* Load the model */
 export type GeneratorOnnxSTTActionLoadModel = Action & {
@@ -67,7 +72,7 @@ Default property:
       | DataLink
     /* Return timestamps */
     returnTimestamps?: 'none' | 'enable' | 'word' | DataLink
-    /* Transcription language  
+    /* Transcription language
   Not specifying the language will auto detect the language. */
     language?:
       | 'English'
@@ -174,12 +179,12 @@ Default property:
     task?: 'transcribe' | 'translate' | DataLink
     /* Inferencing chunk length */
     chunkLength?: number | DataLink
-    /* Executor candidates, descending order of priority  
+    /* Executor candidates, descending order of priority
   Default will be xnnpack, wasm, cpu */
     executors?:
       | Array<'qnn' | 'dml' | 'nnapi' | 'xnnpack' | 'coreml' | 'cpu' | 'wasm' | 'webgpu' | DataLink>
       | DataLink
-    /* Execution mode  
+    /* Execution mode
   Usually when the model has many branches, setting this option to `parallel` will give you better performance. */
     executionMode?: 'sequential' | 'parallel' | DataLink
     /* QNN backend */
@@ -191,26 +196,28 @@ Default property:
   }
   events?: {
     /* Event triggered when state change */
-    onContextStateChange?: Array<EventAction>
+    onContextStateChange?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['OnnxStt']['onContextStateChange']>
+    >
     /* Event triggered when error occurs */
-    onError?: Array<EventAction>
+    onError?: Array<EventAction<string & keyof TemplateEventPropsMap['OnnxStt']['onError']>>
   }
   outlets?: {
     /* Context state */
-    contextState?: () => Data
+    contextState?: () => Data<string>
     /* Inference result */
-    result?: () => Data
+    result?: () => Data<string>
     /* Inference result detail */
-    resultDetail?: () => Data
+    resultDetail?: () => Data<{ [key: string]: any }>
   }
 }
 
-/* Local STT inference based on [transformers.js](https://huggingface.co/docs/transformers.js)  
+/* Local STT inference based on [transformers.js](https://huggingface.co/docs/transformers.js)
  You can use any converted model on HuggingFace. */
 export type GeneratorOnnxSTT = Generator &
   GeneratorOnnxSTTDef & {
     templateKey: 'GENERATOR_ONNX_STT'
-    switches: Array<
+    switches?: Array<
       SwitchDef &
         GeneratorOnnxSTTDef & {
           conds?: Array<{

package/types/generators/SpeechToTextPlatform.ts

@@ -1,4 +1,7 @@
-/* Auto generated by build script */
+/* Auto generated by build script
+ *
+ * Speech-to-Text using platform's native capabilities
+ */
 import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
 import type { Data, DataLink } from '../data'
 import type {
@@ -10,6 +13,7 @@ import type {
   Action,
   EventProperty,
 } from '../common'
+import type { TemplateEventPropsMap } from '../../utils/event-props'
 
 /* Start speech recognition */
 export type GeneratorPlatformSTTActionStart = Action & {
@@ -40,17 +44,21 @@ Default property:
     /* Event for speech recognition end */
     onSpeechEnd?: Array<EventAction>
     /* Event for speech recognition results */
-    onSpeechResults?: Array<EventAction>
+    onSpeechResults?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['PlatformStt']['onSpeechResults']>
+    >
     /* Event for speech recognition error */
-    onSpeechError?: Array<EventAction>
+    onSpeechError?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['PlatformStt']['onSpeechError']>
+    >
   }
   outlets?: {
     /* Recognized speech text */
-    recognizedText?: () => Data
+    recognizedText?: () => Data<string>
     /* Error message */
-    errorMessage?: () => Data
+    errorMessage?: () => Data<string>
     /* Listening status */
-    listening?: () => Data
+    listening?: () => Data<boolean>
   }
 }
 
@@ -58,7 +66,7 @@ Default property:
 export type GeneratorPlatformSTT = Generator &
   GeneratorPlatformSTTDef & {
     templateKey: 'GENERATOR_PLATFORM_STT'
-    switches: Array<
+    switches?: Array<
       SwitchDef &
         GeneratorPlatformSTTDef & {
           conds?: Array<{

package/types/generators/SqLite.ts

@@ -1,4 +1,7 @@
-/* Auto generated by build script */
+/* Auto generated by build script
+ *
+ * SQLite database: create tables, query, insert, update, and delete with SQL
+ */
 import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
 import type { Data, DataLink } from '../data'
 import type {
@@ -10,6 +13,7 @@ import type {
   Action,
   EventProperty,
 } from '../common'
+import type { TemplateEventPropsMap } from '../../utils/event-props'
 
 /* Execute SQL statement */
 export type GeneratorSqliteActionExecute = ActionWithParams & {
@@ -108,29 +112,35 @@ Default property:
   }
   events?: {
     /* Event triggered when error occurs */
-    onError?: Array<EventAction>
+    onError?: Array<EventAction<string & keyof TemplateEventPropsMap['Sqlite']['onError']>>
     /* Event triggered when query result is ready */
-    onQueryResult?: Array<EventAction>
+    onQueryResult?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['Sqlite']['onQueryResult']>
+    >
   }
   outlets?: {
     /* Whether the database is ready */
-    isReady?: () => Data
+    isReady?: () => Data<boolean>
     /* Database path */
-    dbPath?: () => Data
+    dbPath?: () => Data<string>
     /* Error message */
-    error?: () => Data
+    error?: () => Data<string>
     /* Last query result */
-    lastResult?: () => Data
+    lastResult?: () => Data<Array<{ [key: string]: any }>>
     /* Last execute result with metadata */
-    lastExecuteResult?: () => Data
+    lastExecuteResult?: () => Data<{
+      rowsAffected?: number
+      insertId?: number
+      [key: string]: any
+    }>
   }
 }
 
-/* SQLite - General database operations */
+/* SQLite database: create tables, query, insert, update, and delete with SQL */
 export type GeneratorSqlite = Generator &
   GeneratorSqliteDef & {
     templateKey: 'GENERATOR_SQLITE'
-    switches: Array<
+    switches?: Array<
       SwitchDef &
         GeneratorSqliteDef & {
           conds?: Array<{

package/types/generators/Step.ts

@@ -1,4 +1,7 @@
-/* Auto generated by build script */
+/* Auto generated by build script
+ *
+ * Trigger change canvas / outlet / event by setup rules
+ */
 import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
 import type { Data, DataLink } from '../data'
 import type {
@@ -10,6 +13,7 @@ import type {
   Action,
   EventProperty,
 } from '../common'
+import type { TemplateEventPropsMap } from '../../utils/event-props'
 
 /* Start execute the step */
 export type GeneratorStepActionStart = Action & {
@@ -70,13 +74,13 @@ Default property:
   }
   events?: {
     /* Event on step (If action is `event`) */
-    onStep?: Array<EventAction>
+    onStep?: Array<EventAction<string & keyof TemplateEventPropsMap['Step']['onStep']>>
   }
   outlets?: {
     /* Result of step payload (If action is `outlet`) */
-    payload?: () => Data
+    payload?: () => Data<string>
     /* Result of step index (If action is `outlet`) */
-    index?: () => Data
+    index?: () => Data<number>
   }
 }
 
@@ -84,7 +88,7 @@ Default property:
 export type GeneratorStep = Generator &
   GeneratorStepDef & {
     templateKey: 'GENERATOR_STEP'
-    switches: Array<
+    switches?: Array<
       SwitchDef &
         GeneratorStepDef & {
           conds?: Array<{

package/types/generators/SttAppleBuiltin.ts

@@ -1,4 +1,14 @@
-/* Auto generated by build script */
+/* Auto generated by build script
+ *
+ * Speech recognition on iOS 26+ (Not supported on tvOS)
+ *
+ *  ## Features
+ *  - Native Apple speech recognition
+ *  - High accuracy transcription
+ *  - Privacy-focused on-device processing
+ *  - Supports file and data transcription
+ *  - Requires iOS 26+ (Not supported on tvOS)
+ */
 import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
 import type { Data, DataLink } from '../data'
 import type {
@@ -10,6 +20,7 @@ import type {
   Action,
   EventProperty,
 } from '../common'
+import type { TemplateEventPropsMap } from '../../utils/event-props'
 
 /* Initialize STT */
 export type GeneratorAppleSTTActionInit = Action & {
@@ -71,23 +82,25 @@ Default property:
   }
   events?: {
     /* Error event */
-    onError?: Array<EventAction>
+    onError?: Array<EventAction<string & keyof TemplateEventPropsMap['AppleStt']['onError']>>
     /* Event triggered when got transcribe result */
-    onTranscribed?: Array<EventAction>
+    onTranscribed?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['AppleStt']['onTranscribed']>
+    >
   }
   outlets?: {
     /* State outlet (loading, ready, error) */
-    state?: () => Data
+    state?: () => Data<string>
     /* Is transcribing */
-    isTranscribing?: () => Data
+    isTranscribing?: () => Data<boolean>
     /* Transcribe result */
-    transcribeResult?: () => Data
+    transcribeResult?: () => Data<string>
     /* Transcribe result details (result, segments, time, startTime, endTime, duration) */
-    transcribeDetails?: () => Data
+    transcribeDetails?: () => Data<{ [key: string]: any }>
   }
 }
 
-/* Speech recognition on iOS 26+ (Not supported on tvOS)  
+/* Speech recognition on iOS 26+ (Not supported on tvOS)
 
  ## Features  
  - Native Apple speech recognition  
@@ -98,7 +111,7 @@ Default property:
 export type GeneratorAppleSTT = Generator &
   GeneratorAppleSTTDef & {
     templateKey: 'GENERATOR_APPLE_STT'
-    switches: Array<
+    switches?: Array<
       SwitchDef &
         GeneratorAppleSTTDef & {
           conds?: Array<{

package/types/generators/Tcp.ts

@@ -1,4 +1,7 @@
-/* Auto generated by build script */
+/* Auto generated by build script
+ *
+ * TCP socket client with data modes (CRLF/LF/raw), encodings (base64/utf8/ascii), TLS, and keepalive support
+ */
 import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
 import type { Data, DataLink } from '../data'
 import type {
@@ -10,6 +13,7 @@ import type {
   Action,
   EventProperty,
 } from '../common'
+import type { TemplateEventPropsMap } from '../../utils/event-props'
 
 /* Start connect */
 export type GeneratorTCPActionConnect = Action & {
@@ -57,7 +61,7 @@ Default property:
     host?: string | DataLink
     /* Connection target port */
     port?: number | DataLink
-    /* Data mode  
+    /* Data mode
   CRLF: Receive until CRLF  
   LF: Receive until LF  
   raw: Raw packet */
@@ -81,29 +85,29 @@ Default property:
     /* Event of connect successful */
     onConnected?: Array<EventAction>
     /* Event of receive data */
-    onData?: Array<EventAction>
+    onData?: Array<EventAction<string & keyof TemplateEventPropsMap['Tcp']['onData']>>
     /* Event of connection idle timeout */
     onTimeout?: Array<EventAction>
     /* Event of connection close */
     onClose?: Array<EventAction>
     /* Event of connection error */
-    onError?: Array<EventAction>
+    onError?: Array<EventAction<string & keyof TemplateEventPropsMap['Tcp']['onError']>>
   }
   outlets?: {
     /* Connection status */
-    status?: () => Data
+    status?: () => Data<string>
     /* Last received data */
-    lastData?: () => Data
+    lastData?: () => Data<string>
     /* Error message */
-    errorMessage?: () => Data
+    errorMessage?: () => Data<string>
   }
 }
 
-/* TCP */
+/* TCP socket client with data modes (CRLF/LF/raw), encodings (base64/utf8/ascii), TLS, and keepalive support */
 export type GeneratorTCP = Generator &
   GeneratorTCPDef & {
     templateKey: 'GENERATOR_TCP'
-    switches: Array<
+    switches?: Array<
       SwitchDef &
         GeneratorTCPDef & {
           conds?: Array<{

package/types/generators/TcpServer.ts

@@ -1,4 +1,7 @@
-/* Auto generated by build script */
+/* Auto generated by build script
+ *
+ * TCP server with multi-client support, data modes (CRLF/LF/raw), encodings (base64/utf8/ascii), concurrent connection limit, and TLS
+ */
 import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
 import type { Data, DataLink } from '../data'
 import type {
@@ -10,6 +13,7 @@ import type {
   Action,
   EventProperty,
 } from '../common'
+import type { TemplateEventPropsMap } from '../../utils/event-props'
 
 /* Start TCP server */
 export type GeneratorTCPServerActionStart = Action & {
@@ -72,7 +76,7 @@ Default property:
     init?: boolean | DataLink
     /* Bind port of TCP server */
     port?: number | DataLink
-    /* Data mode  
+    /* Data mode
   CRLF: Receive until CRLF  
   LF: Receive until LF  
   raw: Raw packet */
@@ -94,35 +98,37 @@ Default property:
     /* Event of TCP server is ready */
     onReady?: Array<EventAction>
     /* Event of TCP server accept the connection */
-    onAcceptConnection?: Array<EventAction>
+    onAcceptConnection?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['TcpServer']['onAcceptConnection']>
+    >
     /* Event of receive data */
-    onData?: Array<EventAction>
+    onData?: Array<EventAction<string & keyof TemplateEventPropsMap['TcpServer']['onData']>>
     /* Event of connection idle timeout */
-    onTimeout?: Array<EventAction>
+    onTimeout?: Array<EventAction<string & keyof TemplateEventPropsMap['TcpServer']['onTimeout']>>
     /* Event of connection close */
-    onClose?: Array<EventAction>
+    onClose?: Array<EventAction<string & keyof TemplateEventPropsMap['TcpServer']['onClose']>>
     /* Event of server or connection error */
-    onError?: Array<EventAction>
+    onError?: Array<EventAction<string & keyof TemplateEventPropsMap['TcpServer']['onError']>>
   }
   outlets?: {
     /* Server is listening */
-    isListening?: () => Data
+    isListening?: () => Data<boolean>
     /* Is server started */
-    started?: () => Data
+    started?: () => Data<boolean>
     /* Accepted connections */
-    connections?: () => Data
+    connections?: () => Data<Array<string>>
     /* Last received data */
-    lastData?: () => Data
+    lastData?: () => Data<string>
     /* Error message */
-    errorMessage?: () => Data
+    errorMessage?: () => Data<string>
   }
 }
 
-/* TCP Server */
+/* TCP server with multi-client support, data modes (CRLF/LF/raw), encodings (base64/utf8/ascii), concurrent connection limit, and TLS */
 export type GeneratorTCPServer = Generator &
   GeneratorTCPServerDef & {
     templateKey: 'GENERATOR_TCP_SERVER'
-    switches: Array<
+    switches?: Array<
       SwitchDef &
         GeneratorTCPServerDef & {
           conds?: Array<{

package/types/generators/TextToSpeechAppleBuiltin.ts

@@ -1,4 +1,14 @@
-/* Auto generated by build script */
+/* Auto generated by build script
+ *
+ * Text-to-speech synthesis using Apple's native speech synthesis
+ *
+ *  ## Features
+ *  - Native Apple speech synthesis
+ *  - Natural sounding voices
+ *  - Privacy-focused on-device processing
+ *  - Multiple voice options
+ *  - Requires iOS 13+ (native speech synthesis)
+ */
 import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
 import type { Data, DataLink } from '../data'
 import type {
@@ -10,6 +20,7 @@ import type {
   Action,
   EventProperty,
 } from '../common'
+import type { TemplateEventPropsMap } from '../../utils/event-props'
 
 /* Load the TTS model */
 export type GeneratorAppleTTSActionLoadModel = Action & {
@@ -70,21 +81,23 @@ Default property:
   }
   events?: {
     /* Event triggered when state change */
-    onContextStateChange?: Array<EventAction>
+    onContextStateChange?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['AppleTts']['onContextStateChange']>
+    >
     /* Event triggered when error occurs */
-    onError?: Array<EventAction>
+    onError?: Array<EventAction<string & keyof TemplateEventPropsMap['AppleTts']['onError']>>
   }
   outlets?: {
     /* Context state */
-    contextState?: () => Data
+    contextState?: () => Data<string>
     /* Generated audio file */
-    generatedAudio?: () => Data
+    generatedAudio?: () => Data<string>
     /* Generated audio file is playing */
-    generatedAudioPlaying?: () => Data
+    generatedAudioPlaying?: () => Data<boolean>
   }
 }
 
-/* Text-to-speech synthesis using Apple's native speech synthesis  
+/* Text-to-speech synthesis using Apple's native speech synthesis
 
  ## Features  
  - Native Apple speech synthesis  
@@ -95,7 +108,7 @@ Default property:
 export type GeneratorAppleTTS = Generator &
   GeneratorAppleTTSDef & {
     templateKey: 'GENERATOR_APPLE_TTS'
-    switches: Array<
+    switches?: Array<
       SwitchDef &
         GeneratorAppleTTSDef & {
           conds?: Array<{