@fugood/bricks-ctor 2.24.0-beta.40

package/types/bricks/WebRtcStream.ts

@@ -0,0 +1,65 @@
+/* Auto generated by build script
+ *
+ * Display WebRTC video/audio stream from a WebRTC generator connection
+ */
+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'
+import type { TemplateEventPropsMap } from '../../utils/event-props'
+
+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
+  }
+}
+
+/* Display WebRTC video/audio stream from a WebRTC generator connection */
+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,168 @@
+/* Auto generated by build script
+ *
+ * Embedded web browser with JS injection, DOM query selectors, content cropping, navigation control, and permission management
+ */
+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'
+import type { TemplateEventPropsMap } from '../../utils/event-props'
+
+/* 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,
+  "scrollEnabled": true,
+  "nestedScrollEnabled": true
+}
+  */
+  property?: BrickBasicProperty & {
+    /* The WebView content URL */
+    url?: string | DataLink
+    /* The request headers to load content */
+    headers?: Record<string, string | DataLink> | 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 Cookies */
+    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
+    /* Enable scroll in WebView */
+    scrollEnabled?: boolean | DataLink
+    /* Enable nested scroll in WebView (Android only) */
+    nestedScrollEnabled?: boolean | DataLink
+  }
+  events?: BrickBasicEvents & {
+    /* Event of the WebView on load */
+    onLoad?: Array<EventAction<string & keyof TemplateEventPropsMap['Webview']['onLoad']>>
+    /* Event when the WebView load fails */
+    onError?: Array<EventAction<string & keyof TemplateEventPropsMap['Webview']['onError']>>
+    /* Event of the webview on message by `window.ReactNativeWebView.postMessage` on you're injected javascript code */
+    onMessage?: Array<EventAction<string & keyof TemplateEventPropsMap['Webview']['onMessage']>>
+  }
+  outlets?: {
+    /* The result of the query selector action */
+    queryResult?: () => Data<any>
+    /* The error of the query selector action */
+    queryError?: () => Data<string>
+  }
+  animation?: AnimationBasicEvents & {
+    onLoad?: Animation
+    onError?: Animation
+    onMessage?: Animation
+  }
+}
+
+/* Embedded web browser with JS injection, DOM query selectors, content cropping, navigation control, and permission management */
+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,21 @@
+/* Auto generated by build script */
+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 './GenerativeMedia'
+export * from './Maps'

package/types/canvas.ts

@@ -0,0 +1,82 @@
+/* Auto generated by build script */
+import type { Easing } from './animation'
+import type { Data, DataLink } from './data'
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from './switch'
+import type { Brick, SubspaceID, EventAction } from './common'
+
+type StandbyEasing = {
+  method: Easing
+  duration: number
+}
+
+interface CanvasDef {
+  property?: {
+    /* The showing timeout of Canvas, need to set `Next Canvas ID` as well */
+    showingTimeout?: number | DataLink
+    /* Canvas ID for change next canvas on showing timeout */
+    nextCanvasId?: string | DataLink | (() => Canvas)
+    /* Background color of Canvas */
+    backgroundColor?: string | DataLink
+    /* Dismiss keyboard on press */
+    dismissKeyboardOnPress?: boolean | DataLink
+  }
+  events?: {
+    /* Event on Canvas first enter on Subspace */
+    firstEnter?: Array<EventAction>
+    /* Event on Canvas enter */
+    enter?: Array<EventAction>
+    /* Showing timeout event (If `Showing Timeout` is specified) */
+    showingTimeout?: Array<EventAction>
+    /* Event on Canvas exit */
+    exit?: Array<EventAction>
+  }
+}
+
+/* View renderer in subspace. */
+export type Canvas = CanvasDef & {
+  __typename: 'Canvas'
+  id: string
+  alias?: string
+  title?: string
+  description?: string
+  hideShortRef?: boolean
+  switches?: Array<
+    SwitchDef &
+      CanvasDef & {
+        conds?: Array<{
+          method: '==' | '!=' | '>' | '<' | '>=' | '<='
+          cond: SwitchCondInnerStateCurrentCanvas | SwitchCondData
+        }>
+      }
+  >
+  items: Array<{
+    item: (() => Brick) | SubspaceID
+    frame: {
+      x: number
+      y: number
+      width: number
+      height: number
+      standbyMode?: 'custom' | 'top' | 'left' | 'right' | 'bottom'
+      standbyFrame?: {
+        x?: number
+        y?: number
+        width?: number
+        height?: number
+      }
+      standbyOpacity?: number
+      standbyDelay?: number
+      standbyDelayRandom?: number
+      standbyEasing?: {
+        default?: StandbyEasing
+        x?: StandbyEasing
+        y?: StandbyEasing
+        width?: StandbyEasing
+        height?: StandbyEasing
+        opacity?: StandbyEasing
+      }
+      showingDelay?: number
+      renderOutOfViewport?: boolean
+    }
+    hidden?: boolean // Hide in Editor
+  }>
+}

