@fugood/bricks-ctor 2.24.0-beta.40

package/types/generators/Watchdog.ts

@@ -0,0 +1,107 @@
+/* Auto generated by build script
+ *
+ * Trigger event with timeout by listening to specified events
+ */
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Brick,
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+import type { TemplateEventPropsMap } from '../../utils/event-props'
+
+/* 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<string & keyof TemplateEventPropsMap['Watchdog']['onEvent']>>
+    /* Event on timeout */
+    onTimeout?: Array<EventAction<string & keyof TemplateEventPropsMap['Watchdog']['onTimeout']>>
+  }
+  outlets?: {
+    /* The last event */
+    lastEvent?: () => Data<{
+      id?: string
+      type?: string
+      triggerType?: string
+      timeout?: number
+    }>
+    /* The type fo last event */
+    lastEventType?: () => Data<string>
+    /* The trigger type of last event */
+    lastEventTriggerType?: () => Data<string>
+    /* The sender id of last event */
+    lastEventSenderId?: () => Data<string>
+    /* Is timed out */
+    isTimedOut?: () => Data<boolean>
+  }
+}
+
+/* Trigger event with timeout by listening to 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,103 @@
+/* Auto generated by build script
+ *
+ * Extract web content via CSS selectors. Supports WebView method (iOS/Android, renders JS) and HTTP method (all platforms, direct request)
+ */
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Brick,
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+import type { TemplateEventPropsMap } from '../../utils/event-props'
+
+/* 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
+    /* Method 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<string>
+    /* Responses for CRAWLER request (selectorList) */
+    responseList?: () => Data<Array<any>>
+    /* The error response of CRAWLER request,  it will save to property bank */
+    error?: () => Data<string>
+  }
+}
+
+/* Extract web content via CSS selectors. Supports WebView method (iOS/Android, renders JS) and HTTP method (all platforms, direct request) */
+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,181 @@
+/* Auto generated by build script
+ *
+ * WebRTC peer connection for real-time audio/video/data communication
+ */
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Brick,
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+import type { TemplateEventPropsMap } from '../../utils/event-props'
+
+/* 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 | (() => Brick)
+    /* Target remote WebRTC stream brick ID */
+    remoteVideoTarget?: string | DataLink | (() => Brick)
+    /* 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<string & keyof TemplateEventPropsMap['Webrtc']['onSignalUpdate']>
+    >
+    /* Event of peer connected */
+    onConnected?: Array<EventAction>
+    /* Event of peer disconnected */
+    onDisconnected?: Array<EventAction>
+    /* Event of handshake error */
+    onError?: Array<EventAction<string & keyof TemplateEventPropsMap['Webrtc']['onError']>>
+    /* 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<string & keyof TemplateEventPropsMap['Webrtc']['onChannelMessage']>
+    >
+  }
+  outlets?: {
+    /* Signal to create peer connection */
+    signal?: () => Data<any>
+    /* Local SDP offer */
+    sdpOffer?: () => Data<{
+      type?: string
+      sdp?: string
+    }>
+    /* Local SDP answer */
+    sdpAnswer?: () => Data<{
+      type?: string
+      sdp?: string
+    }>
+    /* Peer connection state */
+    connectionState?: () => Data<string>
+    /* ICE connection state */
+    iceConnectionState?: () => Data<string>
+    /* Signaling state */
+    signalingState?: () => Data<string>
+    /* Last message from data channel */
+    lastChannelMessage?: () => Data<string>
+    /* Error message */
+    errorMessage?: () => Data<string>
+  }
+}
+
+/* WebRTC peer connection for real-time audio/video/data communication */
+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,148 @@
+/* Auto generated by build script
+ *
+ * WebSocket or Socket.IO Generator
+ */
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Brick,
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+import type { TemplateEventPropsMap } from '../../utils/event-props'
+
+/* 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<string & keyof TemplateEventPropsMap['WebSocket']['onMessage']>>
+    /* Event for error occurred */
+    onError?: Array<EventAction>
+  }
+  outlets?: {
+    /* Show socket.io connected or not */
+    readyState?: () => Data<string>
+    /* Results of each countdown change,  it will save to Data */
+    message?: () => Data<any>
+    /* When Socket.IO mode server can response acknowledgemnt with data to client */
+    acknowledgeData?: () => Data<{ [key: string]: any }>
+    /* Error message */
+    errorMessage?: () => Data<string>
+  }
+}
+
+/* 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,57 @@
+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 './VadTraditional'
+export * from './TextToSpeechOnnx'
+export * from './LlmOnnx'
+export * from './SpeechToTextOnnx'
+export * from './VadOnnx'
+export * from './SpeechToTextGgml'
+export * from './VadGgml'
+export * from './RealtimeTranscription'
+export * from './LlmGgml'
+export * from './TextToSpeechGgml'
+export * from './RerankerGgml'
+export * from './LlmMlx'
+export * from './LlmQualcommAiEngine'
+export * from './LlmMediaTekNeuroPilot'
+export * from './LlmOpenAiCompat'
+export * from './TextToSpeechOpenAiLike'
+export * from './LlmAnthropicCompat'
+export * from './LlmAppleBuiltin'
+export * from './SttAppleBuiltin'
+export * from './TextToSpeechAppleBuiltin'
+export * from './Assistant'
+export * from './VectorStore'

package/types/index.ts

@@ -0,0 +1,13 @@
+export * from './data'
+export * from './data-calc'
+export * from './data-calc-script'
+export * from './data-calc-command'
+export * from './generators'
+export * from './bricks'
+export * from './animation'
+export * from './canvas'
+export * from './subspace'
+export * from './common'
+export * from './switch'
+export * from './system'
+export * from './automation'

package/types/subspace.ts

@@ -0,0 +1,59 @@
+import type { Brick, Generator, LocalSyncStrategy, EventAction, SubspaceID } from './common'
+import type { Animation } from './animation'
+import type { Canvas } from './canvas'
+import type { Data } from './data'
+import type { DataCalculation } from './data-calc'
+
+export type Subspace = {
+  __typename: 'Subspace'
+  id: string
+  title: string
+  description?: string
+  hideShortRef?: boolean
+  unused?: boolean
+  portal?: 'top' | 'left' | 'bottom' | 'right'
+  // Unexpanded information in Editor
+  unexpanded?: {
+    data?: boolean
+    dataCalculation?: boolean
+    brick?: boolean
+    generator?: boolean
+    canvas?: Array<Canvas>
+  }
+  module?: {
+    id: string
+    version: string
+    selectedRequirements?: Array<{
+      subspace: SubspaceID
+      id: string
+      version: string
+    }>
+    // Module only
+    requirements?: Array<{
+      subspace: SubspaceID
+      id: string
+      version: string
+    }>
+  }
+  localSyncChangeCanvas?: LocalSyncStrategy
+  layout: {
+    width: number
+    height: number
+    resizeMode?: 'cover' | 'stretch'
+  }
+  rootCanvas: Canvas
+  canvases: Array<Canvas>
+  animations: Array<Animation>
+  bricks: Array<Brick>
+  generators: Array<Generator>
+  data: Array<Data>
+  dataRouting: Array<Data>
+  dataCalculation: Array<DataCalculation>
+  actions?: {
+    [key: string]: {
+      description: string
+      // TODO: add eventPropertyMap
+    }
+  }
+  events?: { [key: string]: Array<EventAction> }
+}