@fugood/bricks-project 2.24.0-beta.9 → 2.24.0

package/types/generators/MediaFlow.ts

@@ -1,4 +1,7 @@
-/* Auto generated by build script */
+/* Auto generated by build script
+ *
+ * Fetch box's file list from Media Flow
+ */
 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 fetcn Media box file list */
 export type GeneratorMediaFlowActionFetch = Action & {
@@ -54,7 +58,7 @@ Default property:
     passcode?: string | DataLink
     /* Include File Types */
     includeTypes?: Array<'IMAGE' | 'VIDEO' | 'AUDIO' | 'FILE' | DataLink> | DataLink
-    /* Determine the cache behavior  
+    /* Determine the cache behavior
   
  cache-first: Cache first if existing, then fetch from network  
  network-and-cache: Fetch from network, then save cache  
@@ -87,13 +91,17 @@ Default property:
   }
   events?: {
     /* Event of media box fetch error */
-    fetchError?: Array<EventAction>
+    fetchError?: Array<EventAction<string & keyof TemplateEventPropsMap['MediaFlow']['fetchError']>>
     /* Event of subscribe box change connected (If set `Subscribe Box Change`) */
     subscribeBoxConnect?: Array<EventAction>
     /* Event of subscribe box change error (If set `Subscribe Box Change`) */
-    subscribeBoxError?: Array<EventAction>
+    subscribeBoxError?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['MediaFlow']['subscribeBoxError']>
+    >
     /* Event of subscribe box change connection error (If set `Subscribe Box Change`) */
-    subscribeBoxConnectError?: Array<EventAction>
+    subscribeBoxConnectError?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['MediaFlow']['subscribeBoxConnectError']>
+    >
     /* Event of file sync completed for used `saveToStorage` */
     saveStorageCompleted?: Array<EventAction>
     /* Event when file list size exceed of Load size limit */
@@ -101,17 +109,35 @@ Default property:
   }
   outlets?: {
     /* File sync status */
-    downloadStatus?: () => Data
+    downloadStatus?: () => Data<string>
     /* File sync progress */
-    downloadProgress?: () => Data
+    downloadProgress?: () => Data<
+      Array<{
+        key?: string
+        progress?: number
+        finished?: boolean
+        [key: string]: any
+      }>
+    >
     /* File sync download errors */
-    downloadErrors?: () => Data
+    downloadErrors?: () => Data<Array<string>>
     /* Media box info */
-    box?: () => Data
+    box?: () => Data<{ [key: string]: any }>
     /* Save Media Flow fetch result   [     {       "url": "https://d1kk0369g9vrck.cloudfront.net/box/5b431e29efd40c01e8b2019c/photo5b431e37efd40c01e8b201d1"       "extension": "", // enum("jpg", "png", "mp4")       "id": "5b431e37efd40c01e8b201d1",       "md5": "6134ab412351651324" // md5 came from media resource api     }   ] */
-    result?: () => Data
+    result?: () => Data<
+      Array<{
+        id?: string
+        key?: string
+        mediaType?: string
+        extension?: string
+        original?: string
+        url?: string
+        metadata?: { [key: string]: any }
+        [key: string]: any
+      }>
+    >
     /* File sync result    [      {        "url": "/storage/emulated/0/Download/SyncFolder/Asset/1.png",        "mediaType": "photo" // enum("photo", "video"), used to distingiush        "id": "",      }    ] */
-    downloadFileUrls?: () => Data
+    downloadFileUrls?: () => Data<Array<string>>
   }
 }
 

package/types/generators/MqttBroker.ts

@@ -1,4 +1,7 @@
-/* Auto generated by build script */
+/* Auto generated by build script
+ *
+ * Embedded MQTT broker server with client authentication, publish/subscribe messaging, keepalive, and retry 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 MQTT broker server */
 export type GeneratorMQTTBrokerActionStart = Action & {
@@ -80,27 +84,41 @@ Default property:
     /* Event of MQTT server is ready */
     onReady?: Array<EventAction>
     /* Event of server or connection error */
-    onError?: Array<EventAction>
+    onError?: Array<EventAction<string & keyof TemplateEventPropsMap['MqttBroker']['onError']>>
     /* Event of client connected */
-    onClientConnected?: Array<EventAction>
+    onClientConnected?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['MqttBroker']['onClientConnected']>
+    >
     /* Event of client disconnected */
-    onClientDisconnected?: Array<EventAction>
+    onClientDisconnected?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['MqttBroker']['onClientDisconnected']>
+    >
     /* Event of message received */
-    onMessageReceived?: Array<EventAction>
+    onMessageReceived?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['MqttBroker']['onMessageReceived']>
+    >
     /* Event of message published */
-    onMessagePublished?: Array<EventAction>
+    onMessagePublished?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['MqttBroker']['onMessagePublished']>
+    >
   }
   outlets?: {
     /* Is server started */
-    started?: () => Data
+    started?: () => Data<boolean>
     /* Last received message */
-    lastMessage?: () => Data
+    lastMessage?: () => Data<{
+      topic?: string
+      payload?: any
+      qos?: number
+      retain?: boolean
+      [key: string]: any
+    }>
     /* Error message */
-    errorMessage?: () => Data
+    errorMessage?: () => Data<string>
   }
 }
 
