@fugood/bricks-ctor 2.24.0-beta.40

package/types/generators/GraphQl.ts

@@ -0,0 +1,132 @@
+/* Auto generated by build script
+ *
+ * GraphQL client for Query, Mutation, and Subscription (WebSocket) with response caching and optional Firebase Realtime Database link
+ */
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Brick,
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+import type { TemplateEventPropsMap } from '../../utils/event-props'
+
+/* Execute GraphQL request with defined properties */
+export type GeneratorGraphQLActionRunQuery = ActionWithParams & {
+  __actionName: 'GENERATOR_GRAPHQL_RUN_QUERY'
+  params?: Array<
+    | {
+        input: 'type'
+        value?: 'query' | 'mutation' | 'subscription' | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'query'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'variables'
+        value?: {} | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Reset cache of GraphQL client */
+export type GeneratorGraphQLActionResetCache = Action & {
+  __actionName: 'GENERATOR_GRAPHQL_RESET_CACHE'
+}
+
+/* Cancel current running subscription */
+export type GeneratorGraphQLActionCancelSubscription = Action & {
+  __actionName: 'GENERATOR_GRAPHQL_CANCEL_SUBSCRIPTION'
+}
+
+interface GeneratorGraphQLDef {
+  /*
+Default property:
+{
+  "init": false,
+  "type": "query",
+  "headers": {},
+  "query": "",
+  "variables": {},
+  "firebaseEnabled": false
+}
+  */
+  property?: {
+    /* Start GraphQL request immediately after generator initialization */
+    init?: boolean | DataLink
+    /* GraphQL request type */
+    type?: 'query' | 'mutation' | 'subscription' | DataLink
+    /* HTTP request headers */
+    headers?: {} | DataLink
+    /* HTTP request URL endpoint */
+    endpoint?: string | DataLink
+    /* Subscription endpoint */
+    endpointForSubscription?: string | DataLink
+    /* Subscription connection params */
+    connectionParams?: {} | DataLink
+    /* Query content */
+    query?: string | DataLink
+    /* Query variables */
+    variables?: {} | DataLink
+    /* Data id from response, it is useful for caching data */
+    dataIdFromObject?: string | DataLink
+    /* Enable Firebase link */
+    firebaseEnabled?: boolean | DataLink
+    /* Firebase API Key */
+    firebaseAPIKey?: string | DataLink
+    /* Firebase Realtime Database `authDomain` field */
+    firebaseAuthDomain?: string | DataLink
+    /* Firebase Realtime Database `databaseURL` field */
+    firebaseDatabaseURL?: string | DataLink
+    /* Firebase Realtime Database `projectId` field */
+    firebaseProjectId?: string | DataLink
+    /* Firebase Realtime Database `storageBucket` field */
+    firebaseStorageBucket?: string | DataLink
+    /* Firebase Realtime Database `messagingSenderId` field */
+    firebaseMessagingSenderId?: string | DataLink
+  }
+  events?: {
+    /* Event triggered when subscription connection is successful */
+    subscriptionOnConnection?: Array<EventAction>
+    /* Event triggered when subscription connection error occurs */
+    subscriptionOnConnectionError?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['Graphql']['subscriptionOnConnectionError']>
+    >
+  }
+  outlets?: {
+    /* Response for GraphQL request, it will save to Data */
+    response?: () => Data<{ [key: string]: any }>
+    /* Server response error of GraphQL request,    it will save to Data */
+    error?: () => Data<string>
+  }
+}
+
+/* GraphQL client for Query, Mutation, and Subscription (WebSocket) with response caching and optional Firebase Realtime Database link */
+export type GeneratorGraphQL = Generator &
+  GeneratorGraphQLDef & {
+    templateKey: 'GENERATOR_GRAPHQL'
+    switches?: Array<
+      SwitchDef &
+        GeneratorGraphQLDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'response' | 'error'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/generators/Http.ts

@@ -0,0 +1,222 @@
+/* Auto generated by build script
+ *
+ * HTTP client supporting all methods (GET/POST/PUT/DELETE/PATCH/...), response parsing (JSON/text/XML/CSV), SSE event streams, and multipart file uploads
+ */
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Brick,
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+import type { TemplateEventPropsMap } from '../../utils/event-props'
+
+/* Run HTTP request with defined properties */
+export type GeneratorHTTPActionRunRequest = ActionWithParams & {
+  __actionName: 'GENERATOR_HTTP_RUN_REQUEST'
+  params?: Array<
+    | {
+        input: 'url'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'method'
+        value?:
+          | 'GET'
+          | 'POST'
+          | 'PUT'
+          | 'DELETE'
+          | 'HEAD'
+          | 'PATCH'
+          | 'OPTIONS'
+          | 'CONNECT'
+          | 'TRACE'
+          | DataLink
+          | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'headers'
+        value?: {} | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'body'
+        value?: {} | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'timeout'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'mode'
+        value?: 'same-origin' | 'no-cors' | 'cors' | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'credentials'
+        value?: 'include' | 'same-origin' | 'omit' | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'redirect'
+        value?: 'manual' | 'follow' | 'error' | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'referrer'
+        value?: 'no-referrer' | 'client' | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'resType'
+        value?: 'json' | 'text' | 'xml' | 'csv' | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'resSelector'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'eventStream'
+        value?: boolean | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'eventName'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Abort HTTP request or SSE */
+export type GeneratorHTTPActionAbort = Action & {
+  __actionName: 'GENERATOR_HTTP_ABORT'
+}
+
+interface GeneratorHTTPDef {
+  /*
+Default property:
+{
+  "init": false,
+  "method": "GET",
+  "headers": {},
+  "body": {},
+  "resType": "json",
+  "eventStream": false,
+  "eventName": "message"
+}
+  */
+  property?: {
+    /* Start HTTP request on generator initialized */
+    init?: boolean | DataLink
+    /* URL of HTTP request */
+    url?: string | DataLink
+    /* Method of HTTP request */
+    method?:
+      | 'GET'
+      | 'POST'
+      | 'PUT'
+      | 'DELETE'
+      | 'HEAD'
+      | 'PATCH'
+      | 'OPTIONS'
+      | 'CONNECT'
+      | 'TRACE'
+      | DataLink
+    /* HTTP request headers */
+    headers?: {} | DataLink
+    /* Timeout of HTTP request */
+    timeout?: number | DataLink
+    /* Mode of HTTP request */
+    mode?: 'same-origin' | 'no-cors' | 'cors' | DataLink
+    /* Credentials of HTTP request */
+    credentials?: 'include' | 'same-origin' | 'omit' | DataLink
+    /* Redirect of HTTP request */
+    redirect?: 'manual' | 'follow' | 'error' | DataLink
+    /* Referrer of HTTP request */
+    referrer?: 'no-referrer' | 'client' | DataLink
+    /* HTTP request body,  it will transform depends on `headers.Content-Type`    (`application/json`, `application/x-www-form-urlencoded` or `multipart/form-data`)
+  The multipart schema like `{ file: { uri: File, type: File MIME, name: File Name }, field: "value" }` */
+    body?: {} | DataLink
+    /* HTTP response type */
+    resType?: 'json' | 'text' | 'xml' | 'csv' | DataLink
+    /* Response selector path to extract specific data from parsed response  (e.g., "data.items" for JSON, "root.element" for XML) */
+    resSelector?: string | DataLink
+    /* Receive event stream (SSE) */
+    eventStream?: boolean | DataLink
+    /* Event name to listen on SSE */
+    eventName?: string | DataLink | Array<string | DataLink> | DataLink | DataLink
+  }
+  events?: {}
+  outlets?: {
+    /* Response for HTTP request */
+    response?: () => Data<string | { [key: string]: any }>
+    /* Response details for HTTP request */
+    responseDetails?: () => Data<{
+      ok?: boolean
+      redirected?: boolean
+      type?: string
+      status?: number
+      statusText?: string
+      headers?: { [key: string]: any }
+      body?: any
+      event?: string
+      id?: string
+      data?: any
+      [key: string]: any
+    }>
+    /* All received data from event stream */
+    eventLog?: () => Data<Array<any>>
+    /* All received event details from event stream */
+    eventLogDetails?: () => Data<
+      Array<{
+        event?: string
+        id?: string
+        data?: any
+        [key: string]: any
+      }>
+    >
+    /* EventSource state */
+    sseState?: () => Data<string>
+    /* Server response error of HTTP request */
+    error?: () => Data<string>
+  }
+}
+
+/* HTTP client supporting all methods (GET/POST/PUT/DELETE/PATCH/...), response parsing (JSON/text/XML/CSV), SSE event streams, and multipart file uploads */
+export type GeneratorHTTP = Generator &
+  GeneratorHTTPDef & {
+    templateKey: 'GENERATOR_HTTP'
+    switches?: Array<
+      SwitchDef &
+        GeneratorHTTPDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet:
+                    | 'response'
+                    | 'responseDetails'
+                    | 'eventLog'
+                    | 'eventLogDetails'
+                    | 'sseState'
+                    | 'error'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/generators/HttpServer.ts

@@ -0,0 +1,176 @@
+/* Auto generated by build script
+ *
+ * Embedded HTTP/HTTPS server with route matching, CORS, auth (Basic/Bearer), SSE streaming, file upload, and async response mode
+ */
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Brick,
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+import type { TemplateEventPropsMap } from '../../utils/event-props'
+
+/* 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<string & keyof TemplateEventPropsMap['HttpServer']['onRequest']>>
+    /* Event of client close connection */
+    onClientClose?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['HttpServer']['onClientClose']>
+    >
+    /* Event of client error */
+    onClientError?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['HttpServer']['onClientError']>
+    >
+    /* Event of server close */
+    onClose?: Array<EventAction>
+    /* Event of server error */
+    onError?: Array<EventAction<string & keyof TemplateEventPropsMap['HttpServer']['onError']>>
+  }
+  outlets?: {
+    /* Server is listening */
+    isListening?: () => Data<boolean>
+    /* Query of request */
+    requestQuery?: () => Data<{ [key: string]: any }>
+    /* Body of request */
+    requestBody?: () => Data<any>
+    /* Remote address of request */
+    clientAddress?: () => Data<string>
+  }
+}
+
+/* Embedded HTTP/HTTPS server with route matching, CORS, auth (Basic/Bearer), SSE streaming, file upload, and async response mode */
+export type GeneratorHTTPServer = Generator &
+  GeneratorHTTPServerDef & {
+    templateKey: 'GENERATOR_HTTP_SERVER'
+    switches?: Array<
+      SwitchDef &
+        GeneratorHTTPServerDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'isListening' | 'requestQuery' | 'requestBody' | 'clientAddress'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/generators/Information.ts

@@ -0,0 +1,103 @@
+/* Auto generated by build script
+ *
+ * Display informational dialog or toast messages to the user
+ */
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Brick,
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+import type { TemplateEventPropsMap } from '../../utils/event-props'
+
+/* 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<string & keyof TemplateEventPropsMap['Information']['onError']>>
+  }
+  outlets?: {
+    /* Error message */
+    errorMessage?: () => Data<string>
+  }
+}
+
+/* Display informational dialog or toast messages to the user */
+export type GeneratorInformation = Generator &
+  GeneratorInformationDef & {
+    templateKey: 'GENERATOR_INFORMATION'
+    switches?: Array<
+      SwitchDef &
+        GeneratorInformationDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'errorMessage'
+                  value: any
+                }
+          }>
+        }
+    >
+  }