@fugood/bricks-project 2.24.0-beta.2 → 2.24.0-beta.21

package/types/generators/RealtimeTranscription.ts

@@ -135,25 +135,84 @@ Default property:
   }
   outlets?: {
     /* Is realtime transcription currently active */
-    isActive?: () => Data
+    isActive?: () => Data<boolean>
     /* Is currently transcribing audio */
-    isTranscribing?: () => Data
+    isTranscribing?: () => Data<boolean>
     /* Current transcription results */
-    results?: () => Data
+    results?: () => Data<
+      Array<{
+        transcribeEvent?: {
+          type?: string
+          sliceIndex?: number
+          isCapturing?: boolean
+          data?: {
+            result?: string
+            [key: string]: any
+          }
+          vadEvent?: {
+            type?: string
+            confidence?: number
+            duration?: number
+            sliceIndex?: number
+            timestamp?: number
+            [key: string]: any
+          }
+          [key: string]: any
+        }
+        vadEvent?: {
+          type?: string
+          confidence?: number
+          duration?: number
+          sliceIndex?: number
+          timestamp?: number
+          [key: string]: any
+        }
+        [key: string]: any
+      }>
+    >
     /* Current transcription result text */
-    resultText?: () => Data
+    resultText?: () => Data<string>
     /* Last stabilized transcription result segment */
-    lastStabilizedSegment?: () => Data
+    lastStabilizedSegment?: () => Data<string>
     /* Current statistics */
-    statistics?: () => Data
+    statistics?: () => Data<{
+      type?: string
+      timestamp?: number
+      data?: { [key: string]: any }
+      [key: string]: any
+    }>
     /* Latest transcribe event */
-    lastTranscribeEvent?: () => Data
+    lastTranscribeEvent?: () => Data<{
+      type?: string
+      sliceIndex?: number
+      isCapturing?: boolean
+      data?: {
+        result?: string
+        [key: string]: any
+      }
+      vadEvent?: {
+        type?: string
+        confidence?: number
+        duration?: number
+        sliceIndex?: number
+        timestamp?: number
+        [key: string]: any
+      }
+      [key: string]: any
+    }>
     /* Latest VAD event */
-    lastVadEvent?: () => Data
+    lastVadEvent?: () => Data<{
+      type?: string
+      confidence?: number
+      duration?: number
+      sliceIndex?: number
+      timestamp?: number
+      [key: string]: any
+    }>
     /* Stabilized transcription text from completed slices */
-    stabilizedText?: () => Data
+    stabilizedText?: () => Data<string>
     /* Audio output file path (auto-generated when saving audio) */
-    audioOutputPath?: () => Data
+    audioOutputPath?: () => Data<string>
   }
 }
 
