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

package/types/generators/MediaFlow.ts

@@ -0,0 +1,142 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+/* Start fetcn Media box file list */
+export type GeneratorMediaFlowActionFetch = Action & {
+  __actionName: 'GENERATOR_MEDIA_FLOW_FETCH'
+}
+
+/* Reset cache */
+export type GeneratorMediaFlowActionResetCache = Action & {
+  __actionName: 'GENERATOR_MEDIA_FLOW_RESET_CACHE'
+}
+
+/* Abort current fetch request of media list */
+export type GeneratorMediaFlowActionAbortFetch = Action & {
+  __actionName: 'GENERATOR_MEDIA_FLOW_ABORT_FETCH'
+}
+
+interface GeneratorMediaFlowDef {
+  /*
+Default property:
+{
+  "includeTypes": [
+    "IMAGE",
+    "VIDEO",
+    "AUDIO",
+    "FILE"
+  ],
+  "fetchPolicy": "cache-first",
+  "subscribeBoxChange": false,
+  "saveToStorageDownloadMode": "sequence",
+  "loadSizeLimit": "",
+  "allowLoadSizeLimitExceed": true,
+  "source": "original",
+  "sourceVersionAlternatives": []
+}
+  */
+  property?: {
+    /* The box id of Media Flow */
+    boxId?: string | DataLink
+    /* Authorize accessToken,    use `passcode` if `accessToken` is empty */
+    accessToken?: string | DataLink
+    /* Authorize passcode */
+    passcode?: string | DataLink
+    /* Include File Types */
+    includeTypes?: Array<'IMAGE' | 'VIDEO' | 'AUDIO' | 'FILE' | DataLink> | DataLink
+    /* Determine the cache behavior  
+  
+ cache-first: Cache first if existing, then fetch from network  
+ network-and-cache: Fetch from network, then save cache  
+ network-only: Fetch from network only */
+    fetchPolicy?: 'cache-first' | 'network-and-cache' | 'network-only' | DataLink
+    /* Subscribe box change to refresh file list (file deleted / new file uploaded) */
+    subscribeBoxChange?: boolean | DataLink
+    /* Save files into local file storage */
+    saveToStorage?: boolean | DataLink
+    /* Concurrent download files or sequence for saveToStorage */
+    saveToStorageDownloadMode?: 'sequence' | 'concurrent' | DataLink
+    /* Limit the load size (* GB, * MB, * KB) */
+    loadSizeLimit?: string | DataLink
+    /* Allow Load size limit exceed, just call event */
+    allowLoadSizeLimitExceed?: boolean | DataLink
+    /* Select download source */
+    source?:
+      | 'original'
+      | 'auto'
+      | 'converted'
+      | 'video-thumbnail-original'
+      | 'use-source-versions'
+      | DataLink
+    /* Select download source with image version (use width, e.g. [250, 360]) */
+    sourceVersionAlternatives?: Array<number | DataLink> | DataLink
+    /* Allowlist patterns to filter media files (supports regex or plain text) */
+    allowlist?: Array<string | DataLink> | DataLink
+    /* Blocklist patterns to filter media files (supports regex or plain text) */
+    blocklist?: Array<string | DataLink> | DataLink
+  }
+  events?: {
+    /* Event of media box fetch error */
+    fetchError?: Array<EventAction>
+    /* Event of subscribe box change connected (If set `Subscribe Box Change`) */
+    subscribeBoxConnect?: Array<EventAction>
+    /* Event of subscribe box change error (If set `Subscribe Box Change`) */
+    subscribeBoxError?: Array<EventAction>
+    /* Event of subscribe box change connection error (If set `Subscribe Box Change`) */
+    subscribeBoxConnectError?: Array<EventAction>
+    /* Event of file sync completed for used `saveToStorage` */
+    saveStorageCompleted?: Array<EventAction>
+    /* Event when file list size exceed of Load size limit */
+    fileSizeExceed?: Array<EventAction>
+  }
+  outlets?: {
+    /* File sync status */
+    downloadStatus?: () => Data
+    /* File sync progress */
+    downloadProgress?: () => Data
+    /* File sync download errors */
+    downloadErrors?: () => Data
+    /* Media box info */
+    box?: () => Data
+    /* Save Media Flow fetch result   [     {       "url": "https://d1kk0369g9vrck.cloudfront.net/box/5b431e29efd40c01e8b2019c/photo5b431e37efd40c01e8b201d1"       "extension": "", // enum("jpg", "png", "mp4")       "id": "5b431e37efd40c01e8b201d1",       "md5": "6134ab412351651324" // md5 came from media resource api     }   ] */
+    result?: () => Data
+    /* File sync result    [      {        "url": "/storage/emulated/0/Download/SyncFolder/Asset/1.png",        "mediaType": "photo" // enum("photo", "video"), used to distingiush        "id": "",      }    ] */
+    downloadFileUrls?: () => Data
+  }
+}
+
+/* Fetch box's file list from Media Flow */
+export type GeneratorMediaFlow = Generator &
+  GeneratorMediaFlowDef & {
+    templateKey: 'GENERATOR_MEDIA_FLOW'
+    switches: Array<
+      SwitchDef &
+        GeneratorMediaFlowDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet:
+                    | 'downloadStatus'
+                    | 'downloadProgress'
+                    | 'downloadErrors'
+                    | 'box'
+                    | 'result'
+                    | 'downloadFileUrls'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/generators/MqttClient.ts

@@ -0,0 +1,129 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+/* Connect to MQTT broker */
+export type GeneratorMQTTActionConnect = Action & {
+  __actionName: 'GENERATOR_MQTT_CONNECT'
+}
+
+/* Disconnect from MQTT broker */
+export type GeneratorMQTTActionDisconnect = Action & {
+  __actionName: 'GENERATOR_MQTT_DISCONNECT'
+}
+
+/* Send message to MQTT broker */
+export type GeneratorMQTTActionPublish = ActionWithParams & {
+  __actionName: 'GENERATOR_MQTT_PUBLISH'
+  params?: Array<
+    | {
+        input: 'topic'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'payload'
+        value?: any | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'qos'
+        value?: '0' | '1' | '2' | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'retain'
+        value?: boolean | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+interface GeneratorMQTTDef {
+  /*
+Default property:
+{
+  "init": false,
+  "auth": false,
+  "autoReconnect": true,
+  "autoReconnectAttemptTime": 1000,
+  "qos": "0",
+  "messageType": "text"
+}
+  */
+  property?: {
+    /* Auto connect when generator start */
+    init?: boolean | DataLink
+    /* Broker endpoint (mqtt://) */
+    uri?: string | DataLink
+    /* Broker need auth or not, if set false will ignore username and password setting */
+    auth?: boolean | DataLink
+    /* Username */
+    username?: string | DataLink
+    /* Password */
+    password?: string | DataLink
+    /* Client ID */
+    clientId?: string | DataLink
+    /* Second */
+    keepAlive?: number | DataLink
+    /* If true, BRICKS will auto reconnect when connection lose */
+    autoReconnect?: boolean | DataLink
+    /* How many times BRICKS will try to reconnect */
+    autoReconnectAttemptTime?: number | DataLink
+    /* Topic name to subscribe */
+    topic?: string | DataLink
+    /* Setting the mode of quality of service mode */
+    qos?: '0' | '1' | '2' | DataLink
+    /* If set to text the outlet and event property will be string, if set to json will parse to object */
+    messageType?: 'text' | 'json' | DataLink
+  }
+  events?: {
+    /* When connected to MQTT broker */
+    onConnected?: Array<EventAction>
+    /* When disconnected from MQTT broker */
+    onDisconnected?: Array<EventAction>
+    /* When error occurred */
+    onError?: Array<EventAction>
+    /* When received message from MQTT broker within subscribe topic */
+    onMessage?: Array<EventAction>
+  }
+  outlets?: {
+    /* Connected or not */
+    connected?: () => Data
+    /* Error Message */
+    error?: () => Data
+    /* The receive message */
+    message?: () => Data
+    /* The receive message (payload only) */
+    messagePayload?: () => Data
+  }
+}
+
+/* MQTT protocol messaging */
+export type GeneratorMQTT = Generator &
+  GeneratorMQTTDef & {
+    templateKey: 'GENERATOR_MQTT'
+    switches: Array<
+      SwitchDef &
+        GeneratorMQTTDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'connected' | 'error' | 'message' | 'messagePayload'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/generators/Question.ts

@@ -0,0 +1,395 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+/* Start inquire */
+export type GeneratorQuestionActionStart = Action & {
+  __actionName: 'GENERATOR_QUESTION_START'
+}
+
+/* Stop inquire */
+export type GeneratorQuestionActionStop = Action & {
+  __actionName: 'GENERATOR_QUESTION_STOP'
+}
+
+/* Pause inquire */
+export type GeneratorQuestionActionPause = Action & {
+  __actionName: 'GENERATOR_QUESTION_PAUSE'
+}
+
+interface GeneratorQuestionDef {
+  /*
+Default property:
+{
+  "modalMode": "root",
+  "showClose": true,
+  "showBack": true,
+  "cameraType": "back",
+  "cameraPosition": "top",
+  "selectColumns": 3,
+  "selectAutoColumns": true,
+  "sizeFactor": 1,
+  "containerBackgroundColor": "#ffffff",
+  "titleColor": "#000000",
+  "descriptionColor": "#2e2e2e",
+  "fieldBackgroundColor": "#E2E2E2",
+  "fieldTextColor": "#1e1e1e",
+  "fieldPlaceholderColor": "#333333",
+  "fieldActiveBackgroundColor": "#FDCB8F",
+  "fieldActiveTextColor": "#7D7D7D",
+  "fieldControlColor": "#f08400",
+  "primaryControlBtnBackgroundColor": "#1e1e1e",
+  "primaryControlBtnTextColor": "#ffffff",
+  "primaryControlBtnBorderColor": "#1e1e1e",
+  "secondaryControlBtnBackgroundColor": "#ffffff",
+  "secondaryControlBtnTextColor": "#1e1e1e",
+  "secondaryControlBtnBorderColor": "#1e1e1e",
+  "warnColor": "#ff4f00",
+  "errorColor": "#ff0000"
+}
+  */
+  property?: {
+    /* Modal mode */
+    modalMode?: 'root' | 'in-subspace' | DataLink
+    /* Inquirer schema  
+ `key`: Field key (unique, required)  
+ `kind`: Field type (required)  
+ `title`: Field or message title  
+ `description`: Field or message description  
+ `required`: Whether the field is required  
+ `defaultValue`: Default value of the field  
+ `[kind]Options`: Field configuration  
+ `condition`: Condition to show field */
+    schema?:
+      | Array<
+          | DataLink
+          | {
+              key?: string | DataLink
+              title?: string | DataLink
+              description?: string | DataLink
+              kind?:
+                | 'language'
+                | 'number'
+                | 'numeric-string'
+                | 'text'
+                | 'phone'
+                | 'email'
+                | 'color'
+                | 'uri'
+                | 'select'
+                | 'multi-select'
+                | 'yesno'
+                | 'qty-list'
+                | 'cart'
+                | 'preference'
+                | 'voice-record'
+                | 'video-record'
+                | 'code-scan'
+                | 'message'
+                | DataLink
+              required?: boolean | DataLink
+              defaultValue?:
+                | string
+                | DataLink
+                | number
+                | DataLink
+                | boolean
+                | DataLink
+                | Array<string | DataLink>
+                | DataLink
+                | DataLink
+              languageOptions?:
+                | DataLink
+                | {
+                    availableLangs?: Array<string | DataLink> | DataLink
+                  }
+              numberOptions?:
+                | DataLink
+                | {
+                    min?: number | DataLink
+                    max?: number | DataLink
+                    step?: number | DataLink
+                  }
+              textOptions?:
+                | DataLink
+                | {
+                    placeholder?: string | DataLink
+                  }
+              phoneOptions?:
+                | DataLink
+                | {
+                    placeholder?: string | DataLink
+                    usePhysicalKeyboard?: boolean | DataLink
+                  }
+              emailOptions?:
+                | DataLink
+                | {
+                    placeholder?: string | DataLink
+                  }
+              uriOptions?:
+                | DataLink
+                | {
+                    placeholder?: string | DataLink
+                  }
+              selectOptions?:
+                | DataLink
+                | {
+                    withConfirmButton?: boolean | DataLink
+                    options?:
+                      | Array<
+                          | DataLink
+                          | {
+                              value?: string | DataLink
+                              image_uri?: string | DataLink
+                              label?: string | DataLink
+                              icon?: string | DataLink
+                            }
+                        >
+                      | DataLink
+                  }
+              multiSelectOptions?:
+                | DataLink
+                | {
+                    options?:
+                      | Array<
+                          | DataLink
+                          | {
+                              value?: string | DataLink
+                              image_uri?: string | DataLink
+                              label?: string | DataLink
+                              icon?: string | DataLink
+                            }
+                        >
+                      | DataLink
+                    minimum?: number | DataLink
+                    maximum?: number | DataLink
+                  }
+              yesnoOptions?:
+                | DataLink
+                | {
+                    imageUri?: string | DataLink
+                    withConfirmButton?: boolean | DataLink
+                    yesBtnText?: string | DataLink
+                    noBtnText?: string | DataLink
+                  }
+              qtyListOptions?:
+                | DataLink
+                | {
+                    items?:
+                      | Array<
+                          | DataLink
+                          | {
+                              id?: string | DataLink
+                              title?: string | DataLink
+                              description?: string | DataLink
+                              imageUri?: string | DataLink
+                              price?: number | DataLink
+                            }
+                        >
+                      | DataLink
+                  }
+              cartOptions?:
+                | DataLink
+                | {
+                    items?:
+                      | Array<
+                          | DataLink
+                          | {
+                              id?: string | DataLink
+                              title?: string | DataLink
+                              description?: string | DataLink
+                              imageUri?: string | DataLink
+                              price?: number | DataLink
+                              qty?: number | DataLink
+                            }
+                        >
+                      | DataLink
+                  }
+              preferenceOptions?:
+                | DataLink
+                | {
+                    settings?:
+                      | Array<
+                          | DataLink
+                          | {
+                              key?: string | DataLink
+                              title?: string | DataLink
+                              options?:
+                                | Array<
+                                    | DataLink
+                                    | {
+                                        label?: string | DataLink
+                                        value?: string | DataLink
+                                      }
+                                  >
+                                | DataLink
+                              multiple?: boolean | DataLink
+                              required?: boolean | DataLink
+                              maximum?: number | DataLink
+                              minimum?: number | DataLink
+                            }
+                        >
+                      | DataLink
+                  }
+              voiceRecordOptions?:
+                | DataLink
+                | {
+                    sampleRate?: number | DataLink
+                    bitDepth?: '8bit' | '16bit' | DataLink
+                    channels?: 'mono' | 'stereo' | DataLink
+                    maxDuration?: number | DataLink
+                  }
+              videoRecordOptions?:
+                | DataLink
+                | {
+                    manuallyStart?: boolean | DataLink
+                    recordDuration?: number | DataLink
+                  }
+              messageOptions?:
+                | DataLink
+                | {
+                    symbol?: 'success' | DataLink
+                    duration?: number | DataLink
+                  }
+              condition?:
+                | DataLink
+                | {
+                    key?: string | DataLink
+                    operator?:
+                      | 'eq'
+                      | 'neq'
+                      | 'contains'
+                      | 'notContains'
+                      | 'isTrue'
+                      | 'isFalse'
+                      | DataLink
+                    value?: string | DataLink
+                  }
+            }
+        >
+      | DataLink
+    /* Display language (RFC 3066) */
+    displayLang?: string | DataLink
+    /* Banner image */
+    bannerImage?: string | DataLink
+    /* Banner image md5 */
+    bannerImageMd5?: string | DataLink
+    /* Show AI transcribe tip on the bottom of the modal */
+    aiTranscribeTip?: boolean | DataLink
+    /* Show close button */
+    showClose?: boolean | DataLink
+    /* Show back button */
+    showBack?: boolean | DataLink
+    /* Camera type */
+    cameraType?: 'front' | 'back' | DataLink
+    /* Camera position */
+    cameraPosition?: 'top' | 'left' | 'bottom' | 'right' | DataLink
+    /* "Next" button text */
+    nextButtonText?: string | DataLink
+    /* "Skip" button text */
+    skipButtonText?: string | DataLink
+    /* "Done" button text */
+    doneButtonText?: string | DataLink
+    /* Select columns */
+    selectColumns?: number | DataLink
+    /* Select auto calculate columns */
+    selectAutoColumns?: boolean | DataLink
+    /* Fixed model width, default is auto */
+    fixedModelWidth?: number | DataLink
+    /* Fixed model height, default is auto */
+    fixedModelHeight?: number | DataLink
+    /* Size factor */
+    sizeFactor?: number | DataLink
+    /* Background color */
+    backgroundColor?: string | DataLink
+    /* Container background color */
+    containerBackgroundColor?: string | DataLink
+    /* Title color */
+    titleColor?: string | DataLink
+    /* Description color */
+    descriptionColor?: string | DataLink
+    /* Input field background color */
+    fieldBackgroundColor?: string | DataLink
+    /* Input field text color */
+    fieldTextColor?: string | DataLink
+    /* Input field placeholder color */
+    fieldPlaceholderColor?: string | DataLink
+    /* Selected option background color */
+    fieldActiveBackgroundColor?: string | DataLink
+    /* Selected option text color */
+    fieldActiveTextColor?: string | DataLink
+    /* Field control button color */
+    fieldControlColor?: string | DataLink
+    /* Primary control button background color */
+    primaryControlBtnBackgroundColor?: string | DataLink
+    /* Primary control button text color */
+    primaryControlBtnTextColor?: string | DataLink
+    /* Primary control button border color */
+    primaryControlBtnBorderColor?: string | DataLink
+    /* Secondary control button background color */
+    secondaryControlBtnBackgroundColor?: string | DataLink
+    /* Secondary control button text color */
+    secondaryControlBtnTextColor?: string | DataLink
+    /* Secondary control button border color */
+    secondaryControlBtnBorderColor?: string | DataLink
+    /* Warn color */
+    warnColor?: string | DataLink
+    /* Error color */
+    errorColor?: string | DataLink
+  }
+  events?: {
+    /* Event of go next */
+    onNextQuestion?: Array<EventAction>
+    /* Event of go back */
+    onBackQuestion?: Array<EventAction>
+    /* Event of change question */
+    onQuestionChange?: Array<EventAction>
+    /* Event of user close question modal */
+    onClose?: Array<EventAction>
+    /* Event of warning showed */
+    onWarning?: Array<EventAction>
+    /* Event of completed inquire */
+    onCompleted?: Array<EventAction>
+    /* Event of error occured */
+    onError?: Array<EventAction>
+  }
+  outlets?: {
+    /* Result data */
+    data?: () => Data
+    /* Currnet question */
+    currectKey?: () => Data
+    /* Currnet input value */
+    currectValue?: () => Data
+    /* Error message */
+    errorMessage?: () => Data
+  }
+}
+
+/* Question inquirer */
+export type GeneratorQuestion = Generator &
+  GeneratorQuestionDef & {
+    templateKey: 'GENERATOR_QUESTION'
+    switches: Array<
+      SwitchDef &
+        GeneratorQuestionDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'data' | 'currectKey' | 'currectValue' | 'errorMessage'
+                  value: any
+                }
+          }>
+        }
+    >
+  }