@fugood/bricks-ctor 2.24.0-beta.40

package/types/generators/DataBank.ts

@@ -0,0 +1,160 @@
+/* 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 {
+  Brick,
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+import type { TemplateEventPropsMap } from '../../utils/event-props'
+
+/* 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<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<string & keyof TemplateEventPropsMap['DataBank']['onError']>>
+    /* Event of subscription on connection */
+    subscribeDataOnConnect?: Array<EventAction>
+    /* Server connections error of subscription */
+    subscribeDataOnConnectError?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['DataBank']['subscribeDataOnConnectError']>
+    >
+  }
+  outlets?: {
+    /* Response for Data Bank fetch request, it will save to 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<string>
+  }
+}
+
+/* Access and subscribe to shared Data properties from the project 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
+                }
+          }>
+        }
+    >
+  }

package/types/generators/File.ts

@@ -0,0 +1,432 @@
+/* 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 {
+  Brick,
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+import type { TemplateEventPropsMap } from '../../utils/event-props'
+
+/* 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<string & keyof TemplateEventPropsMap['File']['initError']>>
+    /* On file status change */
+    onFileStatusChange?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['File']['onFileStatusChange']>
+    >
+    /* On read stats error */
+    onReadStatsError?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['File']['onReadStatsError']>
+    >
+    /* On read content error */
+    onReadContentError?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['File']['onReadContentError']>
+    >
+    /* On read content error */
+    onAppendContentError?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['File']['onAppendContentError']>
+    >
+    /* On write content error */
+    onWriteContentError?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['File']['onWriteContentError']>
+    >
+    /* On upload progress */
+    onUploadProgress?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['File']['onUploadProgress']>
+    >
+    /* On upload error */
+    onUploadError?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['File']['onUploadError']>
+    >
+    /* On upload complete */
+    onUploadComplete?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['File']['onUploadComplete']>
+    >
+    /* On upload all done */
+    onUploadAllComplete?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['File']['onUploadAllComplete']>
+    >
+    /* On download progress */
+    onDownloadProgress?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['File']['onDownloadProgress']>
+    >
+    /* On download error */
+    onDownloadError?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['File']['onDownloadError']>
+    >
+    /* On download complete */
+    onDownloadComplete?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['File']['onDownloadComplete']>
+    >
+    /* On download all done */
+    onDownloadAllComplete?: Array<
+      EventAction<string & keyof TemplateEventPropsMap['File']['onDownloadAllComplete']>
+    >
+  }
+  outlets?: {
+    /* File init error result will be stored in Data */
+    initError?: () => Data<string>
+    /* File read stats result will be stored in 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<any>
+    /* File read details result will be stored in 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<string>
+    /* File append content result will be stored in Data */
+    appendDetails?: () => Data<{
+      path?: string
+      appended?: boolean
+      contentLength?: number
+      [key: string]: any
+    }>
+    /* File append error result will be stored in Data */
+    appendError?: () => Data<string>
+    /* File write details result will be stored in Data */
+    writeDetails?: () => Data<{
+      path?: string
+      written?: boolean
+      contentLength?: number
+      [key: string]: any
+    }>
+    /* File write error result will be stored in Data */
+    writeError?: () => Data<string>
+    /* File upload progress result will be stored in 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<any>
+    /* File download progress result will be stored in 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<any>
+  }
+}
+
+/* File system operations: read, write, copy, delete, and list files */
+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
+                }
+          }>
+        }
+    >
+  }