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

package/types/bricks/Video.ts

@@ -0,0 +1,170 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type { Animation, AnimationBasicEvents } from '../animation'
+import type {
+  Brick,
+  EventAction,
+  EventActionForItem,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+import type { BrickBasicProperty, BrickBasicEvents, BrickBasicEventsForItem } from '../brick-base'
+
+/* Play the video */
+export type BrickVideoActionPlay = Action & {
+  __actionName: 'BRICK_VIDEO_PLAY'
+}
+
+/* Seek the video */
+export type BrickVideoActionSeek = ActionWithParams & {
+  __actionName: 'BRICK_VIDEO_SEEK'
+  params?: Array<
+    | {
+        input: 'seekTime'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'play'
+        value?: boolean | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Pause the video */
+export type BrickVideoActionPause = Action & {
+  __actionName: 'BRICK_VIDEO_PAUSE'
+}
+
+/* Replay the video */
+export type BrickVideoActionReplay = Action & {
+  __actionName: 'BRICK_VIDEO_REPLAY'
+}
+
+/* Stop the video */
+export type BrickVideoActionStop = Action & {
+  __actionName: 'BRICK_VIDEO_STOP'
+}
+
+interface BrickVideoDef {
+  /*
+Default property:
+{
+  "paused": false,
+  "volume": 100,
+  "muted": false,
+  "progressUpdateInterval": 1000,
+  "replayTimeout": 500,
+  "renderMode": "auto"
+}
+  */
+  property?: BrickBasicProperty & {
+    /* The video path list or single path (File, URL) */
+    path?:
+      | string
+      | DataLink
+      | DataLink
+      | {
+          url?: string | DataLink
+        }
+      | Array<
+          | DataLink
+          | {
+              url?: string | DataLink
+            }
+          | string
+          | DataLink
+          | DataLink
+        >
+      | DataLink
+      | DataLink
+    /* The checksum of file */
+    md5?: string | DataLink
+    /* Controls whether the video is paused */
+    paused?: boolean | DataLink
+    /* Volume */
+    volume?: number | DataLink
+    /* Muted */
+    muted?: boolean | DataLink
+    /* Video resize mode */
+    resizeMode?: 'contain' | 'cover' | 'stretch' | DataLink
+    /* Repeat the video path list */
+    repeat?: boolean | DataLink
+    /* Progress Update Interval */
+    progressUpdateInterval?: number | DataLink
+    /* Replay on playing error */
+    replayOnError?: boolean | DataLink
+    /* Timeout to replay if repeat or replayOnError is true and video is end or error */
+    replayTimeout?: number | DataLink
+    /* Use what view type for render video (Auto / Texture or Surface).  Notice: Although using surface has better performance, it also affects the Animation & Standby Transition used by itself */
+    renderMode?: 'auto' | 'texture' | 'surface' | DataLink
+  }
+  events?: BrickBasicEvents & {
+    /* Event of the brick press */
+    onPress?: Array<EventAction>
+    /* Event of the brick press in */
+    onPressIn?: Array<EventAction>
+    /* Event of the brick press out */
+    onPressOut?: Array<EventAction>
+    /* Event of the brick long press */
+    onLongPress?: Array<EventAction>
+    /* Event of the brick focus (Use TV Device with controller) */
+    onFocus?: Array<EventAction>
+    /* Event of the brick blur (Use TV Device with controller) */
+    onBlur?: Array<EventAction>
+    /* Event of the next video on change start */
+    nextVideo?: Array<EventAction>
+    /* Event on plays of path are totally end */
+    roundEnd?: Array<EventAction>
+    /* Event on video load */
+    onLoad?: Array<EventAction>
+    /* Event of the video playing error */
+    onError?: Array<EventAction>
+    /* Event of the video progress interval */
+    onProgress?: Array<EventAction>
+  }
+  outlets?: {
+    /* Brick is pressing */
+    brickPressing?: () => Data
+    /* Brick is focusing (Use TV Device with controller) */
+    brickFocusing?: () => Data
+  }
+  animation?: AnimationBasicEvents & {
+    onPress?: Animation
+    onPressIn?: Animation
+    onPressOut?: Animation
+    onLongPress?: Animation
+    onFocus?: Animation
+    onBlur?: Animation
+    nextVideo?: Animation
+    roundEnd?: Animation
+    onLoad?: Animation
+    onError?: Animation
+    onProgress?: Animation
+  }
+}
+
+/* Video brick ([Tutorial](https://intercom.help/bricks-dag-inc/articles/5378577-video)) */
+export type BrickVideo = Brick &
+  BrickVideoDef & {
+    templateKey: 'BRICK_VIDEO'
+    switches: Array<
+      SwitchDef &
+        BrickVideoDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'brickPressing' | 'brickFocusing'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/bricks/VideoStreaming.ts

@@ -0,0 +1,107 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type { Animation, AnimationBasicEvents } from '../animation'
+import type {
+  Brick,
+  EventAction,
+  EventActionForItem,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+import type { BrickBasicProperty, BrickBasicEvents, BrickBasicEventsForItem } from '../brick-base'
+
+interface BrickVideoStreamingDef {
+  /*
+Default property:
+{
+  "networkCaching": 300,
+  "paused": false,
+  "volume": 100,
+  "muted": false,
+  "replayTimeout": 500
+}
+  */
+  property?: BrickBasicProperty & {
+    /* The video path list or single path (File, URL) */
+    uri?: string | DataLink
+    /* Set cache time from streaming (You can adjust according to network conditions), it will delay the playing. */
+    networkCaching?: number | DataLink
+    /* Controls whether the video is paused */
+    paused?: boolean | DataLink
+    /* Volume */
+    volume?: number | DataLink
+    /* Muted */
+    muted?: boolean | DataLink
+    /* Video Auto Aspect Ratio */
+    autoAspectRatio?: boolean | DataLink
+    /* Video Aspect Ratio */
+    aspectRatio?: string | DataLink
+    /* Repeat the video path list */
+    repeat?: boolean | DataLink
+    /* Replay on playing error */
+    replayOnError?: boolean | DataLink
+    /* Timeout to replay if repeat or replayOnError is true and video is end or error */
+    replayTimeout?: number | DataLink
+  }
+  events?: BrickBasicEvents & {
+    /* Event of the brick press */
+    onPress?: Array<EventAction>
+    /* Event of the brick press in */
+    onPressIn?: Array<EventAction>
+    /* Event of the brick press out */
+    onPressOut?: Array<EventAction>
+    /* Event of the brick long press */
+    onLongPress?: Array<EventAction>
+    /* Event of the brick focus (Use TV Device with controller) */
+    onFocus?: Array<EventAction>
+    /* Event of the brick blur (Use TV Device with controller) */
+    onBlur?: Array<EventAction>
+    /* Event on plays of path are end */
+    onEnd?: Array<EventAction>
+    /* Event on plays of path are end */
+    onLoad?: Array<EventAction>
+    /* Event of the video playing error */
+    onError?: Array<EventAction>
+  }
+  outlets?: {
+    /* Brick is pressing */
+    brickPressing?: () => Data
+    /* Brick is focusing (Use TV Device with controller) */
+    brickFocusing?: () => Data
+  }
+  animation?: AnimationBasicEvents & {
+    onPress?: Animation
+    onPressIn?: Animation
+    onPressOut?: Animation
+    onLongPress?: Animation
+    onFocus?: Animation
+    onBlur?: Animation
+    onEnd?: Animation
+    onLoad?: Animation
+    onError?: Animation
+  }
+}
+
+/* Brick video streaming component, supports RTSP / RTMP streaming. */
+export type BrickVideoStreaming = Brick &
+  BrickVideoStreamingDef & {
+    templateKey: 'BRICK_VIDEO_STREAMING'
+    switches: Array<
+      SwitchDef &
+        BrickVideoStreamingDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'brickPressing' | 'brickFocusing'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/bricks/WebRtcStream.ts

@@ -0,0 +1,60 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type { Animation, AnimationBasicEvents } from '../animation'
+import type {
+  Brick,
+  EventAction,
+  EventActionForItem,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+import type { BrickBasicProperty, BrickBasicEvents, BrickBasicEventsForItem } from '../brick-base'
+
+interface BrickWebRTCStreamDef {
+  /*
+Default property:
+{
+  "mirror": false,
+  "resizeMode": "contain",
+  "noStreamViewText": "no stream",
+  "noStreamViewTextSize": 44,
+  "noStreamViewTextColor": "#000"
+}
+  */
+  property?: BrickBasicProperty & {
+    /* Mirror video */
+    mirror?: boolean | DataLink
+    /* The stream resize mode */
+    resizeMode?: 'contain' | 'cover' | DataLink
+    /* Show text content if no stream */
+    noStreamViewText?: string | DataLink
+    /* The font size of shown text content if no stream */
+    noStreamViewTextSize?: number | DataLink
+    /* The color of shown text content if no stream */
+    noStreamViewTextColor?: string | DataLink
+  }
+}
+
+/* WebRTCStream brick */
+export type BrickWebRTCStream = Brick &
+  BrickWebRTCStreamDef & {
+    templateKey: 'BRICK_WEBRTC_STREAM'
+    switches: Array<
+      SwitchDef &
+        BrickWebRTCStreamDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: ''
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/bricks/WebView.ts

@@ -0,0 +1,157 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type { Animation, AnimationBasicEvents } from '../animation'
+import type {
+  Brick,
+  EventAction,
+  EventActionForItem,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+import type { BrickBasicProperty, BrickBasicEvents, BrickBasicEventsForItem } from '../brick-base'
+
+/* Run Javascript on the WebView */
+export type BrickWebViewActionInjectJavascript = ActionWithParams & {
+  __actionName: 'BRICK_WEBVIEW_INJECT_JAVASCRIPT'
+  params?: Array<{
+    input: 'javascriptCode'
+    value?: string | DataLink | EventProperty
+    mapping?: string
+  }>
+}
+
+/* Query selector on the WebView */
+export type BrickWebViewActionQuerySelector = ActionWithParams & {
+  __actionName: 'BRICK_WEBVIEW_QUERY_SELECTOR'
+  params?: Array<
+    | {
+        input: 'querySelector'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'expression'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Do go forward on the WebView */
+export type BrickWebViewActionGoForward = Action & {
+  __actionName: 'BRICK_WEBVIEW_GO_FORWARD'
+}
+
+/* Do go back on the webview */
+export type BrickWebViewActionGoBack = Action & {
+  __actionName: 'BRICK_WEBVIEW_GO_BACK'
+}
+
+/* Do reload on the webview */
+export type BrickWebViewActionReload = Action & {
+  __actionName: 'BRICK_WEBVIEW_RELOAD'
+}
+
+interface BrickWebViewDef {
+  /*
+Default property:
+{
+  "cropLeft": 0,
+  "cropRight": 0,
+  "cropTop": 0,
+  "cropBottom": 0,
+  "allowContentControl": true,
+  "allowFileAccess": true,
+  "domStorageEnabled": true,
+  "cacheEnabled": true,
+  "geolocationEnabled": true,
+  "thirdPartyCookiesEnabled": true,
+  "javaScriptEnabled": true
+}
+  */
+  property?: BrickBasicProperty & {
+    /* The WebView content URL */
+    url?: string | DataLink
+    /* The request headers to load content */
+    headers?: {} | DataLink
+    /* The request UserAgent */
+    userAgent?: string | DataLink
+    /* The webview content HTML (Use `url` first) */
+    html?: string | DataLink
+    /* Crop webview content left position (px) */
+    cropLeft?: number | DataLink
+    /* Crop webview content right position (px) */
+    cropRight?: number | DataLink
+    /* Crop webview content top position (px) */
+    cropTop?: number | DataLink
+    /* Crop webview content bottom position (px) */
+    cropBottom?: number | DataLink
+    /* Allow content control */
+    allowContentControl?: boolean | DataLink
+    /* List of origin strings to allow being navigated to. (Allowed all if not provided) */
+    originAllowList?: Array<string | DataLink> | DataLink
+    /* Allow file:// access */
+    allowFileAccess?: boolean | DataLink
+    /* Enable DOM Storage */
+    domStorageEnabled?: boolean | DataLink
+    /* Enable Cache */
+    cacheEnabled?: boolean | DataLink
+    /* Enable Geolocation */
+    geolocationEnabled?: boolean | DataLink
+    /* Enable Third Party Cooikies */
+    thirdPartyCookiesEnabled?: boolean | DataLink
+    /* Enable JavaScript */
+    javaScriptEnabled?: boolean | DataLink
+    /* Inject JavaScript code */
+    code?: string | DataLink
+    /* Inject JavaScript code before content loaded */
+    beforeContentLoaded?: string | DataLink
+    /* Inject JavaScript code for main frame only (only `YES` supported for Android) */
+    forMainFrameOnly?: boolean | DataLink
+    /* Inject JavaScript code before content loaded for main frame only (only `YES` supported for Android) */
+    beforeContentLoadedForMainFrameOnly?: boolean | DataLink
+  }
+  events?: BrickBasicEvents & {
+    /* Event of the WebView on load */
+    onLoad?: Array<EventAction>
+    /* Event when the WebView load fails */
+    onError?: Array<EventAction>
+    /* Event of the webview on message by `window.ReactNativeWebView.postMessage` on you're injected javascript code */
+    onMessage?: Array<EventAction>
+  }
+  outlets?: {
+    /* The result of the query selector action */
+    queryResult?: () => Data
+    /* The error of the query selector action */
+    queryError?: () => Data
+  }
+  animation?: AnimationBasicEvents & {
+    onLoad?: Animation
+    onError?: Animation
+    onMessage?: Animation
+  }
+}
+
+/* WebView brick ([Tutorial](https://intercom.help/bricks-dag-inc/articles/5378588-web-view)) */
+export type BrickWebView = Brick &
+  BrickWebViewDef & {
+    templateKey: 'BRICK_WEBVIEW'
+    switches: Array<
+      SwitchDef &
+        BrickWebViewDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'queryResult' | 'queryError'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/bricks/index.ts

@@ -0,0 +1,20 @@
+export * from './Rect'
+export * from './Text'
+export * from './TextInput'
+export * from './RichText'
+export * from './Image'
+export * from './Svg'
+export * from './Icon'
+export * from './Video'
+export * from './VideoStreaming'
+export * from './QrCode'
+export * from './Slideshow'
+export * from './Chart'
+export * from './Items'
+export * from './Lottie'
+export * from './Rive'
+export * from './WebView'
+export * from './Camera'
+export * from './WebRtcStream'
+export * from './3DViewer'
+export * from './GenerativeMedia'

package/types/common.ts

@@ -39,7 +39,7 @@ export type SubpsaceAction = string
 export type Action = {
   __actionName: string
   parent: 'Brick' | 'Generator' | 'Subspace' | 'System'
-  name: string
+  name?: string
 }
 
 // Find correct key in bricks-project/utils/event-props for EventAction
@@ -65,7 +65,7 @@ export type ItemBrickID = string
 
 export type EventAction = {
   handler: 'system' | (() => Brick | Generator) | SubspaceID | ItemBrickID
-  action: Action
+  action: ActionWithParams | ActionWithDataParams
   waitAsync?: boolean
 }
 
@@ -82,7 +82,7 @@ export type EventActionForItem = {
 export type ApplicationFont = {
   name: string
   url: string
-  md5: string
+  md5?: string
 }
 
 export type ApplicationSettings = {
@@ -115,6 +115,11 @@ export type ApplicationSettings = {
       borderBottomRightRadius?: number
     }
   }
+  ai?: {
+    useAnthropicApiKeySystemData?: boolean
+    useOpenAiApiKeySystemData?: boolean
+    useGeminiApiKeySystemData?: boolean
+  }
 }
 
 export type Application = {

package/types/data.ts

@@ -56,6 +56,11 @@ export type Data<T = any> = DataDef & {
           | 'rich-text-content'
           | 'sandbox-script'
           | 'llm-prompt'
+          | 'llm-messages'
+          | 'llm-tools'
+          | 'mcp-server-resources'
+          | 'mcp-server-tools'
+          | 'mcp-server-prompts'
       }
   value: T
 }
@@ -67,6 +72,7 @@ export type DataAssetKind = {
     | 'media-resource-audio'
     | 'media-resource-file'
     | 'lottie-file-uri'
+    | 'rive-file-uri'
     | 'ggml-model-asset'
     | 'gguf-model-asset'
     | 'binary-asset'

package/types/generators/AlarmClock.ts

@@ -0,0 +1,102 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+/* Start the alarm clock */
+export type GeneratorAlarmClockActionStart = Action & {
+  __actionName: 'GENERATOR_ALARM_CLOCK_START'
+}
+
+/* Pause the alarm clock */
+export type GeneratorAlarmClockActionPause = Action & {
+  __actionName: 'GENERATOR_ALARM_CLOCK_PAUSE'
+}
+
+interface GeneratorAlarmClockDef {
+  /*
+Default property:
+{
+  "init": false,
+  "timezone": "UTC",
+  "cron": "* * * * *",
+  "min": "",
+  "hour": "",
+  "dom": "",
+  "mon": "",
+  "dow": ""
+}
+  */
+  property?: {
+    /* Start alarm clock on generator initialized */
+    init?: boolean | DataLink
+    /* Timezone */
+    timezone?: string | DataLink
+    /* Max count of alarm clock trigs */
+    maxTrigs?: number | DataLink
+    /* Time to start alarm clock */
+    startAt?: string | DataLink | string | DataLink | DataLink
+    /* Time to end alarm clock (Empty for not end) */
+    stopAt?: string | DataLink | string | DataLink | DataLink
+    /* Setting trigger rule by cron tab (Ref: https://crontab.guru/) */
+    cron?: string | DataLink
+    /* minute */
+    min?: string | DataLink
+    /* hour */
+    hour?: string | DataLink
+    /* day (month) */
+    dom?: string | DataLink
+    /* month */
+    mon?: string | DataLink
+    /* day (week) */
+    dow?: string | DataLink
+  }
+  events?: {
+    /* Event for cron rule is not invalid */
+    onRuleInvalid?: Array<EventAction>
+    /* Event for alarm clock start */
+    onStart?: Array<EventAction>
+    /* Event for alarm clock trig */
+    onTrig?: Array<EventAction>
+    /* Event for alarm clock stop */
+    onEnd?: Array<EventAction>
+  }
+  outlets?: {
+    /* Current time of each alarm clock trig */
+    trigTime?: () => Data
+    /* Current timestamp (unix time) of each alarm clock trig */
+    trigTimestamp?: () => Data
+    /* Count of alarm clock trigs */
+    trigCount?: () => Data
+    /* Is alarm clock running? */
+    running?: () => Data
+  }
+}
+
+/* Execute event by cron tab */
+export type GeneratorAlarmClock = Generator &
+  GeneratorAlarmClockDef & {
+    templateKey: 'GENERATOR_ALARM_CLOCK'
+    switches: Array<
+      SwitchDef &
+        GeneratorAlarmClockDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'trigTime' | 'trigTimestamp' | 'trigCount' | 'running'
+                  value: any
+                }
+          }>
+        }
+    >
+  }