package/types/common.ts

@@ -0,0 +1,144 @@
+import type { SwitchDef } from './switch'
+import type { Data } from './data'
+import type { Subspace } from './subspace'
+import type { AutomationMap } from './automation'
+
+export interface Brick {
+  __typename: 'Brick'
+  id: string
+  alias?: string
+  templateKey: string
+  title?: string
+  description?: string
+  hideShortRef?: boolean
+  property?: {}
+  events: {}
+  outlets?: {}
+  animation?: {}
+  switches?: Array<SwitchDef>
+}
+
+export enum LocalSyncStrategy {
+  mainOnly = 'main-only',
+  minorOnly = 'minor-only',
+}
+
+export interface Generator {
+  __typename: 'Generator'
+  id: string
+  alias?: string
+  templateKey: string
+  title?: string
+  description?: string
+  hideShortRef?: boolean
+  localSyncRunMode?: LocalSyncStrategy
+  property?: {}
+  events: {}
+  outlets?: {}
+  switches?: Array<SwitchDef>
+}
+
+export type SubspaceID = string
+export type SubpsaceAction = string
+
+export type Action = {
+  __actionName: string
+  parent: 'Brick' | 'Generator' | 'Subspace' | 'System'
+  name?: string
+}
+
+// For standalone action types where specific event properties are not known
+export type EventProperty = string
+
+export type ActionWithParams<EP extends string = string> = Action & {
+  params?: Array<{
+    input: string
+    value?: any | EP
+    mapping?: string
+  }>
+}
+
+export type ActionWithDataParams<EP extends string = string> = Action & {
+  dataParams?: Array<{
+    input: () => Data
+    value?: any | EP
+    mapping?: string
+  }>
+}
+
+export type ItemBrickID = string
+
+// EP carries available event property keys for this event context
+// Use: EventAction<string & keyof TemplateEventPropsMap['Name']['event']>
+export type EventAction<EP extends string = string> = {
+  handler: 'system' | (() => Brick | Generator) | SubspaceID | ItemBrickID
+  action: ActionWithParams<EP> | ActionWithDataParams<EP>
+  waitAsync?: boolean
+}
+
+export type EventActionForItem<EP extends string = string> = {
+  handler:
+    | 'system'
+    | (() => Brick | Generator | { brickId: string; templateKey: string })
+    | SubspaceID
+    | ItemBrickID
+  action: Action
+  waitAsync?: boolean
+}
+
+export type ApplicationFont = {
+  name: string
+  url: string
+  md5?: string
+}
+
+export type ApplicationSettings = {
+  internetReachabilityUrl?: string
+  enableDataLock?: boolean
+  showDeprecatedFeatures?: boolean
+  enableUnstableFeatures?: boolean // enable_unstable_bricks
+  runtimeCacheOptions?: {
+    disabled?: boolean
+    behavior?: 'initiative' | 'passive'
+    retryAttemptForFailure?: number
+  }
+  tvOptions?: {
+    disabledSelectable?: boolean
+    selectableColor?: string
+    selectableBorder?: {
+      borderStyle?: 'solid' | 'dashed' | 'dotted'
+      borderTopColor?: string
+      borderLeftColor?: string
+      borderRightColor?: string
+      borderBottomColor?: string
+      // BRICK Grid unit
+      borderTopSize?: number
+      borderLeftSize?: number
+      borderRightSize?: number
+      borderBottomSize?: number
+      borderTopLeftRadius?: number
+      borderTopRightRadius?: number
+      borderBottomLeftRadius?: number
+      borderBottomRightRadius?: number
+    }
+  }
+  ai?: {
+    useAnthropicApiKeySystemData?: boolean
+    useOpenAiApiKeySystemData?: boolean
+    useGeminiApiKeySystemData?: boolean
+  }
+  hideShortRefs?: boolean
+}
+
+export type Application = {
+  name: string
+  description?: string
+  subspaces: Subspace[]
+  rootSubspace: Subspace
+  fonts?: ApplicationFont[]
+  settings?: ApplicationSettings
+  automationMap?: AutomationMap
+  metadata?: {
+    [key: string]: any
+  }
+}