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

package/types/generators/HttpServer.ts

@@ -0,0 +1,164 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+/* Start HTTP server */
+export type GeneratorHTTPServerActionStart = Action & {
+  __actionName: 'GENERATOR_HTTP_SERVER_START'
+}
+
+/* Stop HTTP server */
+export type GeneratorHTTPServerActionStop = Action & {
+  __actionName: 'GENERATOR_HTTP_SERVER_STOP'
+}
+
+/* Clear upload temp files */
+export type GeneratorHTTPServerActionClearTempFiles = Action & {
+  __actionName: 'GENERATOR_HTTP_SERVER_CLEAR_TEMP_FILES'
+}
+
+/* End stream */
+export type GeneratorHTTPServerActionEndStream = Action & {
+  __actionName: 'GENERATOR_HTTP_SERVER_END_STREAM'
+}
+
+interface GeneratorHTTPServerDef {
+  /*
+Default property:
+{
+  "init": false,
+  "method": "GET",
+  "path": "/",
+  "idleTimeout": 10000,
+  "authType": "none",
+  "asyncMode": false,
+  "resStatusCode": 200,
+  "resContentType": "text/plain",
+  "tls": false,
+  "tlsKeyPairPassword": ""
+}
+  */
+  property?: {
+    /* Start HTTP server on generator initialized */
+    init?: boolean | DataLink
+    /* Bind port of HTTP server */
+    port?: number | DataLink
+    /* Method of HTTP request */
+    method?:
+      | 'GET'
+      | 'POST'
+      | 'PUT'
+      | 'DELETE'
+      | 'HEAD'
+      | 'PATCH'
+      | 'OPTIONS'
+      | 'CONNECT'
+      | 'TRACE'
+      | DataLink
+    /* Path of HTTP request */
+    path?: string | DataLink
+    /* Max connection idle time, 0 is disable */
+    idleTimeout?: number | DataLink
+    /* HTTP request body limit, 0 is unlimited */
+    bodyLimit?: number | DataLink
+    /* CORS allowed origins  
+  You can use wildcard like `*`, `*.example.com`, `http://*.example.com` */
+    corsOrigins?: Array<string | DataLink> | DataLink
+    /* Authorization type of HTTP request */
+    authType?: 'none' | 'basic' | 'bearer' | DataLink
+    /* Username of basic auth */
+    basicAuthUser?: string | DataLink
+    /* Password of basic auth */
+    basicAuthPassword?: string | DataLink
+    /* Token of bearer auth */
+    bearerToken?: string | DataLink
+    /* Asynchronous response mode  
+  Will block connection until Response Body update. */
+    asyncMode?: boolean | DataLink
+    /* Save request body as file  
+  Only work on `application/octet-stream` or `multipart/form-data`. */
+    saveBodyAsFile?: boolean | DataLink
+    /* Response status code */
+    resStatusCode?: number | DataLink
+    /* Response Content-Type  
+  `text/*` will not convert body.  
+  `application/xml` convert object to XML, [example object struct](https://github.com/davidcalhoun/jstoxml#example-10-podcast-rss-feed)  
+  `application/octet-stream` body should be Base64 string or file path. */
+    resContentType?:
+      | 'text/plain'
+      | 'text/html'
+      | 'text/javascript'
+      | 'text/css'
+      | 'text/xml'
+      | 'application/xml'
+      | 'application/json'
+      | 'application/octet-stream'
+      | 'text/event-stream'
+      | DataLink
+    /* Response Body */
+    resBody?: any
+    /* Custom response headers */
+    resHeader?: {} | DataLink
+    /* Event name of SSE */
+    sseEvent?: string | DataLink
+    /* SSE single request mode, block new request until the previous request is processed */
+    sseSingleRequest?: boolean | DataLink
+    /* Enable TLS (HTTPS) */
+    tls?: boolean | DataLink
+    /* Server side key pair (Base64 encoded PKCS #12) */
+    tlsKeyPair?: string | DataLink
+    /* Password of key pair, leave empty if no password */
+    tlsKeyPairPassword?: string | DataLink
+  }
+  events?: {
+    /* Event of HTTP server is ready */
+    onReady?: Array<EventAction>
+    /* Event of HTTP server accept the request */
+    onRequest?: Array<EventAction>
+    /* Event of client close connection */
+    onClientClose?: Array<EventAction>
+    /* Event of client error */
+    onClientError?: Array<EventAction>
+    /* Event of server close */
+    onClose?: Array<EventAction>
+    /* Event of server error */
+    onError?: Array<EventAction>
+  }
+  outlets?: {
+    /* Query of request */
+    requestQuery?: () => Data
+    /* Body of request */
+    requestBody?: () => Data
+    /* Remote address of request */
+    clientAddress?: () => Data
+  }
+}
+
+/* HTTP Server */
+export type GeneratorHTTPServer = Generator &
+  GeneratorHTTPServerDef & {
+    templateKey: 'GENERATOR_HTTP_SERVER'
+    switches: Array<
+      SwitchDef &
+        GeneratorHTTPServerDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'requestQuery' | 'requestBody' | 'clientAddress'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/generators/Information.ts

@@ -0,0 +1,97 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+/* Show information */
+export type GeneratorInformationActionShow = ActionWithParams & {
+  __actionName: 'GENERATOR_INFORMATION_SHOW'
+  params?: Array<
+    | {
+        input: 'displayLanguage'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'content'
+        value?: {} | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Close information */
+export type GeneratorInformationActionClose = Action & {
+  __actionName: 'GENERATOR_INFORMATION_CLOSE'
+}
+
+interface GeneratorInformationDef {
+  /*
+Default property:
+{
+  "modalMode": "root",
+  "backgroundColor": "#161616"
+}
+  */
+  property?: {
+    /* Modal mode */
+    modalMode?: 'root' | 'in-subspace' | DataLink
+    /* Information contents */
+    content?:
+      | DataLink
+      | {
+          type?: 'loading' | 'info' | 'warning' | 'success' | 'queue-number' | DataLink
+          title?: string | DataLink
+          description?: string | DataLink
+          queueNumberLabel?:
+            | DataLink
+            | {
+                number?: string | DataLink
+                labelTitle?: string | DataLink
+                note?: string | DataLink
+              }
+        }
+    /* Display language */
+    displayLanguage?: string | DataLink
+    /* Background color */
+    backgroundColor?: string | DataLink
+  }
+  events?: {
+    /* Trigger when user confirms the information */
+    onConfirm?: Array<EventAction>
+    /* Trigger when error occurs */
+    onError?: Array<EventAction>
+  }
+  outlets?: {
+    /* Error message */
+    errorMessage?: () => Data
+  }
+}
+
+/* Show information */
+export type GeneratorInformation = Generator &
+  GeneratorInformationDef & {
+    templateKey: 'GENERATOR_INFORMATION'
+    switches: Array<
+      SwitchDef &
+        GeneratorInformationDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'errorMessage'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/generators/Intent.ts

@@ -0,0 +1,107 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+/* Read stats */
+export type GeneratorIntentActionSendIntent = ActionWithParams & {
+  __actionName: 'GENERATOR_INTENT_SEND_INTENT'
+  params?: Array<
+    | {
+        input: 'action'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'data'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'type'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'extra'
+        value?: {} | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'className'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'packageName'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'category'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+interface GeneratorIntentDef {
+  /*
+Default property:
+{}
+  */
+  property?: {
+    /* Intent action */
+    action?: string | DataLink
+    /* Intent data */
+    data?: string | DataLink
+    /* Intent type */
+    type?: string | DataLink
+    /* Extra data */
+    extra?: {} | DataLink
+    /* Intent target class name in package */
+    className?: string | DataLink
+    /* Intent target package name */
+    packageName?: string | DataLink
+    /* Intent category */
+    category?: string | DataLink
+  }
+  events?: {
+    /* On intent return a result trigger */
+    onResult?: Array<EventAction>
+    /* On intent error trigger */
+    onError?: Array<EventAction>
+  }
+  outlets?: {
+    /* Last intent result */
+    result?: () => Data
+  }
+}
+
+/* Send intent to app and get result (Android only) */
+export type GeneratorIntent = Generator &
+  GeneratorIntentDef & {
+    templateKey: 'GENERATOR_INTENT'
+    switches: Array<
+      SwitchDef &
+        GeneratorIntentDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'result'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/generators/Iterator.ts

@@ -0,0 +1,95 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+/* Proceed to next iteration */
+export type GeneratorIteratorActionNext = Action & {
+  __actionName: 'GENERATOR_ITERATOR_NEXT'
+}
+
+/* Go back to previous iteration */
+export type GeneratorIteratorActionPrevious = Action & {
+  __actionName: 'GENERATOR_ITERATOR_PREVIOUS'
+}
+
+/* Jump to the last iteration element (ignoring the loop setting) */
+export type GeneratorIteratorActionLast = Action & {
+  __actionName: 'GENERATOR_ITERATOR_LAST'
+}
+
+/* Reset iteration state */
+export type GeneratorIteratorActionReset = Action & {
+  __actionName: 'GENERATOR_ITERATOR_RESET'
+}
+
+interface GeneratorIteratorDef {
+  /*
+Default property:
+{
+  "data": [],
+  "start": 0,
+  "step": 1
+}
+  */
+  property?: {
+    /* Data source for iteration. If it's an Array, it will iterate through elements. If it's an Object, it will use Object.values() as data source. If it's a String, it will iterate through characters. If it's a Number, it represents count from 1 to N. */
+    data?: any
+    /* Starting element position */
+    start?: number | DataLink
+    /* Step size for each iteration */
+    step?: number | DataLink
+    /* Maximum number of iterations (can be set to -1 for unlimited) */
+    maxQuantity?: number | DataLink
+    /* Whether to loop the iteration */
+    loop?: boolean | DataLink
+  }
+  events?: {
+    /* Event triggered on each iteration */
+    iterate?: Array<EventAction>
+    /* Event triggered on the first iteration of a round */
+    first?: Array<EventAction>
+    /* Event triggered on the last iteration of a round */
+    end?: Array<EventAction>
+  }
+  outlets?: {
+    /* Elements that have been iterated (including current one) */
+    iteratedArray?: () => Data
+    /* Elements that will be iterated but have not been iterated yet */
+    upcomingArray?: () => Data
+    /* Current iteration element */
+    value?: () => Data
+    /* Key of the current iteration element (for number: same as value, for array/string: index, for object: string key) */
+    key?: () => Data
+    /* Current iteration count (if data is 6 and step is 2, this will return: 1,2,3 in sequence) */
+    index?: () => Data
+  }
+}
+
+/* Iterate through values (Array, Object, Number, String) */
+export type GeneratorIterator = Generator &
+  GeneratorIteratorDef & {
+    templateKey: 'GENERATOR_ITERATOR'
+    switches: Array<
+      SwitchDef &
+        GeneratorIteratorDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'iteratedArray' | 'upcomingArray' | 'value' | 'key' | 'index'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/generators/Keyboard.ts

@@ -0,0 +1,85 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+interface GeneratorKeyboardDef {
+  /*
+Default property:
+{
+  "enabled": true,
+  "keyMap": {},
+  "batchStopKeys": [
+    13
+  ],
+  "batchDebounce": 500
+}
+  */
+  property?: {
+    /* Enable listening for input */
+    enabled?: boolean | DataLink
+    /* Key map to transform key or key code to the designated content (e.g. { 37: 'left' }) */
+    keyMap?: {} | DataLink
+    /* Key outlet preference use key code or key. */
+    keyOutletPrefer?: 'auto' | 'key-code' | 'key' | DataLink
+    /* Key or code to finish continuous input */
+    batchStopKeys?: Array<string | DataLink | number | DataLink | DataLink> | DataLink
+    /* Debounce time (ms) to finish continuous input */
+    batchDebounce?: number | DataLink
+    /* Maximum wait time (ms) to finish continuous input (default: unlimited) */
+    batchDebounceMaxWait?: number | DataLink
+  }
+  events?: {
+    /* Event on key press */
+    onDown?: Array<EventAction>
+    /* Event on key up */
+    onUp?: Array<EventAction>
+    /* Event on continuous input complete */
+    onBatch?: Array<EventAction>
+  }
+  outlets?: {
+    /* Last key code pressed */
+    lastKeyDown?: () => Data
+    /* Modifier key information on last key press */
+    lastKeyDownFlags?: () => Data
+    /* Last key code released */
+    lastKeyUp?: () => Data
+    /* Modifier key information on last key release */
+    lastKeyUpFlags?: () => Data
+    /* Last continuous event */
+    lastBatchEvents?: () => Data
+  }
+}
+
+/* Access keyboard (remote control) events */
+export type GeneratorKeyboard = Generator &
+  GeneratorKeyboardDef & {
+    templateKey: 'GENERATOR_KEYBOARD'
+    switches: Array<
+      SwitchDef &
+        GeneratorKeyboardDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet:
+                    | 'lastKeyDown'
+                    | 'lastKeyDownFlags'
+                    | 'lastKeyUp'
+                    | 'lastKeyUpFlags'
+                    | 'lastBatchEvents'
+                  value: any
+                }
+          }>
+        }
+    >
+  }