@fugood/bricks-project 2.22.0-beta.9 → 2.22.1

package/types/generators/Watchdog.ts

@@ -0,0 +1,96 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+/* Reset watch */
+export type GeneratorWatchdogActionResetWatch = Action & {
+  __actionName: 'GENERATOR_WATCHDOG_RESET_WATCH'
+}
+
+interface GeneratorWatchdogDef {
+  /*
+Default property:
+{
+  "listening": false,
+  "timeout": 30000
+}
+  */
+  property?: {
+    /* Start listening event */
+    listening?: boolean | DataLink
+    /* If no other events are fired after the specified event is fired, it times out and fires the Watchdog event. */
+    timeout?: number | DataLink
+    /* Reset timeout timer on properties change */
+    resetTimeoutOnChange?: boolean | DataLink
+    /* Set what brick id (allow mutiple) to listen for press */
+    brickOnPress?: Array<string | DataLink> | DataLink
+    /* Set what brick id (allow mutiple) to listen for focus */
+    brickOnFocus?: Array<string | DataLink> | DataLink
+    /* Set what brick id (allow mutiple) to listen for blur */
+    brickOnBlur?: Array<string | DataLink> | DataLink
+    /* Set what canvas id (allow mutiple) to listen for enter */
+    canvasOnEnter?: Array<string | DataLink> | DataLink
+    /* Set what canvas id (allow mutiple) to listen for exit */
+    canvasOnExit?: Array<string | DataLink> | DataLink
+    /* Set what Data id (allow mutiple) to listen for change */
+    propertyBankOnChange?: Array<string | DataLink> | DataLink
+    /* Set what Data id (allow mutiple) to listen for update */
+    propertyBankOnUpdate?: Array<string | DataLink> | DataLink
+    /* Set what Data id (allow mutiple) to listen for hit */
+    propertyBankOnHit?: Array<string | DataLink> | DataLink
+    /* Set what Data id (allow mutiple) to listen for hit */
+    propertyBankOnNotHit?: Array<string | DataLink> | DataLink
+  }
+  events?: {
+    /* Event on specific sender id trigger event */
+    onEvent?: Array<EventAction>
+    /* Event on timeout */
+    onTimeout?: Array<EventAction>
+  }
+  outlets?: {
+    /* The last event */
+    lastEvent?: () => Data
+    /* The type fo last event */
+    lastEventType?: () => Data
+    /* The trigger type of last event */
+    lastEventTriggerType?: () => Data
+    /* The sender id of last event */
+    lastEventSenderId?: () => Data
+    /* Is timed out */
+    isTimedOut?: () => Data
+  }
+}
+
+/* Triger event with timeout by listen specified events */
+export type GeneratorWatchdog = Generator &
+  GeneratorWatchdogDef & {
+    templateKey: 'GENERATOR_WATCHDOG'
+    switches: Array<
+      SwitchDef &
+        GeneratorWatchdogDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet:
+                    | 'lastEvent'
+                    | 'lastEventType'
+                    | 'lastEventTriggerType'
+                    | 'lastEventSenderId'
+                    | 'isTimedOut'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/generators/WebCrawler.ts

@@ -0,0 +1,97 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+/* Run Crawler request with defined properties */
+export type GeneratorWebCrawlerActionRunRequest = Action & {
+  __actionName: 'GENERATOR_WEB_CRAWLER_RUN_REQUEST'
+}
+
+interface GeneratorWebCrawlerDef {
+  /*
+Default property:
+{
+  "init": false,
+  "httpMethod": "GET",
+  "timeout": 10000,
+  "attributePath": "textContent"
+}
+  */
+  property?: {
+    /* Start Crawler request on generator initialized */
+    init?: boolean | DataLink
+    /* URL of crawler request */
+    url?: string | DataLink
+    /* Timeout of crawler request  
+
+ Platform not supported for `webview`: tvOS, Desktop, Web */
+    method?: 'webview' | 'http' | DataLink
+    /* HTTP method of crawler request (weview only supported GET, POST) */
+    httpMethod?: 'GET' | 'POST' | 'PUT' | 'DELETE' | DataLink
+    /* Body of crawler request */
+    body?: string | DataLink
+    /* User-Agent of crawler request */
+    userAgent?: string | DataLink
+    /* Headers of crawler request */
+    headers?: {} | DataLink
+    /* Timeout of crawler request */
+    timeout?: number | DataLink
+    /* CSS Query Selector of selected element */
+    selector?: string | DataLink
+    /* Attribute path of HTMLElement */
+    attributePath?: string | DataLink
+    /* Multiple selectors and attribute paths. */
+    selectorList?:
+      | Array<
+          | DataLink
+          | {
+              selector?: string | DataLink
+              attributePath?: string | DataLink
+            }
+        >
+      | DataLink
+  }
+  events?: {
+    /* Event of crawling start */
+    onStart?: Array<EventAction>
+    /* Event of crawling end */
+    onEnd?: Array<EventAction>
+  }
+  outlets?: {
+    /* Response for CRAWLER request (selector) */
+    response?: () => Data
+    /* Responses for CRAWLER request (selectorList) */
+    responseList?: () => Data
+    /* The error response of CRAWLER request,  it will save to property bank */
+    error?: () => Data
+  }
+}
+
+/* Web crawler to get specific value */
+export type GeneratorWebCrawler = Generator &
+  GeneratorWebCrawlerDef & {
+    templateKey: 'GENERATOR_WEB_CRAWLER'
+    switches: Array<
+      SwitchDef &
+        GeneratorWebCrawlerDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'response' | 'responseList' | 'error'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/generators/WebRtc.ts

@@ -0,0 +1,165 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+/* Initiate WebRTC request */
+export type GeneratorWebRTCActionInitiate = Action & {
+  __actionName: 'GENERATOR_WEBRTC_INITIATE'
+}
+
+/* Process input signal */
+export type GeneratorWebRTCActionProcessInputSignal = ActionWithParams & {
+  __actionName: 'GENERATOR_WEBRTC_PROCESS_INPUT_SIGNAL'
+  params?: Array<{
+    input: 'inputSignal'
+    value?: any | EventProperty
+    mapping?: string
+  }>
+}
+
+/* Close WebRTC */
+export type GeneratorWebRTCActionClose = Action & {
+  __actionName: 'GENERATOR_WEBRTC_CLOSE'
+}
+
+/* Send message in data channel */
+export type GeneratorWebRTCActionChannelSend = ActionWithParams & {
+  __actionName: 'GENERATOR_WEBRTC_CHANNEL_SEND'
+  params?: Array<{
+    input: 'textMessage'
+    value?: string | DataLink | EventProperty
+    mapping?: string
+  }>
+}
+
+interface GeneratorWebRTCDef {
+  /*
+Default property:
+{
+  "enableAudio": true,
+  "enableVideo": true,
+  "videoFacing": "user",
+  "videoFrameRate": 30,
+  "videoHeight": 720,
+  "videoWidth": 1080,
+  "signalType": "json"
+}
+  */
+  property?: {
+    /* Caller ID */
+    callerId?: string | DataLink
+    /* Calee ID, to ilter caller signal */
+    calleeId?: string | DataLink
+    /* Target local WebRTC stream preview brick ID */
+    localVideoTarget?: string | DataLink
+    /* Target remote WebRTC stream brick ID */
+    remoteVideoTarget?: string | DataLink
+    /* ICE Server list  
+  Default use Google public STUN servers if not setted. */
+    iceServers?:
+      | Array<
+          | DataLink
+          | {
+              urls?: string | DataLink
+              username?: string | DataLink
+              credential?: string | DataLink
+            }
+        >
+      | DataLink
+    /* Enable capture device microphone */
+    enableAudio?: boolean | DataLink
+    /* Enable capture device camera */
+    enableVideo?: boolean | DataLink
+    /* Camera facing */
+    videoFacing?: 'user' | 'environment' | DataLink
+    /* Camera frame rate */
+    videoFrameRate?: number | DataLink
+    /* Output video height */
+    videoHeight?: number | DataLink
+    /* Output video width */
+    videoWidth?: number | DataLink
+    /* Label of data channel */
+    dataChannelLabel?: string | DataLink
+    /* Input signal for create peer connection  
+  Signal Types:  
+  `initiate`: Initiate a WebRTC call  
+  `offer`: WebRTC SDP offer  
+  `answer`: WebRTC SDP answer  
+  `candidate`: WebRTC ICE candidate  
+  `close`: Close WebRTC peer connection */
+    inputSignal?: any
+    /* Signal content type */
+    signalType?: 'json' | 'object' | DataLink
+  }
+  events?: {
+    /* Event of signal update */
+    onSignalUpdate?: Array<EventAction>
+    /* Event of peer connected */
+    onConnected?: Array<EventAction>
+    /* Event of peer disconnected */
+    onDisconnected?: Array<EventAction>
+    /* Event of handshake error */
+    onError?: Array<EventAction>
+    /* Event of data channel open */
+    onChannelOpen?: Array<EventAction>
+    /* Event of data channel close */
+    onChannelClose?: Array<EventAction>
+    /* Event of received message on data channel */
+    onChannelMessage?: Array<EventAction>
+  }
+  outlets?: {
+    /* Signal to create peer connection */
+    signal?: () => Data
+    /* Local SDP offer */
+    sdpOffer?: () => Data
+    /* Local SDP answer */
+    sdpAnswer?: () => Data
+    /* Peer connection state */
+    connectionState?: () => Data
+    /* ICE connection state */
+    iceConnectionState?: () => Data
+    /* Signaling state */
+    signalingState?: () => Data
+    /* Last message from data channel */
+    lastChannelMessage?: () => Data
+    /* Error message */
+    errorMessage?: () => Data
+  }
+}
+
+/* WebRTC */
+export type GeneratorWebRTC = Generator &
+  GeneratorWebRTCDef & {
+    templateKey: 'GENERATOR_WEBRTC'
+    switches: Array<
+      SwitchDef &
+        GeneratorWebRTCDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet:
+                    | 'signal'
+                    | 'sdpOffer'
+                    | 'sdpAnswer'
+                    | 'connectionState'
+                    | 'iceConnectionState'
+                    | 'signalingState'
+                    | 'lastChannelMessage'
+                    | 'errorMessage'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/generators/WebSocket.ts

@@ -0,0 +1,142 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+/* Connect */
+export type GeneratorWebSocketActionConnect = Action & {
+  __actionName: 'GENERATOR_WEB_SOCKET_CONNECT'
+}
+
+/* Disconnect */
+export type GeneratorWebSocketActionDisconnect = Action & {
+  __actionName: 'GENERATOR_WEB_SOCKET_DISCONNECT'
+}
+
+/* Emit event (Acknowledgement: It's callback, the channel of Socket.IO server can used it as last argument) */
+export type GeneratorWebSocketActionEmit = ActionWithParams & {
+  __actionName: 'GENERATOR_WEB_SOCKET_EMIT'
+  params?: Array<
+    | {
+        input: 'eventName'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'arguments'
+        value?: Array<any> | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'acknowledgementType'
+        value?: 'text' | 'json' | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'withAcknowledgement'
+        value?: boolean | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Emit `message` */
+export type GeneratorWebSocketActionSend = ActionWithParams & {
+  __actionName: 'GENERATOR_WEB_SOCKET_SEND'
+  params?: Array<{
+    input: 'value'
+    value?: string | DataLink | EventProperty
+    mapping?: string
+  }>
+}
+
+interface GeneratorWebSocketDef {
+  /*
+Default property:
+{}
+  */
+  property?: {
+    /* Try to connect on generator initialized */
+    init?: boolean | DataLink
+    /* Endpoint URL (support namespace) */
+    url?: string | DataLink
+    /* Name of the path that is captured on the server side */
+    path?: string | DataLink
+    /* URL query parameters */
+    query?: {} | DataLink
+    /* Whether to reconnect automatically */
+    reconnection?: boolean | DataLink
+    /* Number of reconnection attempts before giving up */
+    attemptTimes?: number | DataLink
+    /* How long to initially wait before attempting a new reconnection (1000). Affected by +/- randomizationFactor, for example the default initial delay will be between 500 to 1500ms. */
+    delayBase?: number | DataLink
+    /* Maximum amount of time to wait between reconnections (5000). Each attempt increases the reconnection delay by 2x along with a randomization as above */
+    delayMax?: number | DataLink
+    /* Randomization factor 0 <= deplayRandom <= 1 */
+    delayRandom?: number | DataLink
+    /* Message type, if type is json it's will auto transform to object */
+    messageType?: 'json' | 'text' | DataLink
+    /* Use Socket.IO as transport channel */
+    socketIoEnable?: boolean | DataLink
+    /* Socket.IO Version */
+    socketIoVersion?: 'latest' | 'v4' | 'v2' | DataLink
+    /* Whether to reuse an existing connection */
+    socketIoForceNew?: boolean | DataLink
+    /* Connection timeout before a connect_error and connect_timeout events are emitted */
+    socketIoTimeout?: number | DataLink
+    /* Event name to be subscribe */
+    socketIoEventName?: string | DataLink
+    /* Additional query parameters that are sent when connecting a namespace (then found in socket.handshake.query object on the server-side) */
+    socketIoQuery?: {} | DataLink
+    /* Protocols to be used in the WebSocket connection */
+    wsProtocols?: Array<string | DataLink> | DataLink | string | DataLink | DataLink
+  }
+  events?: {
+    /* Event for connected to server */
+    onOpen?: Array<EventAction>
+    /* Event for disconnect from server */
+    onClose?: Array<EventAction>
+    /* Event for receive message */
+    onMessage?: Array<EventAction>
+    /* Event for error occurred */
+    onError?: Array<EventAction>
+  }
+  outlets?: {
+    /* Show socket.io connected or not */
+    readyState?: () => Data
+    /* Results of each countdown change,  it will save to Data */
+    message?: () => Data
+    /* When Socket.IO mode server can response acknowledgemnt with data to client */
+    acknowledgeData?: () => Data
+    /* Error message */
+    errorMessage?: () => Data
+  }
+}
+
+/* WebSocket or Socket.IO Generator */
+export type GeneratorWebSocket = Generator &
+  GeneratorWebSocketDef & {
+    templateKey: 'GENERATOR_WEB_SOCKET'
+    switches: Array<
+      SwitchDef &
+        GeneratorWebSocketDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'readyState' | 'message' | 'acknowledgeData' | 'errorMessage'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/generators/index.ts

@@ -0,0 +1,50 @@
+export * from './Tick'
+export * from './AlarmClock'
+export * from './File'
+export * from './MediaFlow'
+export * from './DataBank'
+export * from './GraphQl'
+export * from './Http'
+export * from './SoundPlayer'
+export * from './Keyboard'
+export * from './WebSocket'
+export * from './CanvasMap'
+export * from './Step'
+export * from './Iterator'
+export * from './Watchdog'
+export * from './MqttClient'
+export * from './MqttBroker'
+export * from './BleCentral'
+export * from './SerialPort'
+export * from './Tcp'
+export * from './TcpServer'
+export * from './Udp'
+export * from './HttpServer'
+export * from './WebRtc'
+export * from './WebCrawler'
+export * from './SoundRecorder'
+export * from './BlePeripheral'
+export * from './Question'
+export * from './Information'
+export * from './Intent'
+export * from './CastlesPay'
+export * from './SpeechToTextPlatform'
+export * from './ThermalPrinter'
+export * from './SqLite'
+export * from './McpServer'
+export * from './Mcp'
+export * from './TextToSpeechOnnx'
+export * from './LlmOnnx'
+export * from './SpeechToTextOnnx'
+export * from './SpeechToTextGgml'
+export * from './VadGgml'
+export * from './RealtimeTranscription'
+export * from './LlmGgml'
+export * from './TextToSpeechGgml'
+export * from './RerankerGgml'
+export * from './LlmQualcommAiEngine'
+export * from './LlmOpenAiCompat'
+export * from './TextToSpeechOpenAiLike'
+export * from './LlmAnthropicCompat'
+export * from './Assistant'
+export * from './VectorStore'

package/types/system.ts

@@ -467,6 +467,16 @@ export type SystemActionChannelPublish = ActionWithParams & {
   >
 }
 
+/* Delay for a certain time between actions */
+export type SystemActionDelay = ActionWithParams & {
+  __actionName: 'DELAY'
+  params?: Array<{
+    input: 'time'
+    value?: number | DataLink | EventProperty
+    mapping?: string
+  }>
+}
+
 /* [Internal] Use a shared application */
 export type SystemActionUseShareApplication = ActionWithParams & {
   __actionName: 'USE_SHARE_APPLICATION'
@@ -599,3 +609,57 @@ export type SystemActionThrowException = ActionWithParams & {
 export type SystemActionDismissKeyboard = Action & {
   __actionName: 'DISMISS_KEYBOARD'
 }
+
+/* Trigger application AI filter */
+export type SystemActionTriggerApplicationFilter = ActionWithParams & {
+  __actionName: 'TRIGGER_APPLICATION_FILTER'
+  params?: Array<
+    | {
+        input: 'name'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'variables'
+        value?: any | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'result'
+        value?: string | DataLink | (() => Data) | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'error'
+        value?: string | DataLink | (() => Data) | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Stop running application AI filter */
+export type SystemActionStopApplicationFilter = Action & {
+  __actionName: 'STOP_APPLICATION_FILTER'
+}
+
+/* Save update snapshot (from Application Filter or DevTools MCP Server) to media system */
+export type SystemActionSaveUpdateSnapshot = ActionWithParams & {
+  __actionName: 'SAVE_UPDATE_SNAPSHOT'
+  params?: Array<
+    | {
+        input: 'snapshotFileIndentifier'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'snapshotSaveResult'
+        value?: string | DataLink | (() => Data) | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'snapshotErrorResult'
+        value?: string | DataLink | (() => Data) | EventProperty
+        mapping?: string
+      }
+  >
+}

package/utils/data.ts

@@ -64,6 +64,7 @@ type SystemDataName =
   | 'workspaceName'
   | 'applicationInfo'
   | 'applicationName'
+  | 'deviceID'
   | 'macAddress'
   | 'bindDeviceCode'
   | 'bindDeviceCodeExpire'
@@ -74,6 +75,10 @@ type SystemDataName =
   | 'env'
   | 'isViewDebugModeEnabled'
   | 'language'
+  | 'aiFilters'
+  | 'systemOpenAIApiKey'
+  | 'systemAnthropicApiKey'
+  | 'systemGeminiApiKey'
 
 type SystemDataInfo = {
   name: SystemDataName
@@ -343,6 +348,14 @@ export const systemDataList: Array<SystemDataInfo> = [
     type: 'string',
     value: '',
   },
+  {
+    name: 'deviceID',
+    id: 'PROPERTY_BANK_DATA_NODE_8b5c2d9e-f0a1-4b2c-8d3e-4f5a6b7c8d9e',
+    title: 'SYSTEM: Device ID',
+    description: 'Device ID of current device',
+    type: 'string',
+    value: 'unknown',
+  },
   {
     name: 'macAddress',
     id: 'PROPERTY_BANK_DATA_NODE_f01fcc78-0723-11ed-ac00-877339de1030',
@@ -423,6 +436,38 @@ export const systemDataList: Array<SystemDataInfo> = [
     type: 'string',
     value: '',
   },
+  {
+    name: 'aiFilters',
+    id: 'PROPERTY_BANK_DATA_NODE_3ffc1e98-8f65-4cc8-a949-3da8d2092ccb',
+    title: 'SYSTEM: AI Filters',
+    description: 'AI filters configuration from the application',
+    type: 'array',
+    value: [],
+  },
+  {
+    name: 'systemOpenAIApiKey',
+    id: 'PROPERTY_BANK_DATA_NODE_a1b2c3d4-5e6f-7890-abcd-ef1234567890',
+    title: 'SYSTEM: OpenAI API Key',
+    description: 'System OpenAI API Key (only available if application enabled)',
+    type: 'string',
+    value: '',
+  },
+  {
+    name: 'systemAnthropicApiKey',
+    id: 'PROPERTY_BANK_DATA_NODE_b2c3d4e5-6f78-9012-bcde-f23456789012',
+    title: 'SYSTEM: Anthropic API Key',
+    description: 'System Anthropic API Key (only available if application enabled)',
+    type: 'string',
+    value: '',
+  },
+  {
+    name: 'systemGeminiApiKey',
+    id: 'PROPERTY_BANK_DATA_NODE_c3d4e5f6-7890-1234-cdef-345678901234',
+    title: 'SYSTEM: Gemini API Key',
+    description: 'System Gemini API Key (only available if application enabled)',
+    type: 'string',
+    value: '',
+  },
 ]
 
 export const useSystemData = (name: SystemDataName): Data => {