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

package/types/generators/SpeechToTextPlatform.ts

@@ -0,0 +1,75 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+/* Start speech recognition */
+export type GeneratorPlatformSTTActionStart = Action & {
+  __actionName: 'GENERATOR_PLATFORM_STT_START'
+}
+
+/* Stop speech recognition */
+export type GeneratorPlatformSTTActionStop = Action & {
+  __actionName: 'GENERATOR_PLATFORM_STT_STOP'
+}
+
+interface GeneratorPlatformSTTDef {
+  /*
+Default property:
+{
+  "locale": "en_US"
+}
+  */
+  property?: {
+    /* Locale for speech recognition */
+    locale?: string | DataLink
+    /* [iOS] An array of phrases that should be recognized, even if they are not in the system vocabulary. */
+    iosContextualStrings?: Array<string | DataLink> | DataLink
+  }
+  events?: {
+    /* Event for speech recognition start */
+    onSpeechStart?: Array<EventAction>
+    /* Event for speech recognition end */
+    onSpeechEnd?: Array<EventAction>
+    /* Event for speech recognition results */
+    onSpeechResults?: Array<EventAction>
+    /* Event for speech recognition error */
+    onSpeechError?: Array<EventAction>
+  }
+  outlets?: {
+    /* Recognized speech text */
+    recognizedText?: () => Data
+    /* Error message */
+    errorMessage?: () => Data
+    /* Listening status */
+    listening?: () => Data
+  }
+}
+
+/* Speech-to-Text using platform's native capabilities */
+export type GeneratorPlatformSTT = Generator &
+  GeneratorPlatformSTTDef & {
+    templateKey: 'GENERATOR_PLATFORM_STT'
+    switches: Array<
+      SwitchDef &
+        GeneratorPlatformSTTDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'recognizedText' | 'errorMessage' | 'listening'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/generators/SqLite.ts

@@ -0,0 +1,118 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+/* Execute SQL statement */
+export type GeneratorSqliteActionExecute = ActionWithParams & {
+  __actionName: 'GENERATOR_SQLITE_EXECUTE'
+  params?: Array<
+    | {
+        input: 'sql'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'params'
+        value?: Array<any> | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'paramsString'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Query data from database */
+export type GeneratorSqliteActionQuery = ActionWithParams & {
+  __actionName: 'GENERATOR_SQLITE_QUERY'
+  params?: Array<
+    | {
+        input: 'sql'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'params'
+        value?: Array<any> | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'paramsString'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+interface GeneratorSqliteDef {
+  /*
+Default property:
+{
+  "init": false,
+  "dbName": "default",
+  "storageType": "file",
+  "useFile": false
+}
+  */
+  property?: {
+    /* Initialize database on subspace mounted */
+    init?: boolean | DataLink
+    /* Database name */
+    dbName?: string | DataLink
+    /* Storage type */
+    storageType?: 'file' | 'memory' | DataLink
+    /* Use specific file (memory type will be ignored) */
+    useFile?: boolean | DataLink
+    /* File URI for SQLite database */
+    fileUri?: string | DataLink
+    /* MD5 hash of file URI */
+    fileUriMd5?: string | DataLink
+  }
+  events?: {
+    /* Event triggered when error occurs */
+    onError?: Array<EventAction>
+    /* Event triggered when query result is ready */
+    onQueryResult?: Array<EventAction>
+  }
+  outlets?: {
+    /* Whether the database is ready */
+    isReady?: () => Data
+    /* Database path */
+    dbPath?: () => Data
+    /* Error message */
+    error?: () => Data
+    /* Last query result */
+    lastResult?: () => Data
+  }
+}
+
+/* SQLite - General database operations */
+export type GeneratorSqlite = Generator &
+  GeneratorSqliteDef & {
+    templateKey: 'GENERATOR_SQLITE'
+    switches: Array<
+      SwitchDef &
+        GeneratorSqliteDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'isReady' | 'dbPath' | 'error' | 'lastResult'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/generators/Step.ts

@@ -0,0 +1,101 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+/* Start execute the step */
+export type GeneratorStepActionStart = Action & {
+  __actionName: 'GENERATOR_STEP_START'
+}
+
+/* Pause steps */
+export type GeneratorStepActionPause = Action & {
+  __actionName: 'GENERATOR_STEP_PAUSE'
+}
+
+/* Resume from pause step */
+export type GeneratorStepActionResume = Action & {
+  __actionName: 'GENERATOR_STEP_RESUME'
+}
+
+/* Skip to the previous step and execute directly */
+export type GeneratorStepActionPerviousStep = Action & {
+  __actionName: 'GENERATOR_STEP_PERVIOUS_STEP'
+}
+
+/* Skip to the next step and execute directly */
+export type GeneratorStepActionNextStep = Action & {
+  __actionName: 'GENERATOR_STEP_NEXT_STEP'
+}
+
+/* Skip to the first step and execute directly */
+export type GeneratorStepActionFirstStep = Action & {
+  __actionName: 'GENERATOR_STEP_FIRST_STEP'
+}
+
+/* Skip to the last step and execute directly */
+export type GeneratorStepActionLastStep = Action & {
+  __actionName: 'GENERATOR_STEP_LAST_STEP'
+}
+
+interface GeneratorStepDef {
+  /*
+Default property:
+{
+  "init": false,
+  "steps": []
+}
+  */
+  property?: {
+    init?: boolean | DataLink
+    /* Step definition list */
+    steps?:
+      | Array<
+          | DataLink
+          | {
+              duration?: number | DataLink
+              action?: 'change-canvas' | 'outlet' | 'event' | DataLink
+              payload?: string | DataLink
+            }
+        >
+      | DataLink
+  }
+  events?: {
+    /* Event on step (If action is `event`) */
+    onStep?: Array<EventAction>
+  }
+  outlets?: {
+    /* Result of step payload (If action is `outlet`) */
+    payload?: () => Data
+    /* Result of step index (If action is `outlet`) */
+    index?: () => Data
+  }
+}
+
+/* Trigger change canvas / outlet / event by setup rules */
+export type GeneratorStep = Generator &
+  GeneratorStepDef & {
+    templateKey: 'GENERATOR_STEP'
+    switches: Array<
+      SwitchDef &
+        GeneratorStepDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'payload' | 'index'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/generators/Tcp.ts

@@ -0,0 +1,120 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+/* Start connect */
+export type GeneratorTCPActionConnect = Action & {
+  __actionName: 'GENERATOR_TCP_CONNECT'
+}
+
+/* Send data */
+export type GeneratorTCPActionSend = ActionWithParams & {
+  __actionName: 'GENERATOR_TCP_SEND'
+  params?: Array<{
+    input: 'sendData'
+    value?: string | DataLink | EventProperty
+    mapping?: string
+  }>
+}
+
+/* End connection */
+export type GeneratorTCPActionEnd = ActionWithParams & {
+  __actionName: 'GENERATOR_TCP_END'
+  params?: Array<{
+    input: 'endWithData'
+    value?: string | DataLink | EventProperty
+    mapping?: string
+  }>
+}
+
+interface GeneratorTCPDef {
+  /*
+Default property:
+{
+  "init": false,
+  "dataMode": "raw",
+  "encoding": "utf8",
+  "idleTimeout": 0,
+  "bufferSize": 1024,
+  "tls": false,
+  "tlsCheckValidity": false,
+  "tlsCert": ""
+}
+  */
+  property?: {
+    /* Start connect on generator initialized */
+    init?: boolean | DataLink
+    /* Connection target host or IP assress */
+    host?: string | DataLink
+    /* Connection target port */
+    port?: number | DataLink
+    /* Data mode  
+  CRLF: Receive until CRLF  
+  LF: Receive until LF  
+  raw: Raw packet */
+    dataMode?: 'CRLF' | 'LF' | 'raw' | DataLink
+    /* Encoding of data */
+    encoding?: 'base64' | 'utf8' | 'ascii' | DataLink
+    /* Max connection idle time, 0 is disable */
+    idleTimeout?: number | DataLink
+    /* Enable keepalive */
+    keepAlive?: boolean | DataLink
+    /* Buffer size limit of receive plaintext line */
+    bufferSize?: number | DataLink
+    /* Enable TLS */
+    tls?: boolean | DataLink
+    /* Enable TLS certificate verify */
+    tlsCheckValidity?: boolean | DataLink
+    /* Trust certificate list (PEM format) */
+    tlsCert?: string | DataLink
+  }
+  events?: {
+    /* Event of connect successful */
+    onConnected?: Array<EventAction>
+    /* Event of receive data */
+    onData?: Array<EventAction>
+    /* Event of connection idle timeout */
+    onTimeout?: Array<EventAction>
+    /* Event of connection close */
+    onClose?: Array<EventAction>
+    /* Event of connection error */
+    onError?: Array<EventAction>
+  }
+  outlets?: {
+    /* Connection status */
+    status?: () => Data
+    /* Last received data */
+    lastData?: () => Data
+    /* Error message */
+    errorMessage?: () => Data
+  }
+}
+
+/* TCP */
+export type GeneratorTCP = Generator &
+  GeneratorTCPDef & {
+    templateKey: 'GENERATOR_TCP'
+    switches: Array<
+      SwitchDef &
+        GeneratorTCPDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'status' | 'lastData' | 'errorMessage'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/generators/TcpServer.ts

@@ -0,0 +1,137 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+/* Start TCP server */
+export type GeneratorTCPServerActionStart = Action & {
+  __actionName: 'GENERATOR_TCP_SERVER_START'
+}
+
+/* Send data to specify connection */
+export type GeneratorTCPServerActionSend = ActionWithParams & {
+  __actionName: 'GENERATOR_TCP_SERVER_SEND'
+  params?: Array<
+    | {
+        input: 'remote'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'sendData'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* End specify connection */
+export type GeneratorTCPServerActionEnd = ActionWithParams & {
+  __actionName: 'GENERATOR_TCP_SERVER_END'
+  params?: Array<
+    | {
+        input: 'remote'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'generatorTcpClientEndWithData'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Stop TCP server */
+export type GeneratorTCPServerActionStop = Action & {
+  __actionName: 'GENERATOR_TCP_SERVER_STOP'
+}
+
+interface GeneratorTCPServerDef {
+  /*
+Default property:
+{
+  "init": false,
+  "dataMode": "raw",
+  "encoding": "utf8",
+  "bufferSize": 1024,
+  "concurrent": 5,
+  "idleTimeout": 0
+}
+  */
+  property?: {
+    /* Start TCP server on generator initialized */
+    init?: boolean | DataLink
+    /* Bind port of TCP server */
+    port?: number | DataLink
+    /* Data mode  
+  CRLF: Receive until CRLF  
+  LF: Receive until LF  
+  raw: Raw packet */
+    dataMode?: 'CRLF' | 'LF' | 'raw' | DataLink
+    /* Encoding of data */
+    encoding?: 'base64' | 'utf8' | 'ascii' | DataLink
+    /* Buffer size limit of receive plaintext line */
+    bufferSize?: number | DataLink
+    /* Max concurrent connection count */
+    concurrent?: number | DataLink
+    /* Max connection idle time, 0 is disable */
+    idleTimeout?: number | DataLink
+    /* Enable TLS */
+    tls?: boolean | DataLink
+    /* TLS key pair (Base64 encoded no password PKCS #12) */
+    tlsKeyPair?: string | DataLink
+  }
+  events?: {
+    /* Event of TCP server is ready */
+    onReady?: Array<EventAction>
+    /* Event of TCP server accept the connection */
+    onAcceptConnection?: Array<EventAction>
+    /* Event of receive data */
+    onData?: Array<EventAction>
+    /* Event of connection idle timeout */
+    onTimeout?: Array<EventAction>
+    /* Event of connection close */
+    onClose?: Array<EventAction>
+    /* Event of server or connection error */
+    onError?: Array<EventAction>
+  }
+  outlets?: {
+    /* Is server started */
+    started?: () => Data
+    /* Accepted connections */
+    connections?: () => Data
+    /* Last received data */
+    lastData?: () => Data
+    /* Error message */
+    errorMessage?: () => Data
+  }
+}
+
+/* TCP Server */
+export type GeneratorTCPServer = Generator &
+  GeneratorTCPServerDef & {
+    templateKey: 'GENERATOR_TCP_SERVER'
+    switches: Array<
+      SwitchDef &
+        GeneratorTCPServerDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'started' | 'connections' | 'lastData' | 'errorMessage'
+                  value: any
+                }
+          }>
+        }
+    >
+  }