@fugood/bricks-project 2.24.0-beta.9 → 2.24.0

package/types/generators/CastlesPay.ts

@@ -1,4 +1,7 @@
-/* Auto generated by build script */
+/* Auto generated by build script
+ *
+ * Payment processing integration for Castles payment terminals
+ */
 import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
 import type { Data, DataLink } from '../data'
 import type {
@@ -10,6 +13,7 @@ import type {
   Action,
   EventProperty,
 } from '../common'
+import type { TemplateEventPropsMap } from '../../utils/event-props'
 
 /* Sale */
 export type GeneratorCastlesPayActionSale = ActionWithParams & {
@@ -44,19 +48,23 @@ Default property:
   property?: {}
   events?: {
     /* Action Success */
-    onActionSuccess?: Array<EventAction>
+    onActionSuccess?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['CastlesPay']['onActionSuccess']>
+    >
     /* Action Error */
-    onActionError?: Array<EventAction>
+    onActionError?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['CastlesPay']['onActionError']>
+    >
   }
   outlets?: {
     /* Last Transaction Result */
-    lastTransactionResult?: () => Data
+    lastTransactionResult?: () => Data<{ [key: string]: any }>
     /* Last Error */
-    lastError?: () => Data
+    lastError?: () => Data<string>
   }
 }
 
-/* Castles Pay */
+/* Payment processing integration for Castles payment terminals */
 export type GeneratorCastlesPay = Generator &
   GeneratorCastlesPayDef & {
     templateKey: 'GENERATOR_CASTLES_PAY'

package/types/generators/DataBank.ts

@@ -1,4 +1,7 @@
-/* Auto generated by build script */
+/* Auto generated by build script
+ *
+ * Access and subscribe to shared Data properties from the project Data Bank
+ */
 import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
 import type { Data, DataLink } from '../data'
 import type {
@@ -10,6 +13,7 @@ import type {
   Action,
   EventProperty,
 } from '../common'
+import type { TemplateEventPropsMap } from '../../utils/event-props'
 
 /* Run Data Bank fetch */
 export type GeneratorDataBankActionFetch = Action & {
@@ -71,7 +75,7 @@ Default property:
     spacekey?: string | DataLink
     /* Data need to be fetched */
     properties?: Array<string | DataLink> | DataLink
-    /* Determine the cache behavior  
+    /* Determine the cache behavior
   
  cache-first: Cache first if existing, then fetch from network  
  network-and-cache: Fetch from network, then save cache  
@@ -82,27 +86,58 @@ Default property:
   }
   events?: {
     /* Event of Data Bank fetch response */
-    onFetchResponse?: Array<EventAction>
+    onFetchResponse?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['DataBank']['onFetchResponse']>
+    >
     /* 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>
+    onError?: Array<EventAction<string & keyof TemplateEventPropsMap['DataBank']['onError']>>
     /* Event of subscription on connection */
     subscribeDataOnConnect?: Array<EventAction>
     /* Server connections error of subscription */
-    subscribeDataOnConnectError?: Array<EventAction>
+    subscribeDataOnConnectError?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['DataBank']['subscribeDataOnConnectError']>
+    >
   }
   outlets?: {
     /* Response for Data Bank fetch request, it will save to Data */
-    response?: () => Data
+    response?: () => Data<
+      Array<{
+        __typename?: string
+        id?: string
+        createAt?: string
+        updateAt?: string
+        spaceId?: string
+        propertyId?: string
+        definition?: {
+          type?: string
+          title?: string
+          schema?: { [key: string]: any }
+          [key: string]: any
+        }
+        meta?: string
+        value?: any
+        lastUpdateHash?: string
+        lastUpdateNote?: string
+        lastUpdateKey?: {
+          name?: string
+          enable_expired?: boolean
+          expired_at?: any
+          jwt?: boolean
+          [key: string]: any
+        }
+        [key: string]: any
+      }>
+    >
     /* Server response error of Data Bank fetch request,    it will save to Data */
-    error?: () => Data
+    error?: () => Data<string>
   }
 }
 
-/* Get Data or subscribe to Data changes from Data Bank */
+/* Access and subscribe to shared Data properties from the project Data Bank */
 export type GeneratorDataBank = Generator &
   GeneratorDataBankDef & {
     templateKey: 'GENERATOR_DATA_BANK'

package/types/generators/File.ts

@@ -1,4 +1,7 @@
-/* Auto generated by build script */
+/* Auto generated by build script
+ *
+ * File system operations: read, write, copy, delete, and list files
+ */
 import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
 import type { Data, DataLink } from '../data'
 import type {
@@ -10,6 +13,7 @@ import type {
   Action,
   EventProperty,
 } from '../common'
+import type { TemplateEventPropsMap } from '../../utils/event-props'
 
 /* Read stats */
 export type GeneratorFileActionReadStats = Action & {
@@ -259,65 +263,140 @@ Default property:
   }
   events?: {
     /* On file handler init error */
-    initError?: Array<EventAction>
+    initError?: Array<EventAction<string & keyof TemplateEventPropsMap['File']['initError']>>
     /* On file status change */
-    onFileStatusChange?: Array<EventAction>
+    onFileStatusChange?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['File']['onFileStatusChange']>
+    >
     /* On read stats error */
-    onReadStatsError?: Array<EventAction>
+    onReadStatsError?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['File']['onReadStatsError']>
+    >
     /* On read content error */
-    onReadContentError?: Array<EventAction>
+    onReadContentError?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['File']['onReadContentError']>
+    >
     /* On read content error */
-    onAppendContentError?: Array<EventAction>
+    onAppendContentError?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['File']['onAppendContentError']>
+    >
     /* On write content error */
-    onWriteContentError?: Array<EventAction>
+    onWriteContentError?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['File']['onWriteContentError']>
+    >
     /* On upload progress */
-    onUploadProgress?: Array<EventAction>
+    onUploadProgress?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['File']['onUploadProgress']>
+    >
     /* On upload error */
-    onUploadError?: Array<EventAction>
+    onUploadError?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['File']['onUploadError']>
+    >
     /* On upload complete */
-    onUploadComplete?: Array<EventAction>
+    onUploadComplete?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['File']['onUploadComplete']>
+    >
     /* On upload all done */
-    onUploadAllComplete?: Array<EventAction>
+    onUploadAllComplete?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['File']['onUploadAllComplete']>
+    >
     /* On download progress */
-    onDownloadProgress?: Array<EventAction>
+    onDownloadProgress?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['File']['onDownloadProgress']>
+    >
     /* On download error */
-    onDownloadError?: Array<EventAction>
+    onDownloadError?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['File']['onDownloadError']>
+    >
     /* On download complete */
-    onDownloadComplete?: Array<EventAction>
+    onDownloadComplete?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['File']['onDownloadComplete']>
+    >
     /* On download all done */
-    onDownloadAllComplete?: Array<EventAction>
+    onDownloadAllComplete?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['File']['onDownloadAllComplete']>
+    >
   }
   outlets?: {
     /* File init error result will be stored in Data */
-    initError?: () => Data
+    initError?: () => Data<string>
     /* File read stats result will be stored in Data */
-    readStats?: () => Data
+    readStats?: () => Data<{
+      path?: string
+      size?: number
+      isDirectory?: boolean
+      mtime?: string
+      ctime?: string
+      mode?: number
+      originalFilepath?: string
+      [key: string]: any
+    }>
     /* File read content result will be stored in Data */
-    readContent?: () => Data
+    readContent?: () => Data<any>
     /* File read details result will be stored in Data */
-    readDetails?: () => Data
+    readDetails?: () => Data<{
+      path?: string
+      content?: any
+      size?: number
+      exists?: boolean
+      [key: string]: any
+    }>
     /* File read error result will be stored in Data */
-    readError?: () => Data
+    readError?: () => Data<string>
     /* File append content result will be stored in Data */
-    appendDetails?: () => Data
+    appendDetails?: () => Data<{
+      path?: string
+      appended?: boolean
+      contentLength?: number
+      [key: string]: any
+    }>
     /* File append error result will be stored in Data */
-    appendError?: () => Data
+    appendError?: () => Data<string>
     /* File write details result will be stored in Data */
-    writeDetails?: () => Data
+    writeDetails?: () => Data<{
+      path?: string
+      written?: boolean
+      contentLength?: number
+      [key: string]: any
+    }>
     /* File write error result will be stored in Data */
-    writeError?: () => Data
+    writeError?: () => Data<string>
     /* File upload progress result will be stored in Data */
-    uploadProgress?: () => Data
+    uploadProgress?: () => Data<{
+      id?: string
+      path?: string
+      uri?: string
+      hash?: string
+      hashType?: string
+      headers?: { [key: string]: any }
+      fields?: { [key: string]: any }
+      method?: string
+      progress?: number
+      isLastUpdated?: boolean
+      [key: string]: any
+    }>
     /* File upload complete result will be stored in Data */
-    uploadResult?: () => Data
+    uploadResult?: () => Data<any>
     /* File download progress result will be stored in Data */
-    downloadProgress?: () => Data
+    downloadProgress?: () => Data<{
+      id?: string
+      path?: string
+      uri?: string
+      hash?: string
+      hashType?: string
+      headers?: { [key: string]: any }
+      fields?: { [key: string]: any }
+      method?: string
+      progress?: number
+      isLastUpdated?: boolean
+      [key: string]: any
+    }>
     /* File download complete result will be stored in Data */
-    downloadResult?: () => Data
+    downloadResult?: () => Data<any>
   }
 }
 
-/* File handling */
+/* File system operations: read, write, copy, delete, and list files */
 export type GeneratorFile = Generator &
   GeneratorFileDef & {
     templateKey: 'GENERATOR_FILE'

package/types/generators/GraphQl.ts

@@ -1,4 +1,7 @@
-/* Auto generated by build script */
+/* 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 {
@@ -10,6 +13,7 @@ import type {
   Action,
   EventProperty,
 } from '../common'
+import type { TemplateEventPropsMap } from '../../utils/event-props'
 
 /* Execute GraphQL request with defined properties */
 export type GeneratorGraphQLActionRunQuery = ActionWithParams & {
@@ -93,17 +97,19 @@ Default property:
     /* Event triggered when subscription connection is successful */
     subscriptionOnConnection?: Array<EventAction>
     /* Event triggered when subscription connection error occurs */
-    subscriptionOnConnectionError?: Array<EventAction>
+    subscriptionOnConnectionError?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['Graphql']['subscriptionOnConnectionError']>
+    >
   }
   outlets?: {
     /* Response for GraphQL request, it will save to Data */
-    response?: () => Data
+    response?: () => Data<{ [key: string]: any }>
     /* Server response error of GraphQL request,    it will save to Data */
-    error?: () => Data
+    error?: () => Data<string>
   }
 }
 
-/* Execute GraphQL Query / Mutation / Subscriptions */
+/* 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'

package/types/generators/Http.ts

@@ -1,4 +1,7 @@
-/* Auto generated by build script */
+/* 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 {
@@ -10,6 +13,7 @@ import type {
   Action,
   EventProperty,
 } from '../common'
+import type { TemplateEventPropsMap } from '../../utils/event-props'
 
 /* Run HTTP request with defined properties */
 export type GeneratorHTTPActionRunRequest = ActionWithParams & {
@@ -141,7 +145,7 @@ Default property:
     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`)  
+    /* 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 */
@@ -156,21 +160,40 @@ Default property:
   events?: {}
   outlets?: {
     /* Response for HTTP request */
-    response?: () => Data
+    response?: () => Data<string | { [key: string]: any }>
     /* Response details for HTTP request */
-    responseDetails?: () => Data
+    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
+    eventLog?: () => Data<Array<any>>
     /* All received event details from event stream */
-    eventLogDetails?: () => Data
+    eventLogDetails?: () => Data<
+      Array<{
+        event?: string
+        id?: string
+        data?: any
+        [key: string]: any
+      }>
+    >
     /* EventSource state */
-    sseState?: () => Data
+    sseState?: () => Data<string>
     /* Server response error of HTTP request */
-    error?: () => Data
+    error?: () => Data<string>
   }
 }
 
-/* Execute HTTP requests */
+/* 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'

package/types/generators/HttpServer.ts

@@ -1,4 +1,7 @@
-/* Auto generated by build script */
+/* 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 {
@@ -10,6 +13,7 @@ import type {
   Action,
   EventProperty,
 } from '../common'
+import type { TemplateEventPropsMap } from '../../utils/event-props'
 
 /* Start HTTP server */
 export type GeneratorHTTPServerActionStart = Action & {
@@ -70,7 +74,7 @@ Default property:
     idleTimeout?: number | DataLink
     /* HTTP request body limit, 0 is unlimited */
     bodyLimit?: number | DataLink
-    /* CORS allowed origins  
+    /* CORS allowed origins
   You can use wildcard like `*`, `*.example.com`, `http://*.example.com` */
     corsOrigins?: Array<string | DataLink> | DataLink
     /* Authorization type of HTTP request */
@@ -81,15 +85,15 @@ Default property:
     basicAuthPassword?: string | DataLink
     /* Token of bearer auth */
     bearerToken?: string | DataLink
-    /* Asynchronous response mode  
+    /* Asynchronous response mode
   Will block connection until Response Body update. */
     asyncMode?: boolean | DataLink
-    /* Save request body as file  
+    /* 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  
+    /* 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. */
@@ -123,29 +127,33 @@ Default property:
     /* Event of HTTP server is ready */
     onReady?: Array<EventAction>
     /* Event of HTTP server accept the request */
-    onRequest?: Array<EventAction>
+    onRequest?: Array<EventAction<string & keyof TemplateEventPropsMap['HttpServer']['onRequest']>>
     /* Event of client close connection */
-    onClientClose?: Array<EventAction>
+    onClientClose?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['HttpServer']['onClientClose']>
+    >
     /* Event of client error */
-    onClientError?: Array<EventAction>
+    onClientError?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['HttpServer']['onClientError']>
+    >
     /* Event of server close */
     onClose?: Array<EventAction>
     /* Event of server error */
-    onError?: Array<EventAction>
+    onError?: Array<EventAction<string & keyof TemplateEventPropsMap['HttpServer']['onError']>>
   }
   outlets?: {
     /* Server is listening */
-    isListening?: () => Data
+    isListening?: () => Data<boolean>
     /* Query of request */
-    requestQuery?: () => Data
+    requestQuery?: () => Data<{ [key: string]: any }>
     /* Body of request */
-    requestBody?: () => Data
+    requestBody?: () => Data<any>
     /* Remote address of request */
-    clientAddress?: () => Data
+    clientAddress?: () => Data<string>
   }
 }
 
-/* HTTP Server */
+/* 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'

package/types/generators/Information.ts

@@ -1,4 +1,7 @@
-/* Auto generated by build script */
+/* 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 {
@@ -10,6 +13,7 @@ import type {
   Action,
   EventProperty,
 } from '../common'
+import type { TemplateEventPropsMap } from '../../utils/event-props'
 
 /* Show information */
 export type GeneratorInformationActionShow = ActionWithParams & {
@@ -68,15 +72,15 @@ Default property:
     /* Trigger when user confirms the information */
     onConfirm?: Array<EventAction>
     /* Trigger when error occurs */
-    onError?: Array<EventAction>
+    onError?: Array<EventAction<string & keyof TemplateEventPropsMap['Information']['onError']>>
   }
   outlets?: {
     /* Error message */
-    errorMessage?: () => Data
+    errorMessage?: () => Data<string>
   }
 }
 
-/* Show information */
+/* Display informational dialog or toast messages to the user */
 export type GeneratorInformation = Generator &
   GeneratorInformationDef & {
     templateKey: 'GENERATOR_INFORMATION'

package/types/generators/Intent.ts

@@ -1,4 +1,7 @@
-/* Auto generated by build script */
+/* Auto generated by build script
+ *
+ * Send intent to app and get result (Android only)
+ */
 import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
 import type { Data, DataLink } from '../data'
 import type {
@@ -10,6 +13,7 @@ import type {
   Action,
   EventProperty,
 } from '../common'
+import type { TemplateEventPropsMap } from '../../utils/event-props'
 
 /* Read stats */
 export type GeneratorIntentActionSendIntent = ActionWithParams & {
@@ -125,13 +129,19 @@ Default property:
   }
   events?: {
     /* On intent return a result trigger */
-    onResult?: Array<EventAction>
+    onResult?: Array<EventAction<string & keyof TemplateEventPropsMap['Intent']['onResult']>>
     /* On intent error trigger */
-    onError?: Array<EventAction>
+    onError?: Array<EventAction<string & keyof TemplateEventPropsMap['Intent']['onError']>>
   }
   outlets?: {
     /* Last intent result */
-    result?: () => Data
+    result?: () => Data<{
+      action?: string
+      data?: string
+      type?: string
+      extras?: { [key: string]: any }
+      [key: string]: any
+    }>
   }
 }
 

package/types/generators/Iterator.ts

@@ -1,4 +1,7 @@
-/* Auto generated by build script */
+/* Auto generated by build script
+ *
+ * Iterate through values (Array, Object, Number, String)
+ */
 import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
 import type { Data, DataLink } from '../data'
 import type {
@@ -10,6 +13,7 @@ import type {
   Action,
   EventProperty,
 } from '../common'
+import type { TemplateEventPropsMap } from '../../utils/event-props'
 
 /* Proceed to next iteration */
 export type GeneratorIteratorActionNext = Action & {
@@ -59,25 +63,25 @@ Default property:
   }
   events?: {
     /* Event triggered on each iteration */
-    iterate?: Array<EventAction>
+    iterate?: Array<EventAction<string & keyof TemplateEventPropsMap['Iterator']['iterate']>>
     /* Event triggered on the first iteration of a round */
-    first?: Array<EventAction>
+    first?: Array<EventAction<string & keyof TemplateEventPropsMap['Iterator']['first']>>
     /* Event triggered on the last iteration of a round */
-    end?: Array<EventAction>
+    end?: Array<EventAction<string & keyof TemplateEventPropsMap['Iterator']['end']>>
     /* Event triggered when data type is invalid or unexpected */
-    error?: Array<EventAction>
+    error?: Array<EventAction<string & keyof TemplateEventPropsMap['Iterator']['error']>>
   }
   outlets?: {
     /* Elements that have been iterated (including current one) */
-    iteratedArray?: () => Data
+    iteratedArray?: () => Data<Array<any>>
     /* Elements that will be iterated but have not been iterated yet */
-    upcomingArray?: () => Data
+    upcomingArray?: () => Data<Array<any>>
     /* Current iteration element */
-    value?: () => Data
+    value?: () => Data<any>
     /* Key of the current iteration element (for number: same as value, for array/string: index, for object: string key) */
-    key?: () => Data
+    key?: () => Data<any>
     /* Current iteration count (if data is 6 and step is 2, this will return: 1,2,3 in sequence) */
-    index?: () => Data
+    index?: () => Data<number>
   }
 }