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

package/types/generators/BleCentral.ts

@@ -0,0 +1,225 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+/* Start scan */
+export type GeneratorBleCentralActionStartScan = Action & {
+  __actionName: 'GENERATOR_BLE_CENTRAL_START_SCAN'
+}
+
+/* Stop scan */
+export type GeneratorBleCentralActionStopScan = Action & {
+  __actionName: 'GENERATOR_BLE_CENTRAL_STOP_SCAN'
+}
+
+/* Connect device */
+export type GeneratorBleCentralActionConnect = ActionWithParams & {
+  __actionName: 'GENERATOR_BLE_CENTRAL_CONNECT'
+  params?: Array<{
+    input: 'deviceId'
+    value?: string | DataLink | EventProperty
+    mapping?: string
+  }>
+}
+
+/* Read a characteristic */
+export type GeneratorBleCentralActionReadCharacteristic = ActionWithParams & {
+  __actionName: 'GENERATOR_BLE_CENTRAL_READ_CHARACTERISTIC'
+  params?: Array<
+    | {
+        input: 'deviceId'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'serviceId'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'characteristicId'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Monitor a characteristic */
+export type GeneratorBleCentralActionMonitorCharacteristic = ActionWithParams & {
+  __actionName: 'GENERATOR_BLE_CENTRAL_MONITOR_CHARACTERISTIC'
+  params?: Array<
+    | {
+        input: 'deviceId'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'serviceId'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'characteristicId'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Cancel monitor a characteristic */
+export type GeneratorBleCentralActionCancelMonitorCharacteristic = ActionWithParams & {
+  __actionName: 'GENERATOR_BLE_CENTRAL_CANCEL_MONITOR_CHARACTERISTIC'
+  params?: Array<
+    | {
+        input: 'deviceId'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'serviceId'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'characteristicId'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Write data to a characteristic */
+export type GeneratorBleCentralActionWriteCharacteristic = ActionWithParams & {
+  __actionName: 'GENERATOR_BLE_CENTRAL_WRITE_CHARACTERISTIC'
+  params?: Array<
+    | {
+        input: 'deviceId'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'serviceId'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'characteristicId'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'dataHex'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'writeWithoutResponse'
+        value?: boolean | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Disconnect device */
+export type GeneratorBleCentralActionDisconnect = ActionWithParams & {
+  __actionName: 'GENERATOR_BLE_CENTRAL_DISCONNECT'
+  params?: Array<{
+    input: 'deviceId'
+    value?: string | DataLink | EventProperty
+    mapping?: string
+  }>
+}
+
+interface GeneratorBleCentralDef {
+  /*
+Default property:
+{
+  "init": false,
+  "scanTime": 10,
+  "updateInterval": 1000,
+  "retainTime": 120,
+  "maximumDiscoveredDevice": 256,
+  "allowDuplicates": false,
+  "scanMode": "LowPower"
+}
+  */
+  property?: {
+    /* Start scan on generator initialized */
+    init?: boolean | DataLink
+    /* Regex match name to filter device */
+    deviceNameFilter?: string | DataLink
+    /* Service UUIDs to filter device */
+    serviceFilter?: Array<string | DataLink> | DataLink
+    /* RSSI threshold */
+    rssiThreshold?: number | DataLink
+    /* Scan time */
+    scanTime?: number | DataLink
+    /* Discovered device list update interval */
+    updateInterval?: number | DataLink
+    /* Discovered device retain time */
+    retainTime?: number | DataLink
+    /* Maximum device list number */
+    maximumDiscoveredDevice?: number | DataLink
+    /* Allow duplicates scanning records (iOS only) */
+    allowDuplicates?: boolean | DataLink
+    /* BLE scan mode (Android only) */
+    scanMode?: 'Opportunistic' | 'LowPower' | 'Balanced' | 'LowLatency' | DataLink
+  }
+  events?: {
+    /* Event for state change */
+    onStateChange?: Array<EventAction>
+    /* Event for error occurred */
+    onError?: Array<EventAction>
+    /* Event for start scan */
+    onStartScan?: Array<EventAction>
+    /* Event for stop scan */
+    onStopScan?: Array<EventAction>
+    /* Event for discover device */
+    onDiscoverDevice?: Array<EventAction>
+    /* Event for device connected */
+    onConnectDevice?: Array<EventAction>
+    /* Event for device disconnected */
+    onDisconnectDevice?: Array<EventAction>
+    /* Event for receive on read */
+    onReadReceive?: Array<EventAction>
+    /* Event for receive on monitor */
+    onMonitorReceive?: Array<EventAction>
+  }
+  outlets?: {
+    /* Is scaning */
+    isScaning?: () => Data
+    /* Discovered device list */
+    discoveredDeviceList?: () => Data
+    /* Error message */
+    errorMessage?: () => Data
+  }
+}
+
+/* BLE Central Mode Generator */
+export type GeneratorBleCentral = Generator &
+  GeneratorBleCentralDef & {
+    templateKey: 'GENERATOR_BLE_CENTRAL'
+    switches: Array<
+      SwitchDef &
+        GeneratorBleCentralDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'isScaning' | 'discoveredDeviceList' | 'errorMessage'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/generators/BlePeripheral.ts

@@ -0,0 +1,202 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+/* Start advertise */
+export type GeneratorBlePeripheralActionStart = Action & {
+  __actionName: 'GENERATOR_BLE_PERIPHERAL_START'
+}
+
+/* undefined */
+export type GeneratorBlePeripheralActionNotify = ActionWithParams & {
+  __actionName: 'GENERATOR_BLE_PERIPHERAL_NOTIFY'
+  params?: Array<
+    | {
+        input: 'serviceId'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'charId'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'value'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'encoding'
+        value?: 'utf8' | 'hex' | 'base64' | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Stop advertise */
+export type GeneratorBlePeripheralActionStop = Action & {
+  __actionName: 'GENERATOR_BLE_PERIPHERAL_STOP'
+}
+
+interface GeneratorBlePeripheralDef {
+  /*
+Default property:
+{
+  "init": false,
+  "connectable": true,
+  "advertiseMode": "LOW_POWER",
+  "txPower": "MEDIUM",
+  "includeDeviceName": true,
+  "includeTxPower": true
+}
+  */
+  property?: {
+    /* Start advertise on generator initialized */
+    init?: boolean | DataLink
+    /* Advertise device name */
+    name?: string | DataLink
+    /* BLE is connectable (Android only) */
+    connectable?: boolean | DataLink
+    /* Advertise mode (Android only) */
+    advertiseMode?: 'LOW_POWER' | 'BALANCED' | 'LOW_LATENCY' | DataLink
+    /* Bluetooth transmit power (Android only) */
+    txPower?: 'ULTRA_LOW' | 'LOW' | 'MEDIUM' | 'HIGH' | DataLink
+    /* Include device name in advertise (Android only) */
+    includeDeviceName?: boolean | DataLink
+    /* Include transmit power in advertise (Android only) */
+    includeTxPower?: boolean | DataLink
+    /* Advertise manufacturer ID (Android only) */
+    manufacturerId?: number | DataLink
+    /* Advertise manufacturer data (Android only) */
+    manufacturerData?:
+      | DataLink
+      | {
+          data?: string | DataLink
+          encode?: 'utf8' | 'hex' | 'base64' | DataLink
+        }
+    /* Advertise service data list (Android only) */
+    serviceDataMap?:
+      | Array<
+          | DataLink
+          | {
+              serviceId?: string | DataLink
+              data?: string | DataLink
+              encode?: 'utf8' | 'hex' | 'base64' | DataLink
+            }
+        >
+      | DataLink
+    /* GATT service list */
+    gattServiceMap?:
+      | Array<
+          | DataLink
+          | {
+              serviceId?: string | DataLink
+              primary?: boolean | DataLink
+              characteristics?:
+                | Array<
+                    | DataLink
+                    | {
+                        id?: string | DataLink
+                        permission?:
+                          | DataLink
+                          | {
+                              readable?: boolean | DataLink
+                              readEncrypted?: boolean | DataLink
+                              writeable?: boolean | DataLink
+                              writeEncrypted?: boolean | DataLink
+                            }
+                        properties?:
+                          | DataLink
+                          | {
+                              broadcast?: boolean | DataLink
+                              read?: boolean | DataLink
+                              writeNoResponse?: boolean | DataLink
+                              write?: boolean | DataLink
+                              notify?: boolean | DataLink
+                              indicate?: boolean | DataLink
+                              signedWrite?: boolean | DataLink
+                              extendedProps?: boolean | DataLink
+                            }
+                      }
+                  >
+                | DataLink
+            }
+        >
+      | DataLink
+    /* Response value of characteristics */
+    resData?:
+      | Array<
+          | DataLink
+          | {
+              serviceId?: string | DataLink
+              charId?: string | DataLink
+              value?: string | DataLink
+              encoding?: 'utf8' | 'hex' | 'base64' | DataLink
+            }
+        >
+      | DataLink
+    /* Beacon mode */
+    beaconsEnable?: boolean | DataLink
+    /* Measured RSSI @ 1m, used for calculate distance */
+    beaconsTxPower?: number | DataLink
+    /* Beacon configs  
+  presets has pre-defined layout and manufacturerId  
+  layout string is like AltBeacon's Beacon Layout, but replace "x" as extra data  
+  id and data could be 0x prefixed hex, hex string, decimal or UUID  
+  extra should be hex string */
+    beaconsConfig?:
+      | Array<
+          | DataLink
+          | {
+              preset?: 'LINE_SIMPLE_BEACON' | 'iBeacon' | 'EddystoneUID' | 'AltBeacon' | DataLink
+              manufacturerId?: number | DataLink
+              layout?: string | DataLink
+              id1?: string | DataLink
+              id2?: string | DataLink
+              id3?: string | DataLink
+              datas?: Array<string | DataLink> | DataLink
+              extra?: string | DataLink
+            }
+        >
+      | DataLink
+  }
+  events?: {}
+  outlets?: {
+    /* Is advertising */
+    isAdvertising?: () => Data
+    /* Last receive written */
+    lastWrite?: () => Data
+    /* Error message */
+    errorMessage?: () => Data
+  }
+}
+
+/* BLE Peripheral Mode Generator */
+export type GeneratorBlePeripheral = Generator &
+  GeneratorBlePeripheralDef & {
+    templateKey: 'GENERATOR_BLE_PERIPHERAL'
+    switches: Array<
+      SwitchDef &
+        GeneratorBlePeripheralDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'isAdvertising' | 'lastWrite' | 'errorMessage'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/generators/CanvasMap.ts

@@ -0,0 +1,57 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+interface GeneratorCanvasMapDef {
+  /*
+Default property:
+{
+  "triggerList": []
+}
+  */
+  property?: {
+    /* Trigger rule list */
+    triggerList?:
+      | Array<
+          | DataLink
+          | {
+              operation?: '<' | '<=' | '==' | '!=' | '>' | '>=' | DataLink
+              property?: any
+              value?: string | DataLink
+              canvasId?: string | DataLink
+              canvasTitleLike?: string | DataLink
+            }
+        >
+      | DataLink
+  }
+  outlets?: {}
+}
+
+/* Trigger change canvas by setup rules */
+export type GeneratorCanvasMap = Generator &
+  GeneratorCanvasMapDef & {
+    templateKey: 'GENERATOR_CANVAS_MAP'
+    switches: Array<
+      SwitchDef &
+        GeneratorCanvasMapDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: ''
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/generators/CastlesPay.ts

@@ -0,0 +1,77 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+/* Sale */
+export type GeneratorCastlesPayActionSale = ActionWithParams & {
+  __actionName: 'GENERATOR_CASTLES_PAY_SALE'
+  params?: Array<{
+    input: 'amount'
+    value?: number | DataLink | EventProperty
+    mapping?: string
+  }>
+}
+
+/* Cancel Transaction */
+export type GeneratorCastlesPayActionCancelTransaction = ActionWithParams & {
+  __actionName: 'GENERATOR_CASTLES_PAY_CANCEL_TRANSACTION'
+  params?: Array<{
+    input: 'transactionId'
+    value?: string | DataLink | EventProperty
+    mapping?: string
+  }>
+}
+
+/* Open Search */
+export type GeneratorCastlesPayActionOpenSearch = Action & {
+  __actionName: 'GENERATOR_CASTLES_PAY_OPEN_SEARCH'
+}
+
+interface GeneratorCastlesPayDef {
+  /*
+Default property:
+{}
+  */
+  property?: {}
+  events?: {
+    /* Action Success */
+    onActionSuccess?: Array<EventAction>
+    /* Action Error */
+    onActionError?: Array<EventAction>
+  }
+  outlets?: {
+    /* Last Transaction Result */
+    lastTransactionResult?: () => Data
+    /* Last Error */
+    lastError?: () => Data
+  }
+}
+
+/* Castles Pay */
+export type GeneratorCastlesPay = Generator &
+  GeneratorCastlesPayDef & {
+    templateKey: 'GENERATOR_CASTLES_PAY'
+    switches: Array<
+      SwitchDef &
+        GeneratorCastlesPayDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'lastTransactionResult' | 'lastError'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/generators/DataBank.ts

@@ -0,0 +1,123 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+/* Run Data Bank fetch */
+export type GeneratorDataBankActionFetch = Action & {
+  __actionName: 'GENERATOR_DATA_BANK_FETCH'
+}
+
+/* Run Data Bank update */
+export type GeneratorDataBankActionUpdateProperty = ActionWithParams & {
+  __actionName: 'GENERATOR_DATA_BANK_UPDATE_PROPERTY'
+  params?: Array<
+    | {
+        input: 'propertyId'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'propertyValue'
+        value?: any | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Run Data Bank remove */
+export type GeneratorDataBankActionRemoveProperty = ActionWithParams & {
+  __actionName: 'GENERATOR_DATA_BANK_REMOVE_PROPERTY'
+  params?: Array<{
+    input: 'propertyId'
+    value?: string | DataLink | EventProperty
+    mapping?: string
+  }>
+}
+
+/* Reset cache of Data Bank */
+export type GeneratorDataBankActionResetCache = Action & {
+  __actionName: 'GENERATOR_DATA_BANK_RESET_CACHE'
+}
+
+/* Cancel current running subscription */
+export type GeneratorDataBankActionCancelSubscription = Action & {
+  __actionName: 'GENERATOR_DATA_BANK_CANCEL_SUBSCRIPTION'
+}
+
+interface GeneratorDataBankDef {
+  /*
+Default property:
+{
+  "init": false,
+  "fetchPolicy": "cache-first",
+  "subscribeDataChange": false
+}
+  */
+  property?: {
+    /* Start generator initialization execution immediately */
+    init?: boolean | DataLink
+    /* Data Bank Space ID */
+    spacename?: string | DataLink
+    /* Data Bank Space secret key */
+    spacekey?: string | DataLink
+    /* Data need to be fetched */
+    properties?: Array<string | 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 Data change */
+    subscribeDataChange?: boolean | DataLink
+  }
+  events?: {
+    /* Event of Data Bank fetch response */
+    onFetchResponse?: Array<EventAction>
+    /* Event of Data Bank change from subscription */
+    onChange?: Array<EventAction>
+    /* Event of Data Bank fetch error */
+    onFetchError?: Array<EventAction>
+    /* Event of error */
+    onError?: Array<EventAction>
+    /* Event of subscription on connection */
+    subscribeDataOnConnect?: Array<EventAction>
+    /* Server connections error of subscription */
+    subscribeDataOnConnectError?: Array<EventAction>
+  }
+  outlets?: {
+    /* Response for Data Bank fetch request, it will save to Data */
+    response?: () => Data
+    /* Server response error of Data Bank fetch request,    it will save to Data */
+    error?: () => Data
+  }
+}
+
+/* Get Data or subscribe to Data changes from Data Bank */
+export type GeneratorDataBank = Generator &
+  GeneratorDataBankDef & {
+    templateKey: 'GENERATOR_DATA_BANK'
+    switches: Array<
+      SwitchDef &
+        GeneratorDataBankDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'response' | 'error'
+                  value: any
+                }
+          }>
+        }
+    >
+  }