-/* MQTT Broker server */
+/* Embedded MQTT broker server with client authentication, publish/subscribe messaging, keepalive, and retry support */
 export type GeneratorMQTTBroker = Generator &
   GeneratorMQTTBrokerDef & {
     templateKey: 'GENERATOR_MQTT_BROKER'

package/types/generators/MqttClient.ts

@@ -1,4 +1,7 @@
-/* Auto generated by build script */
+/* Auto generated by build script
+ *
+ * MQTT client with topic subscribe/publish, QoS levels (0/1/2), auto-reconnect, and auth support. Connects via mqtt:// or wss://
+ */
 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'
 
 /* Connect to MQTT broker */
 export type GeneratorMQTTActionConnect = Action & {
@@ -92,23 +96,29 @@ Default property:
     /* When disconnected from MQTT broker */
     onDisconnected?: Array<EventAction>
     /* When error occurred */
-    onError?: Array<EventAction>
+    onError?: Array<EventAction<string & keyof TemplateEventPropsMap['Mqtt']['onError']>>
     /* When received message from MQTT broker within subscribe topic */
-    onMessage?: Array<EventAction>
+    onMessage?: Array<EventAction<string & keyof TemplateEventPropsMap['Mqtt']['onMessage']>>
   }
   outlets?: {
     /* Connected or not */
-    connected?: () => Data
+    connected?: () => Data<boolean>
     /* Error Message */
-    error?: () => Data
+    error?: () => Data<string>
     /* The receive message */
-    message?: () => Data
+    message?: () => Data<{
+      topic?: string
+      payload?: any
+      qos?: number
+      retain?: boolean
+      [key: string]: any
+    }>
     /* The receive message (payload only) */
-    messagePayload?: () => Data
+    messagePayload?: () => Data<any>
   }
 }
 
-/* MQTT protocol messaging */
+/* MQTT client with topic subscribe/publish, QoS levels (0/1/2), auto-reconnect, and auth support. Connects via mqtt:// or wss:// */
 export type GeneratorMQTT = Generator &
   GeneratorMQTTDef & {
     templateKey: 'GENERATOR_MQTT'

package/types/generators/Question.ts

@@ -1,4 +1,7 @@
-/* Auto generated by build script */
+/* Auto generated by build script
+ *
+ * Prompt user for input via dialog and return the response
+ */
 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 inquire */
 export type GeneratorQuestionActionStart = Action & {
@@ -60,7 +64,7 @@ Default property:
   property?: {
     /* Modal mode */
     modalMode?: 'root' | 'in-subspace' | DataLink
-    /* Inquirer schema  
+    /* Inquirer schema
  `key`: Field key (unique, required)  
  `kind`: Field type (required)  
  `title`: Field or message title  
@@ -367,21 +371,21 @@ Default property:
     /* Event of completed inquire */
     onCompleted?: Array<EventAction>
     /* Event of error occured */
-    onError?: Array<EventAction>
+    onError?: Array<EventAction<string & keyof TemplateEventPropsMap['Question']['onError']>>
   }
   outlets?: {
     /* Result data */
-    data?: () => Data
+    data?: () => Data<{ [key: string]: any }>
     /* Currnet question */
-    currectKey?: () => Data
+    currectKey?: () => Data<string>
     /* Currnet input value */
-    currectValue?: () => Data
+    currectValue?: () => Data<any>
     /* Error message */
-    errorMessage?: () => Data
+    errorMessage?: () => Data<string>
   }
 }
 
-/* Question inquirer */
+/* Prompt user for input via dialog and return the response */
 export type GeneratorQuestion = Generator &
   GeneratorQuestionDef & {
     templateKey: 'GENERATOR_QUESTION'

package/types/generators/RealtimeTranscription.ts

@@ -1,4 +1,7 @@
-/* Auto generated by build script */
+/* Auto generated by build script
+ *
+ * Realtime speech-to-text transcription using Whisper and VAD with live audio streaming
+ */
 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 realtime transcription */
 export type GeneratorRealtimeTranscriptionActionStart = Action & {
@@ -31,6 +35,11 @@ export type GeneratorRealtimeTranscriptionActionReset = Action & {
   __actionName: 'GENERATOR_REALTIME_TRANSCRIPTION_RESET'
 }
 
+/* List available microphone devices (Web / Desktop only) */
+export type GeneratorRealtimeTranscriptionActionListDevices = Action & {
+  __actionName: 'GENERATOR_REALTIME_TRANSCRIPTION_LIST_DEVICES'
+}
+
 interface GeneratorRealtimeTranscriptionDef {
   /*
 Default property:
@@ -57,6 +66,10 @@ Default property:
 }
   */
   property?: {
+    /* Specifies the device ID to use for audio input.
+  Web / Desktop: device ID string from enumerateDevices  
+  Android: audio source name - DEFAULT, MIC, VOICE_UPLINK, VOICE_DOWNLINK, VOICE_CALL, CAMCORDER, VOICE_RECOGNITION, VOICE_COMMUNICATION, UNPROCESSED */
+    deviceId?: string | DataLink
     /* STT Generator for Whisper context */
     sttGeneratorId?: string | DataLink | (() => Generator)
     /* STT Live Policy. If the policy is `only-in-use`, the STT context will be released when not in use. */
@@ -119,41 +132,116 @@ Default property:
   }
   events?: {
     /* Event triggered when transcription starts, processes, or ends */
-    onTranscribe?: Array<EventAction>
+    onTranscribe?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['RealtimeTranscription']['onTranscribe']>
+    >
     /* Event triggered on VAD (Voice Activity Detection) events */
-    onVad?: Array<EventAction>
+    onVad?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['RealtimeTranscription']['onVad']>
+    >
     /* Event triggered when error occurs */
-    onError?: Array<EventAction>
+    onError?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['RealtimeTranscription']['onError']>
+    >
     /* Event triggered when status changes */
-    onStatusChange?: Array<EventAction>
+    onStatusChange?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['RealtimeTranscription']['onStatusChange']>
+    >
     /* Event triggered when statistics update */
-    onStatsUpdate?: Array<EventAction>
+    onStatsUpdate?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['RealtimeTranscription']['onStatsUpdate']>
+    >
     /* Event triggered when slice transcription is stabilized */
-    onStabilized?: Array<EventAction>
+    onStabilized?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['RealtimeTranscription']['onStabilized']>
+    >
     /* Event triggered when transcription ends */
-    onEnd?: Array<EventAction>
+    onEnd?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['RealtimeTranscription']['onEnd']>
+    >
   }
   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>
+    /* Available microphone devices (Web / Desktop only) */
+    devices?: () => Data<Array<any>>
   }
 }
 
@@ -182,6 +270,7 @@ export type GeneratorRealtimeTranscription = Generator &
                     | 'lastVadEvent'
                     | 'stabilizedText'
                     | 'audioOutputPath'
+                    | 'devices'
                   value: any
                 }
           }>

