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

package/types/generators/Mcp.ts

@@ -0,0 +1,294 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+/* Connect to MCP server */
+export type GeneratorMCPActionConnect = Action & {
+  __actionName: 'GENERATOR_MCP_CONNECT'
+}
+
+/* Disconnect from MCP server */
+export type GeneratorMCPActionDisconnect = Action & {
+  __actionName: 'GENERATOR_MCP_DISCONNECT'
+}
+
+/* List resources */
+export type GeneratorMCPActionListResources = ActionWithParams & {
+  __actionName: 'GENERATOR_MCP_LIST_RESOURCES'
+  params?: Array<{
+    input: 'requestId'
+    value?: string | DataLink | EventProperty
+    mapping?: string
+  }>
+}
+
+/* List resource templates */
+export type GeneratorMCPActionListResourceTemplates = ActionWithParams & {
+  __actionName: 'GENERATOR_MCP_LIST_RESOURCE_TEMPLATES'
+  params?: Array<{
+    input: 'requestId'
+    value?: string | DataLink | EventProperty
+    mapping?: string
+  }>
+}
+
+/* Read resource */
+export type GeneratorMCPActionReadResource = ActionWithParams & {
+  __actionName: 'GENERATOR_MCP_READ_RESOURCE'
+  params?: Array<
+    | {
+        input: 'requestId'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'uri'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'variables'
+        value?: {} | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* List tools */
+export type GeneratorMCPActionListTools = ActionWithParams & {
+  __actionName: 'GENERATOR_MCP_LIST_TOOLS'
+  params?: Array<{
+    input: 'requestId'
+    value?: string | DataLink | EventProperty
+    mapping?: string
+  }>
+}
+
+/* Call tool */
+export type GeneratorMCPActionCallTool = ActionWithParams & {
+  __actionName: 'GENERATOR_MCP_CALL_TOOL'
+  params?: Array<
+    | {
+        input: 'requestId'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'name'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'variables'
+        value?: {} | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* List prompts */
+export type GeneratorMCPActionListPrompts = ActionWithParams & {
+  __actionName: 'GENERATOR_MCP_LIST_PROMPTS'
+  params?: Array<{
+    input: 'requestId'
+    value?: string | DataLink | EventProperty
+    mapping?: string
+  }>
+}
+
+/* Request prompt */
+export type GeneratorMCPActionGetPrompt = ActionWithParams & {
+  __actionName: 'GENERATOR_MCP_GET_PROMPT'
+  params?: Array<
+    | {
+        input: 'requestId'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'name'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'variables'
+        value?: {} | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+interface GeneratorMCPDef {
+  /*
+Default property:
+{
+  "init": false,
+  "type": "streamable-http",
+  "url": "",
+  "autoReconnect": true,
+  "maxReconnectAttempts": 10,
+  "reconnectInterval": 1000,
+  "generatorId": "",
+  "generatorKey": "",
+  "name": "bricks-foundation-mcp-client-default",
+  "version": "1.0.0",
+  "ignoreResourceInList": [],
+  "ignoreToolInList": [],
+  "ignorePromptInList": [],
+  "requestTimeout": 60000
+}
+  */
+  property?: {
+    /* Application-scoped generator key, key cannot be the same with other application-scoped generators */
+    globalGeneratorKey?: string | DataLink
+    /* Initialize the MCP client on start */
+    init?: boolean | DataLink
+    /* Type of the MCP connection, e.g. sse or direct-link (generator) */
+    type?: 'streamable-http' | 'sse' | 'direct-link' | DataLink
+    /* URL of the MCP server, e.g. http://localhost:19853/sse */
+    url?: string | DataLink
+    /* Whether to automatically reconnect to the MCP server */
+    autoReconnect?: boolean | DataLink
+    /* Maximum number of reconnection attempts */
+    maxReconnectAttempts?: number | DataLink
+    /* Reconnection interval in milliseconds */
+    reconnectInterval?: number | DataLink
+    /* SSE connection headers */
+    sseHeaders?: {} | DataLink
+    /* Send request headers */
+    sendHeaders?: {} | DataLink
+    /* Bearer token for authentication */
+    bearerToken?: string | DataLink
+    /* Generator MCP Server ID for direct link */
+    generatorId?: string | DataLink
+    /* Application-scoped key of Generator MCP Server for direct link (If ID is not provided) */
+    generatorKey?: string | DataLink
+    /* Name of the MCP client */
+    name?: string | DataLink
+    /* Version of the MCP client */
+    version?: string | DataLink
+    /* Ignore resources in list response */
+    ignoreResourceInList?: Array<string | DataLink> | DataLink
+    /* Ignore tools in list response */
+    ignoreToolInList?: Array<string | DataLink> | DataLink
+    /* Ignore prompts in list response */
+    ignorePromptInList?: Array<string | DataLink> | DataLink
+    /* Request timeout in milliseconds */
+    requestTimeout?: number | DataLink
+  }
+  events?: {
+    /* On connected */
+    onConnected?: Array<EventAction>
+    /* On connection error */
+    onConnectionError?: Array<EventAction>
+    /* On disconnected */
+    onDisconnected?: Array<EventAction>
+    /* On list resources */
+    onListResources?: Array<EventAction>
+    /* On list resources error */
+    onListResourcesError?: Array<EventAction>
+    /* On list resource templates */
+    onListResourceTemplates?: Array<EventAction>
+    /* On list resource templates error */
+    onListResourceTemplatesError?: Array<EventAction>
+    /* On read resource */
+    onReadResource?: Array<EventAction>
+    /* On read resource error */
+    onReadResourceError?: Array<EventAction>
+    /* On list tools */
+    onListTools?: Array<EventAction>
+    /* On list tools error */
+    onListToolsError?: Array<EventAction>
+    /* On call tool */
+    onCallTool?: Array<EventAction>
+    /* On call tool error */
+    onCallToolError?: Array<EventAction>
+    /* On list prompts */
+    onListPrompts?: Array<EventAction>
+    /* On list prompts error */
+    onListPromptsError?: Array<EventAction>
+    /* On get prompt */
+    onGetPrompt?: Array<EventAction>
+    /* On get prompt error */
+    onGetPromptError?: Array<EventAction>
+  }
+  outlets?: {
+    /* Connection state */
+    connectionState?: () => Data
+    /* List resources response */
+    listResourcesResponse?: () => Data
+    /* List resources error */
+    listResourcesError?: () => Data
+    /* List resource templates response */
+    listResourceTemplatesResponse?: () => Data
+    /* List resource templates error */
+    listResourceTemplatesError?: () => Data
+    /* Read resource response */
+    readResourceResponse?: () => Data
+    /* Read resource error */
+    readResourceError?: () => Data
+    /* List tools response */
+    listToolsResponse?: () => Data
+    /* List tools error */
+    listToolsError?: () => Data
+    /* Call tool response */
+    callToolResponse?: () => Data
+    /* Call tool error */
+    callToolError?: () => Data
+    /* List prompts response */
+    listPromptsResponse?: () => Data
+    /* List prompts error */
+    listPromptsError?: () => Data
+    /* Get prompt response */
+    getPromptResponse?: () => Data
+    /* Request prompt error */
+    getPromptError?: () => Data
+    /* Last error */
+    lastError?: () => Data
+  }
+}
+
+/* Model Context Protocol (MCP) Client, support SSE and Generator MCPServer direct link */
+export type GeneratorMCP = Generator &
+  GeneratorMCPDef & {
+    templateKey: 'GENERATOR_MCP'
+    switches: Array<
+      SwitchDef &
+        GeneratorMCPDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet:
+                    | 'connectionState'
+                    | 'listResourcesResponse'
+                    | 'listResourcesError'
+                    | 'listResourceTemplatesResponse'
+                    | 'listResourceTemplatesError'
+                    | 'readResourceResponse'
+                    | 'readResourceError'
+                    | 'listToolsResponse'
+                    | 'listToolsError'
+                    | 'callToolResponse'
+                    | 'callToolError'
+                    | 'listPromptsResponse'
+                    | 'listPromptsError'
+                    | 'getPromptResponse'
+                    | 'getPromptError'
+                    | 'lastError'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/generators/McpServer.ts

@@ -0,0 +1,248 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+/* 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
+                    timeout?: number | DataLink
+                    additionalParams?: {} | DataLink
+                  }
+              scriptConfig?:
+                | DataLink
+                | {
+                    code?: string | DataLink
+                    timeout?: number | DataLink
+                    members?:
+                      | Array<
+                          | DataLink
+                          | {
+                              handler?: string | DataLink
+                              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
+                    timeout?: number | DataLink
+                    additionalParams?: {} | DataLink
+                  }
+              scriptConfig?:
+                | DataLink
+                | {
+                    code?: string | DataLink
+                    timeout?: number | DataLink
+                    members?:
+                      | Array<
+                          | DataLink
+                          | {
+                              handler?: string | DataLink
+                              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
+                    timeout?: number | DataLink
+                    additionalParams?: {} | DataLink
+                  }
+              scriptConfig?:
+                | DataLink
+                | {
+                    code?: string | DataLink
+                    timeout?: number | DataLink
+                    members?:
+                      | Array<
+                          | DataLink
+                          | {
+                              handler?: string | DataLink
+                              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>
+    /* Client error of HTTP server */
+    onClientError?: Array<EventAction>
+    /* Client close of HTTP server */
+    onClientClose?: Array<EventAction>
+    /* On request resource (Request: { name: string, uri: string, params: object }) */
+    onRequestResource?: Array<EventAction>
+    /* On call tool (Request: { name: string, params: object }) */
+    onCallTool?: Array<EventAction>
+    /* On get prompt (Request: { name: string, arguments: object }) */
+    onGetPrompt?: Array<EventAction>
+  }
+  outlets?: {
+    /* Whether the HTTP server is listening */
+    isListening?: () => Data
+    /* Last error of HTTP server */
+    lastError?: () => Data
+    /* MCP server endpoint URL */
+    endpoint?: () => Data
+    /* Connected remotes (Session ID) */
+    connectedRemotes?: () => Data
+    /* Last resource request ({ name: string, uri: string, params: object }) */
+    lastResourceRequest?: () => Data
+    /* Last tool call ({ name: string, params: object }) */
+    lastToolCall?: () => Data
+    /* Last prompt get ({ name: string, arguments: object }) */
+    lastPromptGet?: () => Data
+  }
+}
+
+/* Model Context Protocol (MCP) Server (https://docs.anthropic.com/en/docs/agents-and-tools/mcp) */
+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,142 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+/* 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>
+    /* 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>
+    /* Event of subscribe box change connection error (If set `Subscribe Box Change`) */
+    subscribeBoxConnectError?: Array<EventAction>
+    /* 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
+    /* File sync progress */
+    downloadProgress?: () => Data
+    /* File sync download errors */
+    downloadErrors?: () => Data
+    /* Media box info */
+    box?: () => Data
+    /* 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
+    /* File sync result    [      {        "url": "/storage/emulated/0/Download/SyncFolder/Asset/1.png",        "mediaType": "photo" // enum("photo", "video"), used to distingiush        "id": "",      }    ] */
+    downloadFileUrls?: () => Data
+  }
+}
+
+/* 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
+                }
+          }>
+        }
+    >
+  }