@fugood/bricks-ctor 2.24.0-beta.40

package/types/system.ts

@@ -0,0 +1,707 @@
+/* Auto generated by build script */
+import type {
+  Action,
+  ActionWithDataParams,
+  ActionWithParams,
+  Brick,
+  Generator,
+  EventProperty,
+} from './common'
+import type { Animation } from './animation'
+import type { Canvas } from './canvas'
+import type { Data, DataLink } from './data'
+
+/* Change Data value with script expression. One expression of return value */
+export type SystemActionPropertyBankExpression = ActionWithParams & {
+  __actionName: 'PROPERTY_BANK_EXPRESSION'
+  params?: Array<
+    | {
+        input: 'expression'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'variables'
+        value?:
+          | Array<{
+              id?: string
+              key?: string
+            }>
+          | DataLink
+          | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'result'
+        value?: string | DataLink | (() => Data) | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'resultAssignPath'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'errorResult'
+        value?: string | DataLink | (() => Data) | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Change Data value */
+export type SystemActionPropertyBank = ActionWithDataParams & {
+  __actionName: 'PROPERTY_BANK'
+}
+
+/* Trigger Data calculation flow without value change */
+export type SystemActionPropertyBankCommand = ActionWithDataParams & {
+  __actionName: 'PROPERTY_BANK_COMMAND'
+}
+
+/* [Unstable] Dynamically generate bricks */
+export type SystemActionDynamicBrick = ActionWithParams & {
+  __actionName: 'DYNAMIC_BRICK'
+  params?: Array<
+    | {
+        input: 'addList'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'preferAfterItemId'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'reset'
+        value?: boolean | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'removeItemId'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'removeItems'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* [Unstable] Reset Dynamic Bricks */
+export type SystemActionDynamicBrickReset = Action & {
+  __actionName: 'DYNAMIC_BRICK_RESET'
+}
+
+/* Run specific Animation on specific Brick */
+export type SystemActionDynamicAnimation = ActionWithParams & {
+  __actionName: 'DYNAMIC_ANIMATION'
+  params?: Array<
+    | {
+        input: 'brickId'
+        value?: string | DataLink | (() => Brick) | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'animationId'
+        value?: string | DataLink | (() => Animation) | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'runType'
+        value?: 'once' | 'loop' | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'resetInitialValue'
+        value?: boolean | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Reset Dynamic Animation */
+export type SystemActionDynamicAnimationReset = ActionWithParams & {
+  __actionName: 'DYNAMIC_ANIMATION_RESET'
+  params?: Array<{
+    input: 'dynamicAnimationBrickId'
+    value?: string | DataLink | (() => Brick) | EventProperty
+    mapping?: string
+  }>
+}
+
+/* Stop Dynamic Animation */
+export type SystemActionDynamicAnimationStop = ActionWithParams & {
+  __actionName: 'DYNAMIC_ANIMATION_STOP'
+  params?: Array<{
+    input: 'dynamicAnimationBrickId'
+    value?: string | DataLink | (() => Brick) | EventProperty
+    mapping?: string
+  }>
+}
+
+/* Change canvas on the current Subspace */
+export type SystemActionChangeCanvas = ActionWithParams & {
+  __actionName: 'CHANGE_CANVAS'
+  params?: Array<
+    | {
+        input: 'canvasId'
+        value?: string | DataLink | (() => Canvas) | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'canvasTitleLike'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'canvasKeyMapList'
+        value?:
+          | Array<{
+              key?: string
+              value?: string
+            }>
+          | DataLink
+          | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'canvasKey'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Log System message */
+export type SystemActionMessage = ActionWithParams & {
+  __actionName: 'MESSAGE'
+  params?: Array<
+    | {
+        input: 'type'
+        value?:
+          | 'SYSTEM_MESSAGE_TYPE_INFO'
+          | 'SYSTEM_MESSAGE_TYPE_SUCCESS'
+          | 'SYSTEM_MESSAGE_TYPE_WARNING'
+          | 'SYSTEM_MESSAGE_TYPE_ERROR'
+          | DataLink
+          | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'title'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'message'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Show system alert popup with custom message */
+export type SystemActionAlert = ActionWithParams & {
+  __actionName: 'ALERT'
+  params?: Array<
+    | {
+        input: 'id'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'type'
+        value?: 'info' | 'success' | 'warning' | 'error' | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'title'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'message'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'selections'
+        value?:
+          | Array<{
+              label?: string
+              color?: string
+              value?: string
+              disableResult?: boolean
+            }>
+          | DataLink
+          | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'selectionResult'
+        value?: string | DataLink | (() => Data) | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'timeout'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'hideSelections'
+        value?: boolean | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Close current showing popups with type or id. */
+export type SystemActionPopupReset = ActionWithParams & {
+  __actionName: 'POPUP_RESET'
+  params?: Array<
+    | {
+        input: 'popupClearType'
+        value?: 'all' | 'alert' | 'generator' | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'popupId'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Take screenshot for current subspace or the full viewport (including portal subspaces) */
+export type SystemActionTakeScreenshot = ActionWithParams & {
+  __actionName: 'TAKE_SCREENSHOT'
+  params?: Array<
+    | {
+        input: 'currentSubspace'
+        value?: boolean | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'brickId'
+        value?: string | DataLink | (() => Brick) | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'format'
+        value?: 'jpg' | 'png' | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'quality'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'width'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'height'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'saveProperty'
+        value?: string | DataLink | (() => Data) | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Store a value in application-specific storage */
+export type SystemActionStorageSet = ActionWithParams & {
+  __actionName: 'STORAGE_SET'
+  params?: Array<
+    | {
+        input: 'storageType'
+        value?: 'persist' | 'in-memory' | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'storageScope'
+        value?: 'global' | 'subspace' | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'storageKey'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'storageValue'
+        value?: any | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Retrieve a value from application-specific storage */
+export type SystemActionStorageRetrieve = ActionWithParams & {
+  __actionName: 'STORAGE_RETRIEVE'
+  params?: Array<
+    | {
+        input: 'storageType'
+        value?: 'persist' | 'in-memory' | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'storageScope'
+        value?: 'global' | 'subspace' | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'storageKey'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'result'
+        value?: string | DataLink | (() => Data) | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'defaultValue'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'skipIfNotFound'
+        value?: boolean | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Delete a value from application-specific storage or clear all values */
+export type SystemActionStorageDelete = ActionWithParams & {
+  __actionName: 'STORAGE_DELETE'
+  params?: Array<
+    | {
+        input: 'storageType'
+        value?: 'persist' | 'in-memory' | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'storageScope'
+        value?: 'global' | 'subspace' | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'storageKey'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'all'
+        value?: boolean | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Subscribe to a channel for data update */
+export type SystemActionChannelSubscribe = ActionWithParams & {
+  __actionName: 'CHANNEL_SUBSCRIBE'
+  params?: Array<
+    | {
+        input: 'key'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'type'
+        value?: 'on' | 'once' | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'livetime'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'dataResult'
+        value?: string | DataLink | (() => Data) | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'dataAssignList'
+        value?:
+          | Array<{
+              path?: string
+              type?: any
+              id?: string
+              required?: boolean
+            }>
+          | DataLink
+          | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'progressResult'
+        value?: string | DataLink | (() => Data) | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'progressAssignList'
+        value?:
+          | Array<{
+              path?: string
+              type?: any
+              id?: string
+              required?: boolean
+            }>
+          | DataLink
+          | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'errorResult'
+        value?: string | DataLink | (() => Data) | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Unsubscribe from a channel */
+export type SystemActionChannelUnsubscribe = ActionWithParams & {
+  __actionName: 'CHANNEL_UNSUBSCRIBE'
+  params?: Array<{
+    input: 'keyMatch'
+    value?: string | DataLink | EventProperty
+    mapping?: string
+  }>
+}
+
+/* Publish data to a channel */
+export type SystemActionChannelPublish = ActionWithParams & {
+  __actionName: 'CHANNEL_PUBLISH'
+  params?: Array<
+    | {
+        input: 'keyMatch'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'payloadType'
+        value?: 'result' | 'progress' | 'error' | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'payload'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Delay for a certain time between actions */
+export type SystemActionDelay = ActionWithParams & {
+  __actionName: 'DELAY'
+  params?: Array<{
+    input: 'time'
+    value?: number | DataLink | EventProperty
+    mapping?: string
+  }>
+}
+
+/* [Internal] Use a shared application */
+export type SystemActionUseShareApplication = ActionWithParams & {
+  __actionName: 'USE_SHARE_APPLICATION'
+  params?: Array<
+    | {
+        input: 'applicationId'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'releaseVersion'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'useType'
+        value?: 'run' | 'use-after-bind' | 'cancel-use' | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'viewportPresetNameLike'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'viewportPresetDeviceTarget'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'enableLocalSync'
+        value?: boolean | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* [Internal] Auth in device */
+export type SystemActionAuthInDevice = Action & {
+  __actionName: 'AUTH_IN_DEVICE'
+}
+
+/* [Internal] Refresh passcode for bind device */
+export type SystemActionRefreshBindcode = Action & {
+  __actionName: 'REFRESH_BINDCODE'
+}
+
+/* Open URL */
+export type SystemActionOpenUrl = ActionWithParams & {
+  __actionName: 'OPEN_URL'
+  params?: Array<
+    | {
+        input: 'url'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'behavior'
+        value?: 'in-app' | 'new-window' | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'inAppTintColor'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Open File or Directory */
+export type SystemActionOpenFile = ActionWithParams & {
+  __actionName: 'OPEN_FILE'
+  params?: Array<
+    | {
+        input: 'pickType'
+        value?: 'file' | 'multiple' | 'directory' | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'fileType'
+        value?: any | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'copyTo'
+        value?: 'cache' | 'document' | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'mode'
+        value?: 'import' | 'open' | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'saveProperty'
+        value?: string | DataLink | (() => Data) | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'saveDetailProperty'
+        value?: string | DataLink | (() => Data) | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'errorSaveProperty'
+        value?: string | DataLink | (() => Data) | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Throw exception */
+export type SystemActionThrowException = ActionWithParams & {
+  __actionName: 'THROW_EXCEPTION'
+  params?: Array<
+    | {
+        input: 'behavior'
+        value?: 'application' | 'native' | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'exceptionMessage'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Restart the foundation (React Native bundle) */
+export type SystemActionRestartFoundation = Action & {
+  __actionName: 'RESTART_FOUNDATION'
+}
+
+/* Dismiss keyboard */
+export type SystemActionDismissKeyboard = Action & {
+  __actionName: 'DISMISS_KEYBOARD'
+}
+
+/* Trigger application AI filter */
+export type SystemActionTriggerApplicationFilter = ActionWithParams & {
+  __actionName: 'TRIGGER_APPLICATION_FILTER'
+  params?: Array<
+    | {
+        input: 'name'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'variables'
+        value?: any | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'result'
+        value?: string | DataLink | (() => Data) | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'error'
+        value?: string | DataLink | (() => Data) | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Stop running application AI filter */
+export type SystemActionStopApplicationFilter = Action & {
+  __actionName: 'STOP_APPLICATION_FILTER'
+}
+
+/* Save update snapshot (from Application Filter or DevTools MCP Server) to media system */
+export type SystemActionSaveUpdateSnapshot = ActionWithParams & {
+  __actionName: 'SAVE_UPDATE_SNAPSHOT'
+  params?: Array<
+    | {
+        input: 'snapshotFileIndentifier'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'snapshotSaveResult'
+        value?: string | DataLink | (() => Data) | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'snapshotErrorResult'
+        value?: string | DataLink | (() => Data) | EventProperty
+        mapping?: string
+      }
+  >
+}