@@ -161,7 +220,7 @@ Default property:
 export type GeneratorRealtimeTranscription = Generator &
   GeneratorRealtimeTranscriptionDef & {
     templateKey: 'GENERATOR_REALTIME_TRANSCRIPTION'
-    switches: Array<
+    switches?: Array<
       SwitchDef &
         GeneratorRealtimeTranscriptionDef & {
           conds?: Array<{

package/types/generators/RerankerGgml.ts

@@ -69,13 +69,13 @@ Default property:
     batchSize?: number | DataLink
     /* Physical maximum batch size (default: 512) */
     uBatchSize?: number | DataLink
-    /* GGML accelerator variant (Only for desktop)  
+    /* GGML accelerator variant (Only for desktop)
  `default` - CPU / Metal (macOS)  
  `vulkan` - Use Vulkan  
  `cuda` - Use CUDA  
  `snapdragon` - Use OpenCL/Hexagon of Qualcomm Snapdragon */
     accelVariant?: 'default' | 'vulkan' | 'cuda' | 'snapdragon' | DataLink
-    /* Devices. For example:  
+    /* Devices. For example:
   
  Metal or CPU for iOS/tvOS/MacOS  
  OpenCL or CPU for Android  
@@ -109,19 +109,33 @@ Default property:
   }
   outlets?: {
     /* Current state of the reranker context (loading, ready, error, released) */
-    contextState?: () => Data
+    contextState?: () => Data<string>
     /* Loading progress of the reranker model (0-100) */
-    contextLoadProgress?: () => Data
+    contextLoadProgress?: () => Data<number>
     /* Detailed information about the reranker context including instance ID and processing status */
-    contextDetails?: () => Data
+    contextDetails?: () => Data<{
+      state?: string
+      contextId?: string
+      gpu?: string
+      reasonNoGPU?: string
+      [key: string]: any
+    }>
     /* Result of the reranking operation containing scored and ranked documents */
-    rerankResult?: () => Data
+    rerankResult?: () => Data<
+      Array<{
+        index?: number
+        score?: number
+        text?: string
+        payload?: { [key: string]: any }
+        [key: string]: any
+      }>
+    >
     /* Boolean indicating whether the reranker is currently processing a request */
-    isProcessing?: () => Data
+    isProcessing?: () => Data<boolean>
   }
 }
 
-/* Local rerank based on GGML and [llama.cpp](https://github.com/ggerganov/llama.cpp)  
+/* Local rerank based on GGML and [llama.cpp](https://github.com/ggerganov/llama.cpp)
 
  ## Notice  
  - The device RAM must be larger than 8GB  
@@ -136,7 +150,7 @@ Default property:
 export type GeneratorReranker = Generator &
   GeneratorRerankerDef & {
     templateKey: 'GENERATOR_RERANKER'
-    switches: Array<
+    switches?: Array<
       SwitchDef &
         GeneratorRerankerDef & {
           conds?: Array<{

package/types/generators/SerialPort.ts

@@ -103,15 +103,15 @@ Default property:
   }
   outlets?: {
     /* Available serial devices */
-    generatorSerialDeviceList?: () => Data
+    generatorSerialDeviceList?: () => Data<Array<{ [key: string]: any }>>
     /* Is serial open */
-    generatorSerialIsOpen?: () => Data
+    generatorSerialIsOpen?: () => Data<boolean>
     /* Last rerceive data (Base64) */
-    generatorSerialLastDataBase64?: () => Data
+    generatorSerialLastDataBase64?: () => Data<string>
     /* Last rerceive plain text */
-    generatorSerialLastDataString?: () => Data
+    generatorSerialLastDataString?: () => Data<string>
     /* Error message */
-    generatorSerialErrorMessage?: () => Data
+    generatorSerialErrorMessage?: () => Data<string>
   }
 }
 
@@ -119,7 +119,7 @@ Default property:
 export type GeneratorSerialPort = Generator &
   GeneratorSerialPortDef & {
     templateKey: 'GENERATOR_SERIAL_PORT'
-    switches: Array<
+    switches?: Array<
       SwitchDef &
         GeneratorSerialPortDef & {
           conds?: Array<{

package/types/generators/SoundPlayer.ts

@@ -61,7 +61,7 @@ Default property:
   }
   outlets?: {
     /* Whether the sound is playing */
-    isPlaying?: () => Data
+    isPlaying?: () => Data<any>
   }
 }
 
@@ -69,7 +69,7 @@ Default property:
 export type GeneratorSoundPlayer = Generator &
   GeneratorSoundPlayerDef & {
     templateKey: 'GENERATOR_SOUND_PLAYER'
-    switches: Array<
+    switches?: Array<
       SwitchDef &
         GeneratorSoundPlayerDef & {
           conds?: Array<{

package/types/generators/SoundRecorder.ts

@@ -82,13 +82,13 @@ Default property:
   }
   outlets?: {
     /* Is recording */
-    isRecording?: () => Data
+    isRecording?: () => Data<boolean>
     /* Recorded file path */
-    recordedPath?: () => Data
+    recordedPath?: () => Data<string>
     /* Current auto-cutting detected volume */
-    volume?: () => Data
+    volume?: () => Data<number>
     /* Error message */
-    errorMessage?: () => Data
+    errorMessage?: () => Data<string>
   }
 }
 
@@ -96,7 +96,7 @@ Default property:
 export type GeneratorSoundRecorder = Generator &
   GeneratorSoundRecorderDef & {
     templateKey: 'GENERATOR_SOUND_RECORDER'
-    switches: Array<
+    switches?: Array<
       SwitchDef &
         GeneratorSoundRecorderDef & {
           conds?: Array<{

package/types/generators/SpeechToTextGgml.ts

@@ -109,15 +109,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 +168,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 +302,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 */
@@ -329,23 +329,43 @@ Default property:
   }
   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 +375,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

@@ -67,7 +67,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 +174,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 */
@@ -197,20 +197,20 @@ Default property:
   }
   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

@@ -46,11 +46,11 @@ Default property:
   }
   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 +58,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

@@ -114,15 +114,19 @@ Default property:
   }
   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
+    }>
   }
 }
 
