@fugood/bricks-project 2.22.0-beta.27 → 2.22.0-beta.28

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,51 @@
+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 './TapToPayOnIPhone'
+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'