@fugood/bricks-project 2.21.0-beta.14.test0

package/types/canvas.ts

@@ -0,0 +1,78 @@
+import { Easing } from './animation'
+import { Data, DataLink } from './data'
+import { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from './switch'
+import { 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's background color */
+    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
+  title: string
+  description?: string
+  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
+    }
+  }>
+}

package/types/common.ts

@@ -0,0 +1,116 @@
+import { SwitchDef } from './switch'
+import { Data } from './data'
+import { Subspace } from './subspace'
+
+export interface Brick {
+  __typename: 'Brick'
+  id: string
+  templateKey: string
+  title: string
+  description: string
+  property?: {}
+  events: {}
+  outlets?: {}
+  animation?: {}
+  switches: Array<SwitchDef>
+}
+
+export enum LocalSyncStrategy {
+  mainOnly = 'main-only',
+  minorOnly = 'minor-only',
+}
+
+export interface Generator {
+  __typename: 'Generator'
+  id: string
+  templateKey: string
+  title: string
+  description: string
+  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
+}
+
+export type ActionWithParams = Action & {
+  params?: Array<{
+    input: string
+    value?: any
+    mapping?: boolean
+  }>
+}
+
+export type ActionWithDataParams = Action & {
+  dataParams?: Array<{
+    input: () => Data
+    value?: any
+    mapping?: boolean
+  }>
+}
+
+export type ItemBrickID = string
+
+export type EventAction = {
+  handler: 'system' | (() => Brick | Generator) | SubspaceID | ItemBrickID
+  action: Action
+  waitAsync?: boolean
+  // Event Property Definition mapping to params (use path to replace)
+  eventPropertyMapping?: object
+}
+
+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
+    }
+  },
+}
+
+export type Application = {
+  name: string
+  description?: string
+  subspaces: Subspace[]
+  rootSubspace: Subspace
+  fonts?: ApplicationFont[]
+  settings?: ApplicationSettings
+}