@fugood/bricks-project 2.22.0-beta.27 → 2.22.0-beta.28

package/types/bricks/Chart.ts

@@ -0,0 +1,362 @@
+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'
+
+/* Data highlight */
+export type BrickChartActionDataHighlight = ActionWithParams & {
+  __actionName: 'BRICK_CHART_DATA_HIGHLIGHT'
+  params?: Array<
+    | {
+        input: 'seriesName'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'seriesId'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'seriesIndex'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'dataIndex'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'name'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Data downplay */
+export type BrickChartActionDataDownplay = ActionWithParams & {
+  __actionName: 'BRICK_CHART_DATA_DOWNPLAY'
+  params?: Array<
+    | {
+        input: 'seriesName'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'seriesId'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'seriesIndex'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'dataIndex'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'name'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Data select */
+export type BrickChartActionDataSelect = ActionWithParams & {
+  __actionName: 'BRICK_CHART_DATA_SELECT'
+  params?: Array<
+    | {
+        input: 'seriesName'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'seriesId'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'seriesIndex'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'dataIndex'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'name'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Data unselect */
+export type BrickChartActionDataUnselect = ActionWithParams & {
+  __actionName: 'BRICK_CHART_DATA_UNSELECT'
+  params?: Array<
+    | {
+        input: 'seriesName'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'seriesId'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'seriesIndex'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'dataIndex'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'name'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Data toggle select */
+export type BrickChartActionDataToggleSelect = ActionWithParams & {
+  __actionName: 'BRICK_CHART_DATA_TOGGLE_SELECT'
+  params?: Array<
+    | {
+        input: 'seriesName'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'seriesId'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'seriesIndex'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'dataIndex'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'name'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Legend select */
+export type BrickChartActionLegendSelect = ActionWithParams & {
+  __actionName: 'BRICK_CHART_LEGEND_SELECT'
+  params?: Array<{
+    input: 'name'
+    value?: string | DataLink | EventProperty
+    mapping?: string
+  }>
+}
+
+/* Legend unselect */
+export type BrickChartActionLegendUnselect = ActionWithParams & {
+  __actionName: 'BRICK_CHART_LEGEND_UNSELECT'
+  params?: Array<{
+    input: 'name'
+    value?: string | DataLink | EventProperty
+    mapping?: string
+  }>
+}
+
+/* Legend toggle select */
+export type BrickChartActionLegendToggleSelect = Action & {
+  __actionName: 'BRICK_CHART_LEGEND_TOGGLE_SELECT'
+}
+
+/* Legend all select */
+export type BrickChartActionLegendAllSelect = Action & {
+  __actionName: 'BRICK_CHART_LEGEND_ALL_SELECT'
+}
+
+/* Legend inverse select */
+export type BrickChartActionLegendInverseSelect = Action & {
+  __actionName: 'BRICK_CHART_LEGEND_INVERSE_SELECT'
+}
+
+/* Tooltip show */
+export type BrickChartActionTooltipShow = ActionWithParams & {
+  __actionName: 'BRICK_CHART_TOOLTIP_SHOW'
+  params?: Array<
+    | {
+        input: 'seriesIndex'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'dataIndex'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'name'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Tooltip hide */
+export type BrickChartActionTooltipHide = ActionWithParams & {
+  __actionName: 'BRICK_CHART_TOOLTIP_HIDE'
+  params?: Array<
+    | {
+        input: 'seriesIndex'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'dataIndex'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'name'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+interface BrickChartDef {
+  /*
+Default property:
+{
+  "legendShow": true,
+  "xAxisShow": true,
+  "xAxisType": "category",
+  "yAxisShow": true,
+  "yAxisType": "value",
+  "tooltipShow": true,
+  "tooltipTrigger": "item"
+}
+  */
+  property?: BrickBasicProperty & {
+    /* Theme. You can use https://echarts.apache.org/en/theme-builder.html to generate theme */
+    themeEntry?: {} | DataLink
+    /* Theme of URL (.json) */
+    themeUrl?: string | DataLink
+    /* Theme of MD5 */
+    themeMd5?: string | DataLink
+    /* Title text */
+    titleText?: string | DataLink
+    /* Subtitle text */
+    titleSubtext?: string | DataLink
+    /* Full configuration of title, see https://echarts.apache.org/en/option.html#title */
+    titleOptions?: {} | DataLink
+    /* Show legend */
+    legendShow?: boolean | DataLink
+    /* Legend data */
+    legendData?: Array<string | DataLink> | DataLink
+    /* Full configuration of legend, see https://echarts.apache.org/en/option.html#legend */
+    legendOptions?: {} | DataLink
+    /* Show grid */
+    gridShow?: boolean | DataLink
+    /* Full configuration of grid, see https://echarts.apache.org/en/option.html#grid */
+    gridOptions?: {} | DataLink
+    /* Dataset (see https://echarts.apache.org/en/option.html#dataset) */
+    dataset?: Array<any> | DataLink
+    /* Show x axis */
+    xAxisShow?: boolean | DataLink
+    /* Type of x axis */
+    xAxisType?: 'category' | 'value' | 'time' | 'log' | DataLink
+    /* Name of x axis */
+    xAxisName?: string | DataLink
+    /* Data of x axis */
+    xAxisData?: Array<string | DataLink> | DataLink
+    /* Full configuration of x axis, see https://echarts.apache.org/en/option.html#xAxis */
+    xAxisOptions?: {} | DataLink
+    /* Show y axis */
+    yAxisShow?: boolean | DataLink
+    /* Type of x axis */
+    yAxisType?: 'value' | 'category' | 'time' | 'log' | DataLink
+    /* Name of x axis */
+    yAxisName?: string | DataLink
+    /* Data of y axis */
+    yAxisData?: Array<string | DataLink> | DataLink
+    /* Full configuration of y axis, see https://echarts.apache.org/en/option.html#yAxis */
+    yAxisOptions?: {} | DataLink
+    /* Show axis pointer */
+    axisPointerShow?: boolean | DataLink
+    /* Full configuration of axis pointer, see https://echarts.apache.org/en/option.html#axisPointer */
+    axisPointerOptions?: {} | DataLink
+    /* data series (see https://echarts.apache.org/en/option.html#series-line) */
+    series?: Array<any> | DataLink
+    /* Show tooltip */
+    tooltipShow?: boolean | DataLink
+    /* Trigger type of tooltip */
+    tooltipTrigger?: 'item' | 'axis' | 'none' | DataLink
+    /* data series (see https://echarts.apache.org/en/option.html#tooltip) */
+    tooltipOptions?: {} | DataLink
+    /* Full configuration of options, see https://echarts.apache.org/en/option.html */
+    options?: {} | DataLink
+  }
+  events?: BrickBasicEvents & {
+    /* Event of chart render */
+    onRender?: Array<EventAction>
+    /* Event of data point on press */
+    onPress?: Array<EventAction>
+    /* Event of legend select changed */
+    onLegendSelectChanged?: Array<EventAction>
+  }
+  animation?: AnimationBasicEvents & {
+    onRender?: Animation
+    onPress?: Animation
+    onLegendSelectChanged?: Animation
+  }
+}
+
+/* Chart brick, based on [Apache ECharts](https://echarts.apache.org/en/index.html). */
+export type BrickChart = Brick &
+  BrickChartDef & {
+    templateKey: 'BRICK_CHART'
+    switches: Array<
+      SwitchDef &
+        BrickChartDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: ''
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/bricks/GenerativeMedia.ts

@@ -0,0 +1,237 @@
+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 GenerativeMediaDef {
+  /*
+Default property:
+{
+  "enableCache": true,
+  "type": "image",
+  "resizeMode": "cover",
+  "provider": "openai",
+  "freepikClassicImageSize": "square_1_1"
+}
+  */
+  property?: BrickBasicProperty & {
+    /* The text prompt to generate media from */
+    prompt?: string | DataLink
+    /* Enable cache */
+    enableCache?: boolean | DataLink
+    /* The type of media to generate (image or video) */
+    type?: 'image' | 'video' | DataLink
+    /* Default image to display when no generated image is available */
+    defaultImage?: string | DataLink
+    /* The hash of the default image */
+    defaultImageHash?: string | DataLink
+    /* The type of the default image hash */
+    defaultImageHashType?: 'md5' | 'sha1' | 'sha256' | DataLink
+    /* The Lottie animation to show while generating */
+    loadingAnimation?: string | DataLink
+    /* The Lottie animation to show when an error occurs */
+    errorAnimation?: string | DataLink
+    /* The resize mode for the generated media */
+    resizeMode?: 'contain' | 'cover' | 'stretch' | 'center' | 'repeat' | DataLink
+    /* The API key for the generative media service */
+    apiKey?: string | DataLink
+    /* The AI provider to use for generation (openai, freepik, or deepai) */
+    provider?: 'openai' | 'freepik-classic' | 'deepai' | DataLink
+    /* OpenAI image size (256x256, 512x512, 1024x1024, etc) */
+    openaiSize?: '1024x1024' | '1024x1792' | '1792x1024' | DataLink
+    /* OpenAI image style (vivid or natural) */
+    openaiStyle?: 'vivid' | 'natural' | DataLink
+    /* OpenAI image quality (standard or hd) */
+    openaiQuality?: 'standard' | 'hd' | DataLink
+    /* Freepik image size */
+    freepikClassicImageSize?:
+      | 'square_1_1'
+      | 'classic_4_3'
+      | 'traditional_3_4'
+      | 'widescreen_16_9'
+      | 'social_story_9_16'
+      | 'smartphone_horizontal_20_9'
+      | 'smartphone_vertical_9_20'
+      | 'standard_3_2'
+      | 'portrait_2_3'
+      | 'horizontal_2_1'
+      | 'vertical_1_2'
+      | 'social_5_4'
+      | 'social_post_4_5'
+      | DataLink
+    /* Freepik image style */
+    freepikClassicStyle?:
+      | 'photo'
+      | 'digital-art'
+      | '3d'
+      | 'painting'
+      | 'low-poly'
+      | 'pixel-art'
+      | 'anime'
+      | 'cyberpunk'
+      | 'comic'
+      | 'vintage'
+      | 'cartoon'
+      | 'vector'
+      | 'studio-shot'
+      | 'dark'
+      | 'sketch'
+      | 'mockup'
+      | '2000s-pone'
+      | '70s-vibe'
+      | 'watercolor'
+      | 'art-nouveau'
+      | 'origami'
+      | 'surreal'
+      | 'fantasy'
+      | 'traditional-japan'
+      | DataLink
+    /* Freepik color scheme */
+    freepikClassicStyleColor?:
+      | 'b&w'
+      | 'pastel'
+      | 'sepia'
+      | 'dramatic'
+      | 'vibrant'
+      | 'orange&teal'
+      | 'film-filter'
+      | 'split'
+      | 'electric'
+      | 'pastel-pink'
+      | 'gold-glow'
+      | 'autumn'
+      | 'muted-green'
+      | 'deep-teal'
+      | 'duotone'
+      | 'terracotta&teal'
+      | 'red&blue'
+      | 'cold-neon'
+      | 'burgundy&blue'
+      | DataLink
+    /* Freepik lighting style */
+    freepikClassicStyleLighting?:
+      | 'studio'
+      | 'warm'
+      | 'cinematic'
+      | 'volumetric'
+      | 'golden-hour'
+      | 'long-exposure'
+      | 'cold'
+      | 'iridescent'
+      | 'dramatic'
+      | 'hardlight'
+      | 'redscale'
+      | 'indoor-light'
+      | DataLink
+    /* Freepik framing style */
+    freepikClassicStyleFraming?:
+      | 'portrait'
+      | 'macro'
+      | 'panoramic'
+      | 'aerial-view'
+      | 'close-up'
+      | 'cinematic'
+      | 'high-angle'
+      | 'low-angle'
+      | 'symmetry'
+      | 'fish-eye'
+      | 'first-person'
+      | DataLink
+    /* Freepik guidance scale (level of fidelity to prompt) */
+    freepikClassicGuidanceScale?: number | DataLink
+    /* Freepik negative prompt (attributes to avoid) */
+    freepikClassicNegativePrompt?: string | DataLink
+    /* DeepAI negative prompt (attributes to avoid) */
+    deepaiNegativePrompt?: string | DataLink
+    /* DeepAI image generator version */
+    deepaiImageGeneratorVersion?: 'standard' | 'hd' | DataLink
+    /* DeepAI output image width */
+    deepaiWidth?: number | DataLink
+    /* DeepAI output image height */
+    deepaiHeight?: number | DataLink
+  }
+  events?: BrickBasicEvents & {
+    /* Event of the brick press */
+    generativeMediaOnPress?: Array<EventAction>
+    /* Event of the brick press in */
+    generativeMediaOnPressIn?: Array<EventAction>
+    /* Event of the brick press out */
+    generativeMediaOnPressOut?: Array<EventAction>
+    /* Event of the brick focus (Use TV Device with controller) */
+    generativeMediaOnFocus?: Array<EventAction>
+    /* Event of the brick blur (Use TV Device with controller) */
+    generativeMediaOnBlur?: Array<EventAction>
+    /* Event when media generation succeeds */
+    onSuccess?: Array<EventAction>
+    /* Event when media generation fails */
+    onError?: Array<EventAction>
+    /* Event when media prompt request starts */
+    promptStart?: Array<EventAction>
+    /* Event when media prompt request succeeds */
+    promptSuccess?: Array<EventAction>
+    /* Event when media prompt request fails */
+    promptError?: Array<EventAction>
+    /* Event when media loading starts */
+    loadStart?: Array<EventAction>
+    /* Event when media loading succeeds */
+    loadSuccess?: Array<EventAction>
+    /* Event when media loading fails */
+    loadError?: Array<EventAction>
+  }
+  outlets?: {
+    /* Brick is pressing */
+    brickPressing?: () => Data
+    /* Brick is focusing (Use TV Device with controller) */
+    brickFocusing?: () => Data
+    /* Generated media URL */
+    url?: () => Data
+    /* Generated media error */
+    error?: () => Data
+  }
+  animation?: AnimationBasicEvents & {
+    generativeMediaOnPress?: Animation
+    generativeMediaOnPressIn?: Animation
+    generativeMediaOnPressOut?: Animation
+    generativeMediaOnFocus?: Animation
+    generativeMediaOnBlur?: Animation
+    onSuccess?: Animation
+    onError?: Animation
+    promptStart?: Animation
+    promptSuccess?: Animation
+    promptError?: Animation
+    loadStart?: Animation
+    loadSuccess?: Animation
+    loadError?: Animation
+  }
+}
+
+/* Generative Media brick - Generate images and videos using AI */
+export type GenerativeMedia = Brick &
+  GenerativeMediaDef & {
+    templateKey: 'BRICK_GENERATIVE_MEDIA'
+    switches: Array<
+      SwitchDef &
+        GenerativeMediaDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'brickPressing' | 'brickFocusing' | 'url' | 'error'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/bricks/Icon.ts

@@ -0,0 +1,90 @@
+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 BrickIconDef {
+  /*
+Default property:
+{}
+  */
+  property?: BrickBasicProperty & {
+    /* Select icon */
+    icon?:
+      | DataLink
+      | {
+          type?:
+            | 'solid'
+            | 'regular'
+            | 'light'
+            | 'duotone'
+            | 'thin'
+            | 'brands'
+            | 'sharpSolid'
+            | 'sharpLight'
+            | 'sharpRegular'
+            | DataLink
+          name?: string | DataLink
+        }
+    /* Icon main color */
+    color?: string | DataLink
+    /* Icon secondary color (For Duotone type) */
+    secondaryColor?: string | 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 focus (Use TV Device with controller) */
+    onFocus?: Array<EventAction>
+    /* Event of the brick blur (Use TV Device with controller) */
+    onBlur?: 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
+    onFocus?: Animation
+    onBlur?: Animation
+  }
+}
+
+/* Icon brick */
+export type BrickIcon = Brick &
+  BrickIconDef & {
+    templateKey: 'BRICK_ICON'
+    switches: Array<
+      SwitchDef &
+        BrickIconDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'brickPressing' | 'brickFocusing'
+                  value: any
+                }
+          }>
+        }
+    >
+  }