@fugood/bricks-project 2.22.0-beta.8 → 2.22.0

package/types/generators/VectorStore.ts

@@ -0,0 +1,223 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+/* Load the model (Only if source is ggml) */
+export type GeneratorVectorStoreActionModelLoad = Action & {
+  __actionName: 'GENERATOR_VECTOR_STORE_MODEL_LOAD'
+}
+
+/* Release the model (Only if source is ggml) */
+export type GeneratorVectorStoreActionModelRelease = Action & {
+  __actionName: 'GENERATOR_VECTOR_STORE_MODEL_RELEASE'
+}
+
+/* Reset the embedding session */
+export type GeneratorVectorStoreActionReset = ActionWithParams & {
+  __actionName: 'GENERATOR_VECTOR_STORE_RESET'
+  params?: Array<{
+    input: 'resetType'
+    value?: 'session' | 'all' | DataLink | EventProperty
+    mapping?: string
+  }>
+}
+
+/* Insert file content with path or url, support Office / OpenOffice / PDF  
+
+ PDF is not currently supprted in iOS / Android */
+export type GeneratorVectorStoreActionInsertFile = ActionWithParams & {
+  __actionName: 'GENERATOR_VECTOR_STORE_INSERT_FILE'
+  params?: Array<
+    | {
+        input: 'filePath'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'fileName'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'fileExtension'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'chunkSize'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Cancel the file download */
+export type GeneratorVectorStoreActionCancelFileDownload = Action & {
+  __actionName: 'GENERATOR_VECTOR_STORE_CANCEL_FILE_DOWNLOAD'
+}
+
+/* Insert pure text content to vector store */
+export type GeneratorVectorStoreActionInsertContent = ActionWithParams & {
+  __actionName: 'GENERATOR_VECTOR_STORE_INSERT_CONTENT'
+  params?: Array<
+    | {
+        input: 'textContent'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'fileName'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'payload'
+        value?: {} | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'chunkSize'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Remove file from vector store */
+export type GeneratorVectorStoreActionRemoveFile = ActionWithParams & {
+  __actionName: 'GENERATOR_VECTOR_STORE_REMOVE_FILE'
+  params?: Array<{
+    input: 'fileName'
+    value?: string | DataLink | EventProperty
+    mapping?: string
+  }>
+}
+
+/* Search similar text chunks in vector store */
+export type GeneratorVectorStoreActionSearch = ActionWithParams & {
+  __actionName: 'GENERATOR_VECTOR_STORE_SEARCH'
+  params?: Array<
+    | {
+        input: 'text'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'filename'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'limit'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'threshold'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'ignoreThreshold'
+        value?: boolean | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+interface GeneratorVectorStoreDef {
+  /*
+Default property:
+{
+  "source": "ggml",
+  "ggmlContextSize": 512,
+  "openaiBaseUrl": "https://api.openai.com/v1",
+  "openaiModel": "text-embedding-3-small",
+  "embedSessionId": "default-embeddings",
+  "fileChunkSize": 256
+}
+  */
+  property?: {
+    /* Initialize embedding model context & tokenizer context on subspace mounted */
+    init?: boolean | DataLink
+    /* Source of embedding model. Note that you can't use the saved embedddings data in different sources. */
+    source?: 'ggml' | 'openai' | DataLink
+    /* Path of ggml model */
+    ggmlModelUrl?: string | DataLink
+    /* Hash type of ggml model */
+    ggmlModelHashType?: 'sha256' | 'sha1' | 'md5' | DataLink
+    /* Hash of ggml model */
+    ggmlModelHash?: string | DataLink
+    /* Size of ggml context */
+    ggmlContextSize?: number | DataLink
+    /* Pooling type of ggml model */
+    ggmlPoolingType?: 'none' | 'mean' | 'cls' | 'last' | 'rank' | DataLink
+    /* Accelerator variant of ggml model */
+    ggmlAccelVariant?: 'default' | 'vulkan' | 'cuda' | DataLink
+    /* Normalize */
+    ggmlEmbdNormalize?: number | DataLink
+    /* API key of OpenAI Compatible API */
+    openaiApiKey?: string | DataLink
+    /* Base URL of OpenAI Compatible API. For example, we can use ollama / llama.cpp server instead of openai */
+    openaiBaseUrl?: string | DataLink
+    /* Model of OpenAI Compatible API */
+    openaiModel?: 'text-embedding-3-small' | 'text-embedding-3-large' | DataLink
+    /* Session ID of embedding */
+    embedSessionId?: string | DataLink
+    /* Storage type of embedding */
+    embedStorageType?: 'file' | 'memory' | DataLink
+    /* Tokenizer model URL (Recommended to use same with your LLM model, the model will just load with vocab_only mode) */
+    tokenizerModelUrl?: string | DataLink
+    /* Tokenizer model hash */
+    tokenizerModelHash?: string | DataLink
+    /* Tokenizer model hash type */
+    tokenizerModelHashType?: 'sha256' | 'sha1' | 'md5' | DataLink
+    /* Chunk size to handle file content (token), must be less then embedding model context size */
+    fileChunkSize?: number | DataLink
+  }
+  events?: {
+    /* Event triggered when error occurs */
+    onError?: Array<EventAction>
+  }
+  outlets?: {
+    /* undefined */
+    isReady?: () => Data
+    /* Whether the embedding is processing */
+    processing?: () => Data
+    /* Progress of embedding processing */
+    processProgress?: () => Data
+    /* Files inserted to embedding */
+    files?: () => Data
+    /* Search result */
+    searchResult?: () => Data
+  }
+}
+
+/* Vector Store - File embeddings & search */
+export type GeneratorVectorStore = Generator &
+  GeneratorVectorStoreDef & {
+    templateKey: 'GENERATOR_VECTOR_STORE'
+    switches: Array<
+      SwitchDef &
+        GeneratorVectorStoreDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'isReady' | 'processing' | 'processProgress' | 'files' | 'searchResult'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

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
+                }
+          }>
+        }
+    >
+  }