@fugood/bricks-ctor 2.24.0-beta.40

package/types/generators/SpeechToTextOnnx.ts

@@ -0,0 +1,236 @@
+/* Auto generated by build script
+ *
+ * Local STT inference based on [transformers.js](https://huggingface.co/docs/transformers.js)
+ *  You can use any converted model on HuggingFace.
+ */
+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'
+
+/* Load the model */
+export type GeneratorOnnxSTTActionLoadModel = Action & {
+  __actionName: 'GENERATOR_ONNX_STT_LOAD_MODEL'
+}
+
+/* Inference */
+export type GeneratorOnnxSTTActionInfer = ActionWithParams & {
+  __actionName: 'GENERATOR_ONNX_STT_INFER'
+  params?: Array<{
+    input: 'audioUri'
+    value?: string | DataLink | EventProperty
+    mapping?: string
+  }>
+}
+
+/* Clean cache */
+export type GeneratorOnnxSTTActionCleanCache = Action & {
+  __actionName: 'GENERATOR_ONNX_STT_CLEAN_CACHE'
+}
+
+/* Release context */
+export type GeneratorOnnxSTTActionReleaseContext = Action & {
+  __actionName: 'GENERATOR_ONNX_STT_RELEASE_CONTEXT'
+}
+
+interface GeneratorOnnxSTTDef {
+  /*
+Default property:
+{
+  "model": "whisper-base",
+  "modelType": "auto",
+  "returnTimestamps": "none",
+  "executionMode": "sequential"
+}
+  */
+  property?: {
+    /* Initialize the TTS context on generator initialization */
+    init?: boolean | DataLink
+    /* STT model */
+    model?: string | DataLink
+    /* Model type */
+    modelType?: string | DataLink
+    /* Quantize type */
+    quantizeType?:
+      | 'auto'
+      | 'none'
+      | 'fp16'
+      | 'q8'
+      | 'int8'
+      | 'uint8'
+      | 'q4'
+      | 'bnb4'
+      | 'q4f16'
+      | DataLink
+    /* Return timestamps */
+    returnTimestamps?: 'none' | 'enable' | 'word' | DataLink
+    /* Transcription language
+  Not specifying the language will auto detect the language. */
+    language?:
+      | 'English'
+      | 'Chinese'
+      | 'German'
+      | 'Spanish'
+      | 'Russian'
+      | 'Korean'
+      | 'French'
+      | 'Japanese'
+      | 'Portuguese'
+      | 'Turkish'
+      | 'Polish'
+      | 'Catalan'
+      | 'Dutch'
+      | 'Arabic'
+      | 'Swedish'
+      | 'Italian'
+      | 'Indonesian'
+      | 'Hindi'
+      | 'Finnish'
+      | 'Vietnamese'
+      | 'Hebrew'
+      | 'Ukrainian'
+      | 'Greek'
+      | 'Malay'
+      | 'Czech'
+      | 'Romanian'
+      | 'Danish'
+      | 'Hungarian'
+      | 'Tamil'
+      | 'Norwegian'
+      | 'Thai'
+      | 'Urdu'
+      | 'Croatian'
+      | 'Bulgarian'
+      | 'Lithuanian'
+      | 'Latin'
+      | 'Maori'
+      | 'Malayalam'
+      | 'Welsh'
+      | 'Slovak'
+      | 'Telugu'
+      | 'Persian'
+      | 'Latvian'
+      | 'Bengali'
+      | 'Serbian'
+      | 'Azerbaijani'
+      | 'Slovenian'
+      | 'Kannada'
+      | 'Estonian'
+      | 'Macedonian'
+      | 'Breton'
+      | 'Basque'
+      | 'Icelandic'
+      | 'Armenian'
+      | 'Nepali'
+      | 'Mongolian'
+      | 'Bosnian'
+      | 'Kazakh'
+      | 'Albanian'
+      | 'Swahili'
+      | 'Galician'
+      | 'Marathi'
+      | 'Punjabi'
+      | 'Sinhala'
+      | 'Khmer'
+      | 'Shona'
+      | 'Yoruba'
+      | 'Somali'
+      | 'Afrikaans'
+      | 'Occitan'
+      | 'Georgian'
+      | 'Belarusian'
+      | 'Tajik'
+      | 'Sindhi'
+      | 'Gujarati'
+      | 'Amharic'
+      | 'Yiddish'
+      | 'Lao'
+      | 'Uzbek'
+      | 'Faroese'
+      | 'Haitian Creole'
+      | 'Pashto'
+      | 'Turkmen'
+      | 'Nynorsk'
+      | 'Maltese'
+      | 'Sanskrit'
+      | 'Luxembourgish'
+      | 'Myanmar'
+      | 'Tibetan'
+      | 'Tagalog'
+      | 'Malagasy'
+      | 'Assamese'
+      | 'Tatar'
+      | 'Hawaiian '
+      | 'Lingala'
+      | 'Hausa'
+      | 'Bashkir'
+      | 'Javanese'
+      | 'Sundanese'
+      | DataLink
+    /* Task */
+    task?: 'transcribe' | 'translate' | DataLink
+    /* Inferencing chunk length */
+    chunkLength?: number | DataLink
+    /* Executor candidates, descending order of priority
+  Default will be xnnpack, wasm, cpu */
+    executors?:
+      | Array<'qnn' | 'dml' | 'nnapi' | 'xnnpack' | 'coreml' | 'cpu' | 'wasm' | 'webgpu' | DataLink>
+      | DataLink
+    /* Execution mode
+  Usually when the model has many branches, setting this option to `parallel` will give you better performance. */
+    executionMode?: 'sequential' | 'parallel' | DataLink
+    /* QNN backend */
+    qnnBackend?: 'HTP' | 'HTA' | 'DSP' | 'GPU' | 'CPU' | DataLink
+    /* Enable FP16 for QNN HTP */
+    qnnHtpEnableFp16?: boolean | DataLink
+    /* Enable QNN debug */
+    qnnEnableDebug?: boolean | DataLink
+  }
+  events?: {
+    /* Event triggered when state change */
+    onContextStateChange?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['OnnxStt']['onContextStateChange']>
+    >
+    /* Event triggered when error occurs */
+    onError?: Array<EventAction<string & keyof TemplateEventPropsMap['OnnxStt']['onError']>>
+  }
+  outlets?: {
+    /* Context state */
+    contextState?: () => Data<string>
+    /* Inference result */
+    result?: () => Data<string>
+    /* Inference result detail */
+    resultDetail?: () => Data<{ [key: string]: any }>
+  }
+}
+
+/* Local STT inference based on [transformers.js](https://huggingface.co/docs/transformers.js)
+ You can use any converted model on HuggingFace. */
+export type GeneratorOnnxSTT = Generator &
+  GeneratorOnnxSTTDef & {
+    templateKey: 'GENERATOR_ONNX_STT'
+    switches?: Array<
+      SwitchDef &
+        GeneratorOnnxSTTDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'contextState' | 'result' | 'resultDetail'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/generators/SpeechToTextPlatform.ts

@@ -0,0 +1,85 @@
+/* Auto generated by build script
+ *
+ * Speech-to-Text using platform's native capabilities
+ */
+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'
+
+/* 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<string & keyof TemplateEventPropsMap['PlatformStt']['onSpeechResults']>
+    >
+    /* Event for speech recognition error */
+    onSpeechError?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['PlatformStt']['onSpeechError']>
+    >
+  }
+  outlets?: {
+    /* Recognized speech text */
+    recognizedText?: () => Data<string>
+    /* Error message */
+    errorMessage?: () => Data<string>
+    /* Listening status */
+    listening?: () => Data<boolean>
+  }
+}
+
+/* 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,159 @@
+/* Auto generated by build script
+ *
+ * SQLite database: create tables, query, insert, update, and delete with SQL
+ */
+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'
+
+/* 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
+      }
+  >
+}
+
+/* Execute multiple SQL statements in transaction */
+export type GeneratorSqliteActionTransaction = ActionWithParams & {
+  __actionName: 'GENERATOR_SQLITE_TRANSACTION'
+  params?: Array<{
+    input: 'statements'
+    value?: Array<any> | DataLink | EventProperty
+    mapping?: string
+  }>
+}
+
+/* Execute same SQL statement with multiple parameter sets */
+export type GeneratorSqliteActionBatchExecute = ActionWithParams & {
+  __actionName: 'GENERATOR_SQLITE_BATCH_EXECUTE'
+  params?: Array<
+    | {
+        input: 'sql'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'batchParams'
+        value?: Array<any> | 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<string & keyof TemplateEventPropsMap['Sqlite']['onError']>>
+    /* Event triggered when query result is ready */
+    onQueryResult?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['Sqlite']['onQueryResult']>
+    >
+  }
+  outlets?: {
+    /* Whether the database is ready */
+    isReady?: () => Data<boolean>
+    /* Database path */
+    dbPath?: () => Data<string>
+    /* Error message */
+    error?: () => Data<string>
+    /* Last query result */
+    lastResult?: () => Data<Array<{ [key: string]: any }>>
+    /* Last execute result with metadata */
+    lastExecuteResult?: () => Data<{
+      rowsAffected?: number
+      insertId?: number
+      [key: string]: any
+    }>
+  }
+}
+
+/* SQLite database: create tables, query, insert, update, and delete with SQL */
+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' | 'lastExecuteResult'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/generators/Step.ts

@@ -0,0 +1,107 @@
+/* Auto generated by build script
+ *
+ * Trigger change canvas / outlet / event by setup rules
+ */
+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'
+
+/* 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<string & keyof TemplateEventPropsMap['Step']['onStep']>>
+  }
+  outlets?: {
+    /* Result of step payload (If action is `outlet`) */
+    payload?: () => Data<string>
+    /* Result of step index (If action is `outlet`) */
+    index?: () => Data<number>
+  }
+}
+
+/* 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
+                }
+          }>
+        }
+    >
+  }