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

package/types/bricks/Camera.ts

@@ -0,0 +1,195 @@
+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'
+
+/* Take picture on the Camera */
+export type BrickCameraActionTakePicture = ActionWithParams & {
+  __actionName: 'BRICK_CAMERA_TAKE_PICTURE'
+  params?: Array<
+    | {
+        input: 'width'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'quality'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'base64'
+        value?: boolean | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'mirrorImage'
+        value?: boolean | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Record video on the Camera */
+export type BrickCameraActionRecord = ActionWithParams & {
+  __actionName: 'BRICK_CAMERA_RECORD'
+  params?: Array<
+    | {
+        input: 'quality'
+        value?: '4:3' | '288p' | '480p' | '720p' | '1080p' | '2160p' | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'mirrorVideo'
+        value?: boolean | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'videoBitrate'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'maxDuration'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'maxFileSize'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Record video on the Camera */
+export type BrickCameraActionStopRecord = Action & {
+  __actionName: 'BRICK_CAMERA_STOP_RECORD'
+}
+
+interface BrickCameraDef {
+  /*
+Default property:
+{
+  "autoFocusEnabled": false,
+  "focusDepth": 0.5,
+  "type": "back",
+  "flashMode": "off",
+  "captureAudio": false,
+  "whiteBalance": "auto",
+  "faceDetectionEnabled": false,
+  "faceDetectionEventMode": "when-detected"
+}
+  */
+  property?: BrickBasicProperty & {
+    /* Camera auto focus */
+    autoFocusEnabled?: boolean | DataLink
+    /* The auto focus feature of the camera to attempt to focus on the part of the image at this coordinate. */
+    focusDepth?: number | DataLink
+    /* Camera type (Ignore it if you are using external camera) */
+    type?: 'back' | 'front' | DataLink
+    /* Camera zoom */
+    zoom?: number | DataLink
+    /* Camera flash mode */
+    flashMode?: 'off' | 'on' | 'torch' | 'auto' | DataLink
+    /* Camera ratio (Unsupported ratio will be ignored) */
+    ratio?: string | DataLink
+    /* Capture audio when start recording */
+    captureAudio?: boolean | DataLink
+    /* Allows you to control the color temperature in your photos by cooling down or warming up the colors. */
+    whiteBalance?:
+      | 'auto'
+      | 'sunny'
+      | 'cloudy'
+      | 'shadow'
+      | 'incandescent'
+      | 'fluorescent'
+      | DataLink
+    /* Enable face detection */
+    faceDetectionEnabled?: boolean | DataLink
+    /* Face detection event mode */
+    faceDetectionEventMode?: 'when-detected' | 'interval' | DataLink
+    /* Quality of take picture */
+    pictureQuality?: number | DataLink
+    /* Take picture format as base64 */
+    pictureBase64?: boolean | DataLink
+    /* Mirror image of take picture */
+    pictureIsMirrorImage?: boolean | DataLink
+    /* Quality of record video */
+    recordQuality?: '4:3' | '288p' | '480p' | '720p' | '1080p' | '2160p' | DataLink
+    /* Bitrate of record video (bit/s) */
+    recordVideoBitrate?: number | DataLink
+    /* Mirror video of record video */
+    recordMirrorVideo?: boolean | DataLink
+    /* Max duration of record video (s) */
+    recordMaxDuration?: number | DataLink
+    /* Max file size of record video (bytes) */
+    recordMaxFileSize?: number | DataLink
+  }
+  events?: BrickBasicEvents & {
+    /* Event of the Camera state change */
+    stateChange?: Array<EventAction>
+    /* Event of the Camera record start */
+    recordStart?: Array<EventAction>
+    /* Event of the Camera record end */
+    recordEnd?: Array<EventAction>
+    /* Event of the Camera barcode read */
+    barcodeRead?: Array<EventAction>
+    /* Event of the Camera picture taken */
+    pictureTaken?: Array<EventAction>
+    /* Event of the Camera record finished */
+    recordFinish?: Array<EventAction>
+    /* Event of the Camera mount error */
+    mountError?: Array<EventAction>
+  }
+  outlets?: {
+    /* Picture taken result */
+    pictureTaken?: () => Data
+    /* Record video result */
+    recordVideo?: () => Data
+    /* Barcode read result */
+    barcodeRead?: () => Data
+    /* Faces detected result */
+    faceDetected?: () => Data
+  }
+  animation?: AnimationBasicEvents & {
+    stateChange?: Animation
+    recordStart?: Animation
+    recordEnd?: Animation
+    barcodeRead?: Animation
+    pictureTaken?: Animation
+    recordFinish?: Animation
+    mountError?: Animation
+  }
+}
+
+/* Camera view brick ([Tutorial](https://intercom.help/bricks-dag-inc/articles/5378589-camera)) */
+export type BrickCamera = Brick &
+  BrickCameraDef & {
+    templateKey: 'BRICK_CAMERA'
+    switches: Array<
+      SwitchDef &
+        BrickCameraDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'pictureTaken' | 'recordVideo' | 'barcodeRead' | 'faceDetected'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

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
+                }
+          }>
+        }
+    >
+  }