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

package/types/bricks/GenerativeMedia.ts

@@ -0,0 +1,240 @@
+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 long press */
+    generativeMediaOnLongPress?: 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
+    generativeMediaOnLongPress?: 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,93 @@
+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 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>
+  }
+  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
+  }
+}
+
+/* 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
+                }
+          }>
+        }
+    >
+  }

package/types/bricks/Image.ts

@@ -0,0 +1,104 @@
+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 BrickImageDef {
+  /*
+Default property:
+{
+  "path": "",
+  "fadeDuration": 0,
+  "blurBackgroundRadius": 8,
+  "loadSystemIos": "auto",
+  "loadSystemAndroid": "auto"
+}
+  */
+  property?: BrickBasicProperty & {
+    /* The image resize mode */
+    resizeMode?: 'contain' | 'cover' | 'stretch' | 'center' | 'repeat' | DataLink
+    /* The image file path (File, URL) */
+    path?: string | DataLink
+    /* The checksum of file */
+    md5?: string | DataLink
+    /* The image fade duration */
+    fadeDuration?: number | DataLink
+    /* The image avatar mode */
+    avatar?: boolean | DataLink
+    /* The image fixed width with `avatar` */
+    width?: number | DataLink
+    /* Add blurred image at background if photo is not full */
+    enableBlurBackground?: boolean | DataLink
+    /* The blur radius of the blur filter added to the image background */
+    blurBackgroundRadius?: number | DataLink
+    /* [iOS] The use priority of image loading system (Auto: sdwebimage, fallback to default if failed) */
+    loadSystemIos?: 'auto' | 'sdwebimage' | 'default' | DataLink
+    /* [Android] The use priority of image loading system (Auto: glide, fallback to fresco if failed) */
+    loadSystemAndroid?: 'auto' | 'glide' | 'fresco' | 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 image on load */
+    onLoad?: Array<EventAction>
+    /* Event of the image on 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
+    onLoad?: Animation
+    onError?: Animation
+  }
+}
+
+/* Image brick ([Tutorial](https://intercom.help/bricks-dag-inc/articles/5378576-image)) */
+export type BrickImage = Brick &
+  BrickImageDef & {
+    templateKey: 'BRICK_IMAGE'
+    switches: Array<
+      SwitchDef &
+        BrickImageDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'brickPressing' | 'brickFocusing'
+                  value: any
+                }
+          }>
+        }
+    >
+  }