@fugood/bricks-ctor 2.24.0-beta.40

package/types/generators/McpServer.ts

@@ -0,0 +1,289 @@
+/* Auto generated by build script
+ *
+ * MCP server exposing tools, resources (static/detect-data-change/script), and prompts. Supports HTTP listening with Bearer auth or direct-link from in-app MCP client
+ */
+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'
+
+/* Refresh tools and resources, used for case if tools or resources are changed. Note that the current connections will be closed. */
+export type GeneratorMCPServerActionRefreshResources = Action & {
+  __actionName: 'GENERATOR_MCP_SERVER_REFRESH_RESOURCES'
+}
+
+interface GeneratorMCPServerDef {
+  /*
+Default property:
+{
+  "enabled": true,
+  "listening": true,
+  "authType": "none",
+  "name": "bricks-foundation-mcp-server-default",
+  "version": "1.0.0",
+  "resources": [],
+  "tools": [],
+  "prompts": []
+}
+  */
+  property?: {
+    /* Enable MCP server. If enabled and Listening is false, the generator can still provide application-scoped resources. */
+    enabled?: boolean | DataLink
+    /* Application-scoped generator key, key cannot be the same with other application-scoped generators */
+    globalGeneratorKey?: string | DataLink
+    /* Start MCP server */
+    listening?: boolean | DataLink
+    /* HTTP server port */
+    port?: number | DataLink
+    /* Authorization type of HTTP request */
+    authType?: 'none' | 'bearer' | DataLink
+    /* Token of bearer auth */
+    bearerToken?: string | DataLink
+    /* Name of the MCP server */
+    name?: string | DataLink
+    /* Version of the MCP server */
+    version?: string | DataLink
+    /* Resources
+    Type:  
+    `static`: Return static data  
+    `detect-data-change`: Watch data target change to return data, 
+      please update data with ({ id: string, content: string | object }), 
+      and ensure the id is same with request id  
+    `script`: Run a JavaScript code to return data  
+      - Script can define members to call generator functions  
+      - Script support async/await */
+    resources?:
+      | Array<
+          | DataLink
+          | {
+              enabled?: boolean | DataLink
+              name?: string | DataLink
+              description?: string | DataLink
+              uriOrTemplate?: string | DataLink
+              type?: 'static' | 'detect-data-change' | 'script' | DataLink
+              staticData?: any
+              dataChangeConfig?:
+                | DataLink
+                | {
+                    target?: string | DataLink | (() => Data)
+                    timeout?: number | DataLink
+                    additionalParams?: {} | DataLink
+                  }
+              scriptConfig?:
+                | DataLink
+                | {
+                    code?: string | DataLink
+                    timeout?: number | DataLink
+                    members?:
+                      | Array<
+                          | DataLink
+                          | {
+                              handler?: string | DataLink | (() => Generator)
+                              varName?: string | DataLink
+                            }
+                        >
+                      | DataLink
+                    additionalParams?: {} | DataLink
+                  }
+              responseType?: 'text' | 'object' | DataLink
+            }
+        >
+      | DataLink
+    /* Tools
+    Type:  
+    `static`: Return static data  
+    `detect-data-change`: Watch data target change to return data, 
+      please update data with ({ id: string, content: string | object }), 
+      and ensure the id is same with request id.  
+    `script`: Run a JavaScript code to return data  
+      - Script can define members to call generator functions  
+      - Script support async/await */
+    tools?:
+      | Array<
+          | DataLink
+          | {
+              enabled?: boolean | DataLink
+              name?: string | DataLink
+              description?: string | DataLink
+              params?: {} | DataLink
+              type?: 'static' | 'detect-data-change' | 'script' | DataLink
+              staticData?: any
+              dataChangeConfig?:
+                | DataLink
+                | {
+                    target?: string | DataLink | (() => Data)
+                    timeout?: number | DataLink
+                    additionalParams?: {} | DataLink
+                  }
+              scriptConfig?:
+                | DataLink
+                | {
+                    code?: string | DataLink
+                    timeout?: number | DataLink
+                    members?:
+                      | Array<
+                          | DataLink
+                          | {
+                              handler?: string | DataLink | (() => Generator)
+                              varName?: string | DataLink
+                            }
+                        >
+                      | DataLink
+                    additionalParams?: {} | DataLink
+                  }
+              responseType?: 'text' | 'object' | DataLink
+            }
+        >
+      | DataLink
+    /* Prompts
+    Type:  
+    `static`: Return static data  
+    `detect-data-change`: Watch data target change to return data, 
+      please update data with ({ id: string, content: string | object }), 
+      and ensure the id is same with request id  
+    `script`: Run a JavaScript code to return data  
+      - Script can define members to call generator functions  
+      - Script support async/await */
+    prompts?:
+      | Array<
+          | DataLink
+          | {
+              enabled?: boolean | DataLink
+              name?: string | DataLink
+              description?: string | DataLink
+              arguments?: {} | DataLink
+              type?: 'static' | 'detect-data-change' | 'script' | DataLink
+              staticData?: any
+              dataChangeConfig?:
+                | DataLink
+                | {
+                    target?: string | DataLink | (() => Data)
+                    timeout?: number | DataLink
+                    additionalParams?: {} | DataLink
+                  }
+              scriptConfig?:
+                | DataLink
+                | {
+                    code?: string | DataLink
+                    timeout?: number | DataLink
+                    members?:
+                      | Array<
+                          | DataLink
+                          | {
+                              handler?: string | DataLink | (() => Generator)
+                              varName?: string | DataLink
+                            }
+                        >
+                      | DataLink
+                    additionalParams?: {} | DataLink
+                  }
+              responseType?: 'text' | 'object' | DataLink
+            }
+        >
+      | DataLink
+  }
+  events?: {
+    /* Listening of HTTP server */
+    onListening?: Array<EventAction>
+    /* Error of HTTP server */
+    onError?: Array<EventAction<string & keyof TemplateEventPropsMap['McpServer']['onError']>>
+    /* Client error of HTTP server */
+    onClientError?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['McpServer']['onClientError']>
+    >
+    /* Client close of HTTP server */
+    onClientClose?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['McpServer']['onClientClose']>
+    >
+    /* On request resource (Request: { name: string, uri: string, params: object }) */
+    onRequestResource?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['McpServer']['onRequestResource']>
+    >
+    /* On call tool (Request: { name: string, params: object }) */
+    onCallTool?: Array<EventAction<string & keyof TemplateEventPropsMap['McpServer']['onCallTool']>>
+    /* On get prompt (Request: { name: string, arguments: object }) */
+    onGetPrompt?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['McpServer']['onGetPrompt']>
+    >
+  }
+  outlets?: {
+    /* Whether the HTTP server is listening */
+    isListening?: () => Data<boolean>
+    /* Last error of HTTP server */
+    lastError?: () => Data<string>
+    /* MCP server endpoint URL */
+    endpoint?: () => Data<string>
+    /* Connected remotes (Session ID) */
+    connectedRemotes?: () => Data<Array<string>>
+    /* Last resource request ({ name: string, uri: string, params: object }) */
+    lastResourceRequest?: () => Data<{
+      type?: string
+      id?: string
+      name?: string
+      uri?: string
+      params?: { [key: string]: any }
+      arguments?: { [key: string]: any }
+      timeout?: number
+      [key: string]: any
+    }>
+    /* Last tool call ({ name: string, params: object }) */
+    lastToolCall?: () => Data<{
+      type?: string
+      id?: string
+      name?: string
+      uri?: string
+      params?: { [key: string]: any }
+      arguments?: { [key: string]: any }
+      timeout?: number
+      [key: string]: any
+    }>
+    /* Last prompt get ({ name: string, arguments: object }) */
+    lastPromptGet?: () => Data<{
+      type?: string
+      id?: string
+      name?: string
+      uri?: string
+      params?: { [key: string]: any }
+      arguments?: { [key: string]: any }
+      timeout?: number
+      [key: string]: any
+    }>
+  }
+}
+
+/* MCP server exposing tools, resources (static/detect-data-change/script), and prompts. Supports HTTP listening with Bearer auth or direct-link from in-app MCP client */
+export type GeneratorMCPServer = Generator &
+  GeneratorMCPServerDef & {
+    templateKey: 'GENERATOR_MCP_SERVER'
+    switches?: Array<
+      SwitchDef &
+        GeneratorMCPServerDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet:
+                    | 'isListening'
+                    | 'lastError'
+                    | 'endpoint'
+                    | 'connectedRemotes'
+                    | 'lastResourceRequest'
+                    | 'lastToolCall'
+                    | 'lastPromptGet'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/generators/MediaFlow.ts

@@ -0,0 +1,170 @@
+/* Auto generated by build script
+ *
+ * Fetch box's file list from Media Flow
+ */
+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 fetcn Media box file list */
+export type GeneratorMediaFlowActionFetch = Action & {
+  __actionName: 'GENERATOR_MEDIA_FLOW_FETCH'
+}
+
+/* Reset cache */
+export type GeneratorMediaFlowActionResetCache = Action & {
+  __actionName: 'GENERATOR_MEDIA_FLOW_RESET_CACHE'
+}
+
+/* Abort current fetch request of media list */
+export type GeneratorMediaFlowActionAbortFetch = Action & {
+  __actionName: 'GENERATOR_MEDIA_FLOW_ABORT_FETCH'
+}
+
+interface GeneratorMediaFlowDef {
+  /*
+Default property:
+{
+  "includeTypes": [
+    "IMAGE",
+    "VIDEO",
+    "AUDIO",
+    "FILE"
+  ],
+  "fetchPolicy": "cache-first",
+  "subscribeBoxChange": false,
+  "saveToStorageDownloadMode": "sequence",
+  "loadSizeLimit": "",
+  "allowLoadSizeLimitExceed": true,
+  "source": "original",
+  "sourceVersionAlternatives": []
+}
+  */
+  property?: {
+    /* The box id of Media Flow */
+    boxId?: string | DataLink
+    /* Authorize accessToken,    use `passcode` if `accessToken` is empty */
+    accessToken?: string | DataLink
+    /* Authorize passcode */
+    passcode?: string | DataLink
+    /* Include File Types */
+    includeTypes?: Array<'IMAGE' | 'VIDEO' | 'AUDIO' | 'FILE' | DataLink> | DataLink
+    /* Determine the cache behavior
+  
+ cache-first: Cache first if existing, then fetch from network  
+ network-and-cache: Fetch from network, then save cache  
+ network-only: Fetch from network only */
+    fetchPolicy?: 'cache-first' | 'network-and-cache' | 'network-only' | DataLink
+    /* Subscribe box change to refresh file list (file deleted / new file uploaded) */
+    subscribeBoxChange?: boolean | DataLink
+    /* Save files into local file storage */
+    saveToStorage?: boolean | DataLink
+    /* Concurrent download files or sequence for saveToStorage */
+    saveToStorageDownloadMode?: 'sequence' | 'concurrent' | DataLink
+    /* Limit the load size (* GB, * MB, * KB) */
+    loadSizeLimit?: string | DataLink
+    /* Allow Load size limit exceed, just call event */
+    allowLoadSizeLimitExceed?: boolean | DataLink
+    /* Select download source */
+    source?:
+      | 'original'
+      | 'auto'
+      | 'converted'
+      | 'video-thumbnail-original'
+      | 'use-source-versions'
+      | DataLink
+    /* Select download source with image version (use width, e.g. [250, 360]) */
+    sourceVersionAlternatives?: Array<number | DataLink> | DataLink
+    /* Allowlist patterns to filter media files (supports regex or plain text) */
+    allowlist?: Array<string | DataLink> | DataLink
+    /* Blocklist patterns to filter media files (supports regex or plain text) */
+    blocklist?: Array<string | DataLink> | DataLink
+  }
+  events?: {
+    /* Event of media box fetch error */
+    fetchError?: Array<EventAction<string & keyof TemplateEventPropsMap['MediaFlow']['fetchError']>>
+    /* Event of subscribe box change connected (If set `Subscribe Box Change`) */
+    subscribeBoxConnect?: Array<EventAction>
+    /* Event of subscribe box change error (If set `Subscribe Box Change`) */
+    subscribeBoxError?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['MediaFlow']['subscribeBoxError']>
+    >
+    /* Event of subscribe box change connection error (If set `Subscribe Box Change`) */
+    subscribeBoxConnectError?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['MediaFlow']['subscribeBoxConnectError']>
+    >
+    /* Event of file sync completed for used `saveToStorage` */
+    saveStorageCompleted?: Array<EventAction>
+    /* Event when file list size exceed of Load size limit */
+    fileSizeExceed?: Array<EventAction>
+  }
+  outlets?: {
+    /* File sync status */
+    downloadStatus?: () => Data<string>
+    /* File sync progress */
+    downloadProgress?: () => Data<
+      Array<{
+        key?: string
+        progress?: number
+        finished?: boolean
+        [key: string]: any
+      }>
+    >
+    /* File sync download errors */
+    downloadErrors?: () => Data<Array<string>>
+    /* Media box info */
+    box?: () => Data<{ [key: string]: any }>
+    /* Save Media Flow fetch result   [     {       "url": "https://d1kk0369g9vrck.cloudfront.net/box/5b431e29efd40c01e8b2019c/photo5b431e37efd40c01e8b201d1"       "extension": "", // enum("jpg", "png", "mp4")       "id": "5b431e37efd40c01e8b201d1",       "md5": "6134ab412351651324" // md5 came from media resource api     }   ] */
+    result?: () => Data<
+      Array<{
+        id?: string
+        key?: string
+        mediaType?: string
+        extension?: string
+        original?: string
+        url?: string
+        metadata?: { [key: string]: any }
+        [key: string]: any
+      }>
+    >
+    /* File sync result    [      {        "url": "/storage/emulated/0/Download/SyncFolder/Asset/1.png",        "mediaType": "photo" // enum("photo", "video"), used to distingiush        "id": "",      }    ] */
+    downloadFileUrls?: () => Data<Array<string>>
+  }
+}
+
+/* Fetch box's file list from Media Flow */
+export type GeneratorMediaFlow = Generator &
+  GeneratorMediaFlowDef & {
+    templateKey: 'GENERATOR_MEDIA_FLOW'
+    switches?: Array<
+      SwitchDef &
+        GeneratorMediaFlowDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet:
+                    | 'downloadStatus'
+                    | 'downloadProgress'
+                    | 'downloadErrors'
+                    | 'box'
+                    | 'result'
+                    | 'downloadFileUrls'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/generators/MqttBroker.ts

@@ -0,0 +1,141 @@
+/* Auto generated by build script
+ *
+ * Embedded MQTT broker server with client authentication, publish/subscribe messaging, keepalive, and retry support
+ */
+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 MQTT broker server */
+export type GeneratorMQTTBrokerActionStart = Action & {
+  __actionName: 'GENERATOR_MQTT_BROKER_START'
+}
+
+/* Publish message to topic */
+export type GeneratorMQTTBrokerActionPublish = ActionWithParams & {
+  __actionName: 'GENERATOR_MQTT_BROKER_PUBLISH'
+  params?: Array<
+    | {
+        input: 'topic'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'payload'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'messageId'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Stop MQTT broker server */
+export type GeneratorMQTTBrokerActionStop = Action & {
+  __actionName: 'GENERATOR_MQTT_BROKER_STOP'
+}
+
+interface GeneratorMQTTBrokerDef {
+  /*
+Default property:
+{
+  "init": false,
+  "port": 1883,
+  "retryInterval": 5,
+  "keepalive": 60,
+  "authenticate": false
+}
+  */
+  property?: {
+    /* Start MQTT broker on generator initialized */
+    init?: boolean | DataLink
+    /* Bind port of MQTT server */
+    port?: number | DataLink
+    /* Retry interval when publish failed */
+    retryInterval?: number | DataLink
+    /* Keep-alive interval */
+    keepalive?: number | DataLink
+    /* Enable authentication */
+    authenticate?: boolean | DataLink
+    /* Authentication table */
+    authTable?:
+      | Array<
+          | DataLink
+          | {
+              username?: string | DataLink
+              password?: string | DataLink
+            }
+        >
+      | DataLink
+  }
+  events?: {
+    /* Event of MQTT server is ready */
+    onReady?: Array<EventAction>
+    /* Event of server or connection error */
+    onError?: Array<EventAction<string & keyof TemplateEventPropsMap['MqttBroker']['onError']>>
+    /* Event of client connected */
+    onClientConnected?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['MqttBroker']['onClientConnected']>
+    >
+    /* Event of client disconnected */
+    onClientDisconnected?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['MqttBroker']['onClientDisconnected']>
+    >
+    /* Event of message received */
+    onMessageReceived?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['MqttBroker']['onMessageReceived']>
+    >
+    /* Event of message published */
+    onMessagePublished?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['MqttBroker']['onMessagePublished']>
+    >
+  }
+  outlets?: {
+    /* Is server started */
+    started?: () => Data<boolean>
+    /* Last received message */
+    lastMessage?: () => Data<{
+      topic?: string
+      payload?: any
+      qos?: number
+      retain?: boolean
+      [key: string]: any
+    }>
+    /* Error message */
+    errorMessage?: () => Data<string>
+  }
+}
+
+/* Embedded MQTT broker server with client authentication, publish/subscribe messaging, keepalive, and retry support */
+export type GeneratorMQTTBroker = Generator &
+  GeneratorMQTTBrokerDef & {
+    templateKey: 'GENERATOR_MQTT_BROKER'
+    switches?: Array<
+      SwitchDef &
+        GeneratorMQTTBrokerDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'started' | 'lastMessage' | 'errorMessage'
+                  value: any
+                }
+          }>
+        }
+    >
+  }