@@ -130,7 +134,7 @@ Default property:
 export type GeneratorSqlite = Generator &
   GeneratorSqliteDef & {
     templateKey: 'GENERATOR_SQLITE'
-    switches: Array<
+    switches?: Array<
       SwitchDef &
         GeneratorSqliteDef & {
           conds?: Array<{

package/types/generators/Step.ts

@@ -74,9 +74,9 @@ Default property:
   }
   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 +84,7 @@ Default property:
 export type GeneratorStep = Generator &
   GeneratorStepDef & {
     templateKey: 'GENERATOR_STEP'
-    switches: Array<
+    switches?: Array<
       SwitchDef &
         GeneratorStepDef & {
           conds?: Array<{

package/types/generators/SttAppleBuiltin.ts

@@ -77,17 +77,17 @@ Default property:
   }
   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 +98,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

@@ -57,7 +57,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 */
@@ -91,11 +91,11 @@ Default property:
   }
   outlets?: {
     /* Connection status */
-    status?: () => Data
+    status?: () => Data<string>
     /* Last received data */
-    lastData?: () => Data
+    lastData?: () => Data<string>
     /* Error message */
-    errorMessage?: () => Data
+    errorMessage?: () => Data<string>
   }
 }
 
@@ -103,7 +103,7 @@ Default property:
 export type GeneratorTCP = Generator &
   GeneratorTCPDef & {
     templateKey: 'GENERATOR_TCP'
-    switches: Array<
+    switches?: Array<
       SwitchDef &
         GeneratorTCPDef & {
           conds?: Array<{

package/types/generators/TcpServer.ts

@@ -72,7 +72,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 */
@@ -106,15 +106,15 @@ Default property:
   }
   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>
   }
 }
 
@@ -122,7 +122,7 @@ Default property:
 export type GeneratorTCPServer = Generator &
   GeneratorTCPServerDef & {
     templateKey: 'GENERATOR_TCP_SERVER'
-    switches: Array<
+    switches?: Array<
       SwitchDef &
         GeneratorTCPServerDef & {
           conds?: Array<{

package/types/generators/TextToSpeechApple.ts

@@ -83,7 +83,7 @@ Default property:
   }
 }
 
-/* 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  

package/types/generators/TextToSpeechAppleBuiltin.ts

@@ -76,15 +76,15 @@ Default property:
   }
   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 +95,7 @@ Default property:
 export type GeneratorAppleTTS = Generator &
   GeneratorAppleTTSDef & {
     templateKey: 'GENERATOR_APPLE_TTS'
-    switches: Array<
+    switches?: Array<
       SwitchDef &
         GeneratorAppleTTSDef & {
           conds?: Array<{

package/types/generators/TextToSpeechGgml.ts

@@ -75,7 +75,7 @@ Default property:
   property?: {
     /* Initialize the TTS context on generator initialization */
     init?: boolean | DataLink
-    /* The URL or path of model  
+    /* The URL or path of model
  We used GGUF format model, please refer to https://github.com/ggerganov/llama.cpp/tree/master#description */
     modelUrl?: string | DataLink
     /* Hash type of model */
@@ -128,13 +128,13 @@ Default property:
     microBatchSize?: number | DataLink
     /* Number of threads */
     maxThreads?: number | DataLink
-    /* Accelerator variant (Only for desktop)  
+    /* Accelerator variant (Only for desktop)
  `default` - CPU / Metal (macOS)  
  `vulkan` - Use Vulkan  
  `cuda` - Use CUDA  
  `snapdragon` - Use OpenCL/Hexagon of Qualcomm Snapdragon */
     accelVariant?: 'default' | 'vulkan' | 'cuda' | 'snapdragon' | DataLink
-    /* Devices. For example:  
+    /* Devices. For example:
   
  Metal or CPU for iOS/tvOS/MacOS  
  OpenCL or CPU for Android  
@@ -160,15 +160,15 @@ Default property:
   }
   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>
   }
 }
 
-/* Local Text-to-Speech (TTS) inference based on GGML and [llama.cpp](https://github.com/ggerganov/llama.cpp)  
+/* Local Text-to-Speech (TTS) inference based on GGML and [llama.cpp](https://github.com/ggerganov/llama.cpp)
  You can use any converted model on HuggingFace.  
 
  ## Notice  
@@ -184,7 +184,7 @@ Default property:
 export type GeneratorGGMLTTS = Generator &
   GeneratorGGMLTTSDef & {
     templateKey: 'GENERATOR_GGML_TTS'
-    switches: Array<
+    switches?: Array<
       SwitchDef &
         GeneratorGGMLTTSDef & {
           conds?: Array<{