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

package/types/generators/TextToSpeechGgml.ts

@@ -1,4 +1,19 @@
-/* Auto generated by build script */
+/* Auto generated by build script
+ *
+ * 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
+ *  - The device RAM must be larger than 8GB
+ *  - iOS: Recommended use M1+ / A17+ chip device. Supported GPU acceleration by Metal.
+ *  - macOS: Recommended use M1+ chip device. Supported GPU acceleration by Metal.
+ *  - Android: Recommended use Android 13+ system.
+ *    - Supported GPU acceleration by OpenCL, currently only for Qualcomm Adreno 700+ GPUs, other GPUs are not supported.
+ *    - Supported Hexagon NPU for Qualcomm Snapdragon 8 Gen 2+ GPUs.
+ *  - Linux / Windows
+ *    - Supported GPU acceleration, you can choose `vulkan` or `cuda` backend in Accel Variant property
+ *    - Supported Hexagon NPU for Qualcomm Dragonwing IQ9 series+ (Linux)
+ */
 import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
 import type { Data, DataLink } from '../data'
 import type {
@@ -10,6 +25,7 @@ import type {
   Action,
   EventProperty,
 } from '../common'
+import type { TemplateEventPropsMap } from '../../utils/event-props'
 
 /* Load the model */
 export type GeneratorGGMLTTSActionLoadModel = Action & {
@@ -75,7 +91,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 +144,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  
@@ -154,21 +170,23 @@ Default property:
   }
   events?: {
     /* Event triggered when state change */
-    onContextStateChange?: Array<EventAction>
+    onContextStateChange?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['GgmlTts']['onContextStateChange']>
+    >
     /* Event triggered when error occurs */
-    onError?: Array<EventAction>
+    onError?: Array<EventAction<string & keyof TemplateEventPropsMap['GgmlTts']['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>
   }
 }
 
-/* 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 +202,7 @@ Default property:
 export type GeneratorGGMLTTS = Generator &
   GeneratorGGMLTTSDef & {
     templateKey: 'GENERATOR_GGML_TTS'
-    switches: Array<
+    switches?: Array<
       SwitchDef &
         GeneratorGGMLTTSDef & {
           conds?: Array<{

package/types/generators/TextToSpeechOnnx.ts

@@ -1,4 +1,8 @@
-/* Auto generated by build script */
+/* Auto generated by build script
+ *
+ * Local Text-to-Speech (TTS) inference based on ONNX Runtime and [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 GeneratorTTSActionLoadModel = Action & {
@@ -64,7 +69,7 @@ Default property:
   property?: {
     /* Initialize the TTS context on generator initialization */
     init?: boolean | DataLink
-    /* TTS model  
+    /* TTS model
  The mms-tts models are licensed under CC-BY-NC-4.0 */
     model?: string | DataLink
     /* Model type */
@@ -83,7 +88,7 @@ Default property:
       | DataLink
     /* Vocoder model for SpeechT5 */
     vocoderModel?: 'Custom' | 'speecht5_hifigan' | DataLink
-    /* Custom vocoder model  
+    /* Custom vocoder model
  Choose model from https://huggingface.co/models?library=transformers.js&other=hifigan */
     customVocoderModel?: string | DataLink
     /* Speaker embedding, for SpeechT5 or StyleTTS (Kokoro) */
@@ -116,12 +121,12 @@ Default property:
     softBreakRegex?: string | DataLink
     /* Time to force inference when softBreakRegex is not satisfied */
     hardBreakTime?: 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 */
@@ -133,26 +138,28 @@ Default property:
   }
   events?: {
     /* Event triggered when state change */
-    onContextStateChange?: Array<EventAction>
+    onContextStateChange?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['Tts']['onContextStateChange']>
+    >
     /* Event triggered when error occurs */
-    onError?: Array<EventAction>
+    onError?: Array<EventAction<string & keyof TemplateEventPropsMap['Tts']['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>
   }
 }
 