package/types/generators/RerankerGgml.ts

@@ -1,4 +1,18 @@
-/* Auto generated by build script */
+/* Auto generated by build script
+ *
+ * Local rerank based on GGML and [llama.cpp](https://github.com/ggerganov/llama.cpp)
+ *
+ *  ## 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 +24,7 @@ import type {
   Action,
   EventProperty,
 } from '../common'
+import type { TemplateEventPropsMap } from '../../utils/event-props'
 
 /* Load the model */
 export type GeneratorRerankerActionLoadModel = Action & {
@@ -69,13 +84,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  
@@ -103,25 +118,41 @@ Default property:
   }
   events?: {
     /* Event triggered when the reranker context state changes (loading, ready, error, released) */
-    onContextStateChange?: Array<EventAction>
+    onContextStateChange?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['Reranker']['onContextStateChange']>
+    >
     /* Event triggered when an error occurs during reranker operations */
-    onError?: Array<EventAction>
+    onError?: Array<EventAction<string & keyof TemplateEventPropsMap['Reranker']['onError']>>
   }
   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  

package/types/generators/SerialPort.ts

@@ -1,4 +1,7 @@
-/* Auto generated by build script */
+/* Auto generated by build script
+ *
+ * Serial port communication for USB/UART devices (Android, Desktop only)
+ */
 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'
 
 /* Get available serial devices */
 export type GeneratorSerialPortActionGeneratorSerialGetDeviceList = Action & {
@@ -97,25 +101,29 @@ Default property:
     /* Event for detach the device */
     generatorSerialOnDetach?: Array<EventAction>
     /* Event on error */
-    generatorSerialOnError?: Array<EventAction>
+    generatorSerialOnError?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['SerialPort']['generatorSerialOnError']>
+    >
     /* Event for receive data */
-    generatorSerialOnData?: Array<EventAction>
+    generatorSerialOnData?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['SerialPort']['generatorSerialOnData']>
+    >
   }
   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>
   }
 }
 
-/* Serial Port Generator (Unsupported iOS) */
+/* Serial port communication for USB/UART devices (Android, Desktop only) */
 export type GeneratorSerialPort = Generator &
   GeneratorSerialPortDef & {
     templateKey: 'GENERATOR_SERIAL_PORT'

package/types/generators/SoundPlayer.ts

@@ -1,4 +1,7 @@
-/* Auto generated by build script */
+/* Auto generated by build script
+ *
+ * Play sound, see supported formats at https://developer.android.com/guide/topics/media/media-formats
+ */
 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 playing sound */
 export type GeneratorSoundPlayerActionPlay = Action & {
@@ -53,7 +57,9 @@ Default property:
     /* Sound file loaded successfully */
     onLoad?: Array<EventAction>
     /* Sound file load error */
-    onLoadError?: Array<EventAction>
+    onLoadError?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['SoundPlayer']['onLoadError']>
+    >
     /* Sound playback complete */
     onPlay?: Array<EventAction>
     /* Sound file playback end */
@@ -61,7 +67,7 @@ Default property:
   }
   outlets?: {
     /* Whether the sound is playing */
-    isPlaying?: () => Data
+    isPlaying?: () => Data<any>
   }
 }