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

package/types/generators/File.ts

@@ -0,0 +1,351 @@
+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 GeneratorFileActionReadStats = Action & {
+  __actionName: 'GENERATOR_FILE_READ_STATS'
+}
+
+/* Read (Currently only support text file) */
+export type GeneratorFileActionReadContent = ActionWithParams & {
+  __actionName: 'GENERATOR_FILE_READ_CONTENT'
+  params?: Array<{
+    input: 'encoding'
+    value?: 'utf8' | 'base64' | DataLink | EventProperty
+    mapping?: string
+  }>
+}
+
+/* Delete */
+export type GeneratorFileActionDelete = Action & {
+  __actionName: 'GENERATOR_FILE_DELETE'
+}
+
+/* Append (Currently only support text file) */
+export type GeneratorFileActionAppendContent = ActionWithParams & {
+  __actionName: 'GENERATOR_FILE_APPEND_CONTENT'
+  params?: Array<
+    | {
+        input: 'content'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'encoding'
+        value?: 'utf8' | 'base64' | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'contentList'
+        value?: Array<any> | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Write (Currently only support text file) */
+export type GeneratorFileActionWriteContent = ActionWithParams & {
+  __actionName: 'GENERATOR_FILE_WRITE_CONTENT'
+  params?: Array<
+    | {
+        input: 'content'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'encoding'
+        value?: 'utf8' | 'base64' | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'position'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'contentList'
+        value?: Array<any> | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Start upload (All or By ID or By Index) */
+export type GeneratorFileActionStartUpload = ActionWithParams & {
+  __actionName: 'GENERATOR_FILE_START_UPLOAD'
+  params?: Array<
+    | {
+        input: 'withAll'
+        value?: boolean | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'withId'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'withIndex'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Stop upload (All or By ID or By Index) */
+export type GeneratorFileActionStopUpload = ActionWithParams & {
+  __actionName: 'GENERATOR_FILE_STOP_UPLOAD'
+  params?: Array<
+    | {
+        input: 'withAll'
+        value?: boolean | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'withId'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'withIndex'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Start download (All or By ID or By Index) */
+export type GeneratorFileActionStartDownload = ActionWithParams & {
+  __actionName: 'GENERATOR_FILE_START_DOWNLOAD'
+  params?: Array<
+    | {
+        input: 'withAll'
+        value?: boolean | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'withId'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'withIndex'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Stop download (All or By ID or By Index) */
+export type GeneratorFileActionStopDownload = ActionWithParams & {
+  __actionName: 'GENERATOR_FILE_STOP_DOWNLOAD'
+  params?: Array<
+    | {
+        input: 'withAll'
+        value?: boolean | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'withId'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'withIndex'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Clear download */
+export type GeneratorFileActionClearDownload = Action & {
+  __actionName: 'GENERATOR_FILE_CLEAR_DOWNLOAD'
+}
+
+interface GeneratorFileDef {
+  /*
+Default property:
+{
+  "type": "single",
+  "targetDirectory": "none",
+  "hashType": "sha256",
+  "header": {},
+  "fields": {},
+  "list": [],
+  "downloadAllowLoadSizeLimitExceed": false,
+  "downloadRetryCount": 3,
+  "downloadMode": "sequence",
+  "downloadProgressFrequency": 1000,
+  "uploadRetryCount": 3,
+  "uploadMode": "sequence",
+  "uploadProgressFrequency": 1000
+}
+  */
+  property?: {
+    /* Type (Single or Multiple) */
+    type?: 'single' | 'multiple' | DataLink
+    /* Target directory (Default: document directory in app) */
+    targetDirectory?: 'none' | 'custom' | 'document' | 'cache' | 'tmp' | DataLink
+    /* Target directory (Default: document directory in app) */
+    customTargetDirectory?: string | DataLink
+    /* File path (If type is single) */
+    path?: string | DataLink
+    /* File encoding (If type is single) */
+    encoding?: 'utf8' | 'base64' | DataLink
+    /* URL (If type is single) */
+    url?: string | DataLink
+    /* Hash value */
+    hash?: string | DataLink
+    /* Hash type */
+    hashType?: 'md5' | 'sha256' | 'sha1' | DataLink
+    /* Request method */
+    method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | DataLink
+    /* Header */
+    header?: {} | DataLink
+    /* Fields */
+    fields?: {} | DataLink
+    /* File list (If type is multiple) */
+    list?:
+      | Array<
+          | DataLink
+          | {
+              id?: string | DataLink
+              path?: string | DataLink
+              encoding?: 'utf8' | 'base64' | DataLink
+              url?: string | DataLink
+              hash?: string | DataLink
+              hashType?: 'sha256' | 'sha1' | 'md5' | DataLink
+              method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | DataLink
+              header?: {} | DataLink
+              fields?: {} | DataLink
+            }
+        >
+      | DataLink
+    /* Enable download (URL is required) */
+    downloadEnabled?: boolean | DataLink
+    /* Download load size limit */
+    downloadLoadSizeLimit?: number | DataLink
+    /* Download allow load size limit exceed */
+    downloadAllowLoadSizeLimitExceed?: boolean | DataLink
+    /* Download retry count */
+    downloadRetryCount?: number | DataLink
+    /* Download mode (if type is multiple) */
+    downloadMode?: 'concurrent' | 'sequence' | DataLink
+    /* Limit of download concurrent mode */
+    downloadConcurrentLimit?: number | DataLink
+    /* Download progress frequency */
+    downloadProgressFrequency?: number | DataLink
+    /* Enable upload (Path & URL is required) */
+    uploadEnabled?: boolean | DataLink
+    /* Upload retry count */
+    uploadRetryCount?: number | DataLink
+    /* Upload mode (if type is multiple) */
+    uploadMode?: 'concurrent' | 'sequence' | DataLink
+    /* Limit of upload concurrent mode */
+    uploadConcurrentLimit?: number | DataLink
+    /* Upload progress frequency */
+    uploadProgressFrequency?: number | DataLink
+  }
+  events?: {
+    /* On file handler init error */
+    initError?: Array<EventAction>
+    /* On file status change */
+    onFileStatusChange?: Array<EventAction>
+    /* On read stats error */
+    onReadStatsError?: Array<EventAction>
+    /* On read content error */
+    onReadContentError?: Array<EventAction>
+    /* On read content error */
+    onAppendContentError?: Array<EventAction>
+    /* On write content error */
+    onWriteContentError?: Array<EventAction>
+    /* On upload progress */
+    onUploadProgress?: Array<EventAction>
+    /* On upload error */
+    onUploadError?: Array<EventAction>
+    /* On upload complete */
+    onUploadComplete?: Array<EventAction>
+    /* On upload all done */
+    onUploadAllComplete?: Array<EventAction>
+    /* On download progress */
+    onDownloadProgress?: Array<EventAction>
+    /* On download error */
+    onDownloadError?: Array<EventAction>
+    /* On download complete */
+    onDownloadComplete?: Array<EventAction>
+    /* On download all done */
+    onDownloadAllComplete?: Array<EventAction>
+  }
+  outlets?: {
+    /* File init error result will be stored in Data */
+    initError?: () => Data
+    /* File read stats result will be stored in Data */
+    readStats?: () => Data
+    /* File read content result will be stored in Data */
+    readContent?: () => Data
+    /* File read details result will be stored in Data */
+    readDetails?: () => Data
+    /* File read error result will be stored in Data */
+    readError?: () => Data
+    /* File append content result will be stored in Data */
+    appendDetails?: () => Data
+    /* File append error result will be stored in Data */
+    appendError?: () => Data
+    /* File write details result will be stored in Data */
+    writeDetails?: () => Data
+    /* File write error result will be stored in Data */
+    writeError?: () => Data
+    /* File upload progress result will be stored in Data */
+    uploadProgress?: () => Data
+    /* File upload complete result will be stored in Data */
+    uploadResult?: () => Data
+    /* File download progress result will be stored in Data */
+    downloadProgress?: () => Data
+    /* File download complete result will be stored in Data */
+    downloadResult?: () => Data
+  }
+}
+
+/* File handling */
+export type GeneratorFile = Generator &
+  GeneratorFileDef & {
+    templateKey: 'GENERATOR_FILE'
+    switches: Array<
+      SwitchDef &
+        GeneratorFileDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet:
+                    | 'initError'
+                    | 'readStats'
+                    | 'readContent'
+                    | 'readDetails'
+                    | 'readError'
+                    | 'appendDetails'
+                    | 'appendError'
+                    | 'writeDetails'
+                    | 'writeError'
+                    | 'uploadProgress'
+                    | 'uploadResult'
+                    | 'downloadProgress'
+                    | 'downloadResult'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/generators/GraphQl.ts

@@ -0,0 +1,124 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+/* 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>
+  }
+  outlets?: {
+    /* Response for GraphQL request, it will save to Data */
+    response?: () => Data
+    /* Server response error of GraphQL request,    it will save to Data */
+    error?: () => Data
+  }
+}
+
+/* Execute GraphQL Query / Mutation / Subscriptions */
+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,117 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+/* Run HTTP request with defined properties */
+export type GeneratorHTTPActionRunRequest = Action & {
+  __actionName: 'GENERATOR_HTTP_RUN_REQUEST'
+}
+
+/* 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?: any
+    /* HTTP response type */
+    resType?: 'json' | 'text' | 'xml' | 'csv' | 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
+    /* Response details for HTTP request */
+    responseDetails?: () => Data
+    /* All received data from event stream */
+    eventLog?: () => Data
+    /* All received event details from event stream */
+    eventLogDetails?: () => Data
+    /* EventSource state */
+    sseState?: () => Data
+    /* Server response error of HTTP request */
+    error?: () => Data
+  }
+}
+
+/* Execute HTTP requests */
+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
+                }
+          }>
+        }
+    >
+  }