-/* Local Text-to-Speech (TTS) inference based on ONNX Runtime and [transformers.js](https://huggingface.co/docs/transformers.js)  
+/* Local Text-to-Speech (TTS) inference based on ONNX Runtime and [transformers.js](https://huggingface.co/docs/transformers.js)
  You can use any converted model on HuggingFace. */
 export type GeneratorTTS = Generator &
   GeneratorTTSDef & {
     templateKey: 'GENERATOR_TTS'
-    switches: Array<
+    switches?: Array<
       SwitchDef &
         GeneratorTTSDef & {
           conds?: Array<{

package/types/generators/TextToSpeechOpenAiLike.ts

@@ -1,4 +1,7 @@
-/* Auto generated by build script */
+/* Auto generated by build script
+ *
+ * Generate speech from text using OpenAI's Text-to-Speech API
+ */
 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'
 
 /* Generate audio */
 export type GeneratorOpenAiTTSActionGenerate = ActionWithParams & {
@@ -54,7 +58,7 @@ Default property:
     apiKey?: string | DataLink
     /* OpenAI TTS model */
     model?: string | DataLink
-    /* Voice to use  
+    /* Voice to use
  Select voice from https://openai.fm , default alloy */
     voice?: string | DataLink
     /* Additional instructions for the speech generation */
@@ -78,17 +82,19 @@ Default property:
   }
   events?: {
     /* Event triggered when state change */
-    onContextStateChange?: Array<EventAction>
+    onContextStateChange?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['OpenaiTts']['onContextStateChange']>
+    >
     /* Event triggered when error occurs */
-    onError?: Array<EventAction>
+    onError?: Array<EventAction<string & keyof TemplateEventPropsMap['OpenaiTts']['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>
   }
 }
 
@@ -96,7 +102,7 @@ Default property:
 export type GeneratorOpenAiTTS = Generator &
   GeneratorOpenAiTTSDef & {
     templateKey: 'GENERATOR_OPENAI_TTS'
-    switches: Array<
+    switches?: Array<
       SwitchDef &
         GeneratorOpenAiTTSDef & {
           conds?: Array<{

package/types/generators/ThermalPrinter.ts

@@ -1,4 +1,7 @@
-/* Auto generated by build script */
+/* Auto generated by build script
+ *
+ * ESC/POS thermal receipt printer control via Bluetooth or USB
+ */
 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'
 
 /* Init thermal printer connection */
 export type GeneratorThermalPrinterActionInit = Action & {
@@ -85,7 +89,7 @@ Default property:
     pageHeight?: number | DataLink
     /* Cut mode at the end of printing */
     cutMode?: 'NONE' | 'FULL' | 'PARTIAL' | DataLink
-    /* Print payload  
+    /* Print payload
  example:  
  { type: 'text', content: 'Hello, World!' }  
  { type: 'feed', feedLines: 1 }  
@@ -150,25 +154,25 @@ Default property:
   }
   events?: {
     /* Event of connection error */
-    onError?: Array<EventAction>
+    onError?: Array<EventAction<string & keyof TemplateEventPropsMap['ThermalPrinter']['onError']>>
   }
   outlets?: {
     /* Is thermal printer initialized */
-    initialized?: () => Data
+    initialized?: () => Data<boolean>
     /* Thermal printer status */
-    status?: () => Data
+    status?: () => Data<{ [key: string]: any }>
     /* Discovered devices */
-    discoveredDevices?: () => Data
+    discoveredDevices?: () => Data<Array<{ [key: string]: any }>>
     /* Last error message */
-    lastError?: () => Data
+    lastError?: () => Data<string>
   }
 }
 
-/* Thermal Printer */
+/* ESC/POS thermal receipt printer control via Bluetooth or USB */
 export type GeneratorThermalPrinter = Generator &
   GeneratorThermalPrinterDef & {
     templateKey: 'GENERATOR_THERMAL_PRINTER'
-    switches: Array<
+    switches?: Array<
       SwitchDef &
         GeneratorThermalPrinterDef & {
           conds?: Array<{

package/types/generators/Tick.ts

@@ -1,4 +1,7 @@
-/* Auto generated by build script */
+/* Auto generated by build script
+ *
+ * Periodic timer that triggers events at a configurable interval
+ */
 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 the tick */
 export type GeneratorTickAction_ = Action & {
@@ -44,23 +48,23 @@ Default property:
   }
   events?: {
     /* Event for each tick start */
-    ticking?: Array<EventAction>
+    ticking?: Array<EventAction<string & keyof TemplateEventPropsMap['Tick']['ticking']>>
     /* Event for tick completed */
-    completed?: Array<EventAction>
+    completed?: Array<EventAction<string & keyof TemplateEventPropsMap['Tick']['completed']>>
   }
   outlets?: {
     /* Countdown step value */
-    countdown?: () => Data
+    countdown?: () => Data<string | number>
     /* Is tick running? */
-    running?: () => Data
+    running?: () => Data<boolean | string | number>
   }
 }
 
-/* Execute event in countdown manner */
+/* Periodic timer that triggers events at a configurable interval */
 export type GeneratorTick = Generator &
   GeneratorTickDef & {
     templateKey: 'GENERATOR_TICK'
-    switches: Array<
+    switches?: Array<
       SwitchDef &
         GeneratorTickDef & {
           conds?: Array<{

package/types/generators/Udp.ts

@@ -1,4 +1,7 @@
-/* Auto generated by build script */
+/* Auto generated by build script
+ *
+ * UDP socket communication
+ */
 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'
 
 /* Bind UDP port */
 export type GeneratorUDPActionBind = Action & {
@@ -72,27 +76,32 @@ Default property:
     /* Event of UDP port is binded */
     onReady?: Array<EventAction>
     /* Event of receive data */
-    onData?: Array<EventAction>
+    onData?: Array<EventAction<string & keyof TemplateEventPropsMap['Udp']['onData']>>
     /* Event of socket closeed */
     onClose?: Array<EventAction>
     /* Event of socket error */
-    onError?: Array<EventAction>
+    onError?: Array<EventAction<string & keyof TemplateEventPropsMap['Udp']['onError']>>
   }
   outlets?: {
     /* Local UDP binded port */
-    port?: () => Data
+    port?: () => Data<number>
     /* Last received packet */
-    lastReceive?: () => Data
+    lastReceive?: () => Data<{
+      address?: string
+      port?: number
+      data?: any
+      [key: string]: any
+    }>
     /* Error message */
-    errorMessage?: () => Data
+    errorMessage?: () => Data<string>
   }
 }
 
-/* TCP Server */
+/* UDP socket communication */
 export type GeneratorUDP = Generator &
   GeneratorUDPDef & {
     templateKey: 'GENERATOR_UDP'
-    switches: Array<
+    switches?: Array<
       SwitchDef &
         GeneratorUDPDef & {
           conds?: Array<{

package/types/generators/VadGgml.ts

@@ -1,4 +1,7 @@
-/* Auto generated by build script */
+/* Auto generated by build script
+ *
+ * Local Voice Activity Detection (VAD) inference based on GGML and [whisper.rn](https://github.com/mybigday/whisper.rn)
+ */
 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'
 
 /* Load the model */
 export type GeneratorVadInferenceActionLoadModel = Action & {
@@ -127,14 +131,14 @@ Default property:
 }
   */
   property?: {
-    /* Initialize the VAD context on generator initialization  
+    /* Initialize the VAD context on generator initialization
  Please note that it will take some RAM depending on the model size */
     init?: boolean | DataLink
-    /* Use model name, currently only supports the Silero VAD model.  
+    /* Use model name, currently only supports the Silero VAD model.
  The model download progress will be done in preload stage or  the generator initialization stage.  
  You can also choose `custom` option and set `Model URL` and `Model SHA1` to use your own model */
     modelName?: 'custom' | 'silero-v6.2.0' | 'silero-v5.1.2' | DataLink
-    /* The URL or path of model  
+    /* The URL or path of model
  We used `ggml` format model, please refer to https://huggingface.co/ggml-org/whisper-vad */
     modelUrl?: string | DataLink
     /* Hash type of model */
@@ -157,7 +161,7 @@ Default property:
     detectSpeechPadMs?: number | DataLink
     /* Overlap between analysis windows (0.0-1.0) */
     detectSamplesOverlap?: number | DataLink
-    /* The file URL or path to be analyzed.  
+    /* The file URL or path to be analyzed.
  It only supported `wav` format with 16kHz sample rate & single (mono) channel */
     detectFileUrl?: string | DataLink
     /* MD5 of file to be analyzed */
@@ -165,23 +169,56 @@ Default property:
   }
   events?: {
     /* Event triggered when context state changes */
-    onContextStateChange?: Array<EventAction>
+    onContextStateChange?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['VadInference']['onContextStateChange']>
+    >
     /* Event triggered when error occurs */
-    onError?: Array<EventAction>
+    onError?: Array<EventAction<string & keyof TemplateEventPropsMap['VadInference']['onError']>>
     /* Event triggered when got detection result */
-    onDetected?: Array<EventAction>
+    onDetected?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['VadInference']['onDetected']>
+    >
   }
   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 detecting */
-    isDetecting?: () => Data
+    isDetecting?: () => Data<boolean>
     /* Detection segments result */
-    detectionSegments?: () => Data
+    detectionSegments?: () => Data<
+      Array<{
+        start?: number
+        end?: number
+        confidence?: number
+        t0?: number
+        t1?: number
+        [key: string]: any
+      }>
+    >
     /* Detection details */
-    detectionDetails?: () => Data
+    detectionDetails?: () => 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
+    }>
   }
 }
 
@@ -189,7 +226,7 @@ Default property:
 export type GeneratorVadInference = Generator &
   GeneratorVadInferenceDef & {
     templateKey: 'GENERATOR_VAD_INFERENCE'
-    switches: Array<
+    switches?: Array<
       SwitchDef &
         GeneratorVadInferenceDef & {
           conds?: Array<{

package/types/generators/VadOnnx.ts

@@ -1,4 +1,8 @@
-/* Auto generated by build script */
+/* Auto generated by build script
+ *
+ * Local Voice Activity Detection (VAD) inference based on [transformers.js](https://huggingface.co/docs/transformers.js)
+ *  You can use any compatible VAD model from HuggingFace (Silero VAD, smart-turn, etc.)
+ */
 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 GeneratorVadInferenceOnnxActionLoadModel = Action & {
@@ -142,12 +147,12 @@ Default property:
     detectMaxSpeechDurationS?: number | DataLink
     /* Padding around speech segments in milliseconds */
     detectSpeechPadMs?: 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 */
@@ -159,30 +164,55 @@ Default property:
   }
   events?: {
     /* Event triggered when context state changes */
-    onContextStateChange?: Array<EventAction>
+    onContextStateChange?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['OnnxVad']['onContextStateChange']>
+    >
     /* Event triggered when error occurs */
-    onError?: Array<EventAction>
+    onError?: Array<EventAction<string & keyof TemplateEventPropsMap['OnnxVad']['onError']>>
     /* Event triggered when got detection result */
-    onDetected?: Array<EventAction>
+    onDetected?: Array<EventAction<string & keyof TemplateEventPropsMap['OnnxVad']['onDetected']>>
   }
   outlets?: {
     /* Context state */
-    contextState?: () => Data
+    contextState?: () => Data<string>
     /* Is detecting */
-    isDetecting?: () => Data
+    isDetecting?: () => Data<boolean>
     /* Detection segments result */
-    detectionSegments?: () => Data
+    detectionSegments?: () => Data<
+      Array<{
+        start?: number
+        end?: number
+        confidence?: number
+        t0?: number
+        t1?: number
+        [key: string]: any
+      }>
+    >
     /* Detection details */
-    detectionDetails?: () => Data
+    detectionDetails?: () => 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
+    }>
   }
 }
 
-/* Local Voice Activity Detection (VAD) inference based on [transformers.js](https://huggingface.co/docs/transformers.js)  
+/* Local Voice Activity Detection (VAD) inference based on [transformers.js](https://huggingface.co/docs/transformers.js)
  You can use any compatible VAD model from HuggingFace (Silero VAD, smart-turn, etc.) */
 export type GeneratorVadInferenceOnnx = Generator &
   GeneratorVadInferenceOnnxDef & {
     templateKey: 'GENERATOR_ONNX_VAD'
-    switches: Array<
+    switches?: Array<
       SwitchDef &
         GeneratorVadInferenceOnnxDef & {
           conds?: Array<{