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

package/types/bricks/Slideshow.ts

@@ -0,0 +1,155 @@
+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'
+
+/* Jump to a specific index in the slideshow */
+export type BrickSlideshowActionJumpToIndex = ActionWithParams & {
+  __actionName: 'BRICK_SLIDESHOW_JUMP_TO_INDEX'
+  params?: Array<
+    | {
+        input: 'index'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'reset'
+        value?: boolean | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'shuffle'
+        value?: boolean | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+interface BrickSlideshowDef {
+  /*
+Default property:
+{
+  "countdown": 2000,
+  "loop": true,
+  "shuffle": false,
+  "videoVolume": 100,
+  "emptyViewText": "no available image item to show",
+  "emptyViewTextSize": 44,
+  "emptyViewTextColor": "#fff",
+  "blurBackgroundRadius": 8
+}
+  */
+  property?: BrickBasicProperty & {
+    /* The time interval of show for each photo */
+    countdown?: number | DataLink
+    /* The slideshow media path list (File, URL) */
+    paths?:
+      | Array<
+          | DataLink
+          | {
+              url?: string | DataLink
+              mediaType?: 'video' | 'video-streaming' | 'photo' | DataLink
+              photoResizeMode?: 'contain' | 'cover' | 'stretch' | 'center' | 'repeat' | DataLink
+              photoLoadSystemIos?: 'auto' | 'sdwebimage' | 'default' | DataLink
+              photoLoadSystemAndroid?: 'auto' | 'glide' | 'fresco' | DataLink
+              videoResizeMode?: 'contain' | 'cover' | 'stretch' | DataLink
+              videoAutoAspectRatio?: boolean | DataLink
+              videoAspectRatio?: string | DataLink
+              videoVolume?: number | DataLink
+              videoMuted?: boolean | DataLink
+              videoRenderMode?: 'auto' | 'texture' | 'surface' | DataLink
+            }
+        >
+      | DataLink
+    /* Multiple slideshow media path lists to combine (Array of path arrays) */
+    pathsList?: Array<Array<any> | DataLink | DataLink> | DataLink
+    /* Loop the slideshow */
+    loop?: boolean | DataLink
+    /* Shuffle the slideshow */
+    shuffle?: boolean | DataLink
+    /* Slideshow Photo resize mode */
+    photoResizeMode?: 'contain' | 'cover' | 'stretch' | 'center' | 'repeat' | DataLink
+    /* [iOS] The use priority of image loading system (Auto: sdwebimage, fallback to default if failed) */
+    photoLoadSystemIos?: 'auto' | 'sdwebimage' | 'default' | DataLink
+    /* [Android] The use priority of image loading system (Auto: glide, fallback to fresco if failed) */
+    photoLoadSystemAndroid?: 'auto' | 'glide' | 'fresco' | DataLink
+    /* Slideshow Video resize mode */
+    videoResizeMode?: 'contain' | 'cover' | 'stretch' | DataLink
+    /* Video Auto Aspect Ratio for use Video Streaming */
+    videoAutoAspectRatio?: boolean | DataLink
+    /* Video Aspect Ratio for use Video Streaming */
+    videoAspectRatio?: string | DataLink
+    /* Video Volume */
+    videoVolume?: number | DataLink
+    /* Video Muted */
+    videoMuted?: boolean | DataLink
+    /* [Android only] 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 */
+    videoRenderMode?: 'auto' | 'texture' | 'surface' | DataLink
+    /* The photo fade duration */
+    fadeDuration?: number | DataLink
+    /* Show text content if path list is empty */
+    emptyViewText?: string | DataLink
+    /* The font size of shown text content if path list is empty */
+    emptyViewTextSize?: number | DataLink
+    /* The color of shown text content if path list is empty */
+    emptyViewTextColor?: string | DataLink
+    /* Show emptyViewText when timeout and paths is empty */
+    emptyViewTimeout?: number | DataLink
+    /* The blur radius of the blur filter added to the image */
+    blurRadius?: 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
+  }
+  events?: BrickBasicEvents & {
+    /* Event of the next slideshow on change start */
+    changeStart?: Array<EventAction>
+    /* Event of the next slideshow on change end */
+    changeEnd?: Array<EventAction>
+    /* Event on paths change */
+    contentChange?: Array<EventAction>
+    /* Event on plays of paths are end */
+    roundEnd?: Array<EventAction>
+    /* Event of the slideshow on load */
+    mediaOnLoad?: Array<EventAction>
+  }
+  animation?: AnimationBasicEvents & {
+    changeStart?: Animation
+    changeEnd?: Animation
+    contentChange?: Animation
+    roundEnd?: Animation
+    mediaOnLoad?: Animation
+  }
+}
+
+/* Slideshow brick ([Tutorial](https://intercom.help/bricks-dag-inc/articles/5378580-slideshow)) */
+export type BrickSlideshow = Brick &
+  BrickSlideshowDef & {
+    templateKey: 'BRICK_SLIDESHOW'
+    switches: Array<
+      SwitchDef &
+        BrickSlideshowDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: ''
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/bricks/Svg.ts

@@ -0,0 +1,94 @@
+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 BrickSvgDef {
+  /*
+Default property:
+{
+  "source": "",
+  "uri": "",
+  "renderMode": "general"
+}
+  */
+  property?: BrickBasicProperty & {
+    /* The SVG XML content */
+    source?: string | DataLink
+    /* The svg source location (URL or LocalPath) */
+    uri?: string | DataLink
+    /* The checksum of file */
+    md5?: string | DataLink
+    /* The rules of replacing origin colour */
+    colorMapping?:
+      | Array<
+          | DataLink
+          | {
+              findItem?: string | DataLink
+              replaceItem?: string | DataLink
+            }
+        >
+      | DataLink
+    /* The render mode */
+    renderMode?: 'general' | 'legacy' | 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
+  }
+}
+
+/* SVG is an XML-based vector image format for 2D graphics */
+export type BrickSvg = Brick &
+  BrickSvgDef & {
+    templateKey: 'BRICK_SVG'
+    switches: Array<
+      SwitchDef &
+        BrickSvgDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'brickPressing' | 'brickFocusing'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/bricks/Text.ts

@@ -0,0 +1,143 @@
+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 BrickTextDef {
+  /*
+Default property:
+{
+  "text": "",
+  "templateType": "${}",
+  "color": "#000",
+  "fontWeight": "normal",
+  "fontStyle": "normal",
+  "fontPadding": true,
+  "fontSizeVector": 0.5,
+  "lineNumber": 1,
+  "textAlign": "center",
+  "textAlignVertical": "center"
+}
+  */
+  property?: BrickBasicProperty & {
+    /* The text content */
+    text?: string | DataLink | number | DataLink | boolean | DataLink | string | DataLink | DataLink
+    /* Data to be used in the text template (e.g. `Hello ${name}`). Supports nested data, such as `Hello ${user.name}`. */
+    templateData?: {} | DataLink
+    /* The text template type */
+    templateType?: '${}' | '{{}}' | DataLink
+    /* The text replacement (Regular Expression), can be multiple. */
+    replace?:
+      | Array<
+          | DataLink
+          | {
+              regex?: string | DataLink
+              replaceWith?: string | DataLink
+            }
+        >
+      | DataLink
+    /* The text color */
+    color?: string | DataLink
+    /* Specifies font weight.  The values 'normal' and are supported for most fonts.  Not all fonts have a variant for each of the numeric values,  in that case the closest one is chosen. */
+    fontWeight?:
+      | 'normal'
+      | 'bold'
+      | '100'
+      | '200'
+      | '300'
+      | '400'
+      | '500'
+      | '600'
+      | '700'
+      | '800'
+      | '900'
+      | DataLink
+    /* The text font style */
+    fontStyle?: 'normal' | 'italic' | DataLink
+    /* The text font family */
+    fontFamily?: string | DataLink
+    /* [Android only] Set to No to remove extra font padding intended to make space for certain ascenders / descenders. */
+    fontPadding?: boolean | DataLink
+    /* The text font size (grid) */
+    fontSize?: number | DataLink
+    /* The text font size vector. If the font size is not specified, the font size will be calculated by the height of the text box. */
+    fontSizeVector?: number | DataLink
+    /* The text letter spacing (grid) */
+    letterSpacing?: number | DataLink
+    /* The line height of text content (grid) */
+    lineHeight?: number | DataLink
+    /* The line number limit of text content */
+    lineNumber?: number | DataLink
+    /* The text align */
+    textAlign?: 'auto' | 'left' | 'right' | 'center' | 'justify' | DataLink
+    /* The text align vertical */
+    textAlignVertical?: 'auto' | 'top' | 'bottom' | 'center' | DataLink
+    /* Enable vertical rendering */
+    verticalRendering?: boolean | 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 text content on change start */
+    beforeValueChange?: Array<EventAction>
+    /* Event of the text content on change end */
+    valueChange?: 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
+    beforeValueChange?: Animation
+    valueChange?: Animation
+  }
+}
+
+/* Text brick ([Tutorial](https://intercom.help/bricks-dag-inc/articles/5378574-text)) */
+export type BrickText = Brick &
+  BrickTextDef & {
+    templateKey: 'BRICK_TEXT'
+    switches: Array<
+      SwitchDef &
+        BrickTextDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'brickPressing' | 'brickFocusing'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/bricks/TextInput.ts

@@ -0,0 +1,231 @@
+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'
+
+/* Focus TextInput */
+export type BrickTextInputActionFocus = Action & {
+  __actionName: 'BRICK_TEXT_INPUT_FOCUS'
+}
+
+/* Blur TextInput */
+export type BrickTextInputActionBlur = Action & {
+  __actionName: 'BRICK_TEXT_INPUT_BLUR'
+}
+
+/* Clear TextInput */
+export type BrickTextInputActionClear = Action & {
+  __actionName: 'BRICK_TEXT_INPUT_CLEAR'
+}
+
+/* Reset TextInput to default value */
+export type BrickTextInputActionResetToDefault = Action & {
+  __actionName: 'BRICK_TEXT_INPUT_RESET_TO_DEFAULT'
+}
+
+/* Focus the input and select text with regex or start/end */
+export type BrickTextInputActionSelectText = ActionWithParams & {
+  __actionName: 'BRICK_TEXT_INPUT_SELECT_TEXT'
+  params?: Array<
+    | {
+        input: 'regex'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'start'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'end'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Set text value of the TextInput */
+export type BrickTextInputActionSetText = ActionWithParams & {
+  __actionName: 'BRICK_TEXT_INPUT_SET_TEXT'
+  params?: Array<{
+    input: 'text'
+    value?: string | DataLink | EventProperty
+    mapping?: string
+  }>
+}
+
+/* Append text value of the TextInput */
+export type BrickTextInputActionAppendText = ActionWithParams & {
+  __actionName: 'BRICK_TEXT_INPUT_APPEND_TEXT'
+  params?: Array<{
+    input: 'text'
+    value?: string | DataLink | EventProperty
+    mapping?: string
+  }>
+}
+
+/* Trigger regex */
+export type BrickTextInputActionTrySubmit = Action & {
+  __actionName: 'BRICK_TEXT_INPUT_TRY_SUBMIT'
+}
+
+interface BrickTextInputDef {
+  /*
+Default property:
+{
+  "editable": true,
+  "defaultValue": "",
+  "color": "#000",
+  "fontWeight": "normal",
+  "fontStyle": "normal",
+  "fontSizeVector": 0.5,
+  "lineNumber": 1,
+  "textAlign": "center",
+  "textAlignVertical": "center",
+  "keyboardType": "default",
+  "returnKeyType": "done"
+}
+  */
+  property?: BrickBasicProperty & {
+    /* Allow to edit */
+    editable?: boolean | DataLink
+    /* The default value of the text input */
+    defaultValue?: string | DataLink
+    /* The text color */
+    color?: string | DataLink
+    /* Specifies font weight.  The values 'normal' and are supported for most fonts.  Not all fonts have a variant for each of the numeric values,  in that case the closest one is chosen. */
+    fontWeight?:
+      | 'normal'
+      | 'bold'
+      | '100'
+      | '200'
+      | '300'
+      | '400'
+      | '500'
+      | '600'
+      | '700'
+      | '800'
+      | '900'
+      | DataLink
+    /* The text font style */
+    fontStyle?: 'normal' | 'italic' | DataLink
+    /* The text font family */
+    fontFamily?: string | DataLink
+    /* The text font size (grid) */
+    fontSize?: number | DataLink
+    /* The text font size vector. If the font size is not specified, the font size will be calculated by the height of the text box. */
+    fontSizeVector?: number | DataLink
+    /* The text letter spacing (grid) */
+    letterSpacing?: number | DataLink
+    /* The line height of text content (grid) */
+    lineHeight?: number | DataLink
+    /* The line number limit of text content (Use 0 to unlimited) */
+    lineNumber?: number | DataLink
+    /* The text align */
+    textAlign?: 'auto' | 'left' | 'right' | 'center' | 'justify' | DataLink
+    /* The text align vertical */
+    textAlignVertical?: 'auto' | 'top' | 'bottom' | 'center' | DataLink
+    /* The placeholder text */
+    placeholder?: string | DataLink
+    /* Color of the placeholder text */
+    placeholderTextColor?: string | DataLink
+    /* Limits the maximum number of characters that can be entered */
+    maxLength?: number | DataLink
+    /* The virtual keyboard type */
+    keyboardType?:
+      | 'default'
+      | 'number-pad'
+      | 'decimal-pad'
+      | 'numeric'
+      | 'email-address'
+      | 'phone-pad'
+      | DataLink
+    /* The virtual keyboard return key type  The line number should be 1. */
+    returnKeyType?: 'done' | 'go' | 'next' | 'search' | 'send' | DataLink
+    /* Trigger event on input change after debounce time */
+    debounce?: number | DataLink
+    /* Regular Expression to match */
+    regex?: string | DataLink
+    /* The regex matching complete mode */
+    completeMode?: 'allMatch' | 'oneMatch' | DataLink
+    /* Auto submit when regex match */
+    autoSubmitWhenMatch?: boolean | DataLink
+    /* Blur TextInput on submit */
+    blurOnSubmit?: boolean | DataLink
+  }
+  events?: BrickBasicEvents & {
+    /* Event of the TextInput is focused */
+    onFocus?: Array<EventAction>
+    /* Event of the input field is blurred */
+    onBlur?: Array<EventAction>
+    /* Event of the TextInput is empty */
+    onEmpty?: Array<EventAction>
+    /* Event of the TextInput value change */
+    onChange?: Array<EventAction>
+    /* Event of the TextInput submit */
+    onSubmit?: Array<EventAction>
+    /* Event of the TextInput match regex (check every value change) */
+    onMatch?: Array<EventAction>
+    /* Event of the TextInput not match regex (check every value change) */
+    onNotMatch?: Array<EventAction>
+    /* Event of the TextInput not match regex (check every submit) */
+    onResultNotMatch?: Array<EventAction>
+    /* Event of the TextInput reach max length or match regex */
+    onFullFill?: Array<EventAction>
+  }
+  outlets?: {
+    /* The raw input */
+    rawInput?: () => Data
+    /* The regex result */
+    resultVariable?: () => Data
+    /* Last key in */
+    lastKey?: () => Data
+    /* Selection of the TextInput (start, end, text) */
+    selection?: () => Data
+    /* Selection text of the TextInput */
+    selectionText?: () => Data
+  }
+  animation?: AnimationBasicEvents & {
+    onFocus?: Animation
+    onBlur?: Animation
+    onEmpty?: Animation
+    onChange?: Animation
+    onSubmit?: Animation
+    onMatch?: Animation
+    onNotMatch?: Animation
+    onResultNotMatch?: Animation
+    onFullFill?: Animation
+  }
+}
+
+/* Text Input brick ([Tutorial](https://intercom.help/bricks-dag-inc/articles/5378575-text-input)) */
+export type BrickTextInput = Brick &
+  BrickTextInputDef & {
+    templateKey: 'BRICK_TEXT_INPUT'
+    switches: Array<
+      SwitchDef &
+        BrickTextInputDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'rawInput' | 'resultVariable' | 'lastKey' | 'selection' | 'selectionText'
+                  value: any
+                }
+          }>
+        }
+    >
+  }