@fugood/bricks-project 2.21.0 → 2.21.2

package/types/system.ts

@@ -1,4 +1,11 @@
-import type { Action, ActionWithDataParams, ActionWithParams, Brick, Generator } from './common'
+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'
@@ -9,27 +16,27 @@ export type SystemActionPropertyBankExpression = ActionWithParams & {
   params?: Array<
     | {
         input: 'expression'
-        value?: string | DataLink
+        value?: string | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'variables'
-        value?: {} | DataLink
+        value?: {} | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'result'
-        value?: string | DataLink | (() => Data)
+        value?: string | DataLink | (() => Data) | EventProperty
         mapping?: string
       }
     | {
         input: 'resultAssignPath'
-        value?: string | DataLink
+        value?: string | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'errorResult'
-        value?: string | DataLink | (() => Data)
+        value?: string | DataLink | (() => Data) | EventProperty
         mapping?: string
       }
   >
@@ -51,27 +58,27 @@ export type SystemActionDynamicBrick = ActionWithParams & {
   params?: Array<
     | {
         input: 'addList'
-        value?: string | DataLink
+        value?: string | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'preferAfterItemId'
-        value?: string | DataLink
+        value?: string | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'reset'
-        value?: boolean | DataLink
+        value?: boolean | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'removeItemId'
-        value?: string | DataLink
+        value?: string | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'removeItems'
-        value?: string | DataLink
+        value?: string | DataLink | EventProperty
         mapping?: string
       }
   >
@@ -88,22 +95,22 @@ export type SystemActionDynamicAnimation = ActionWithParams & {
   params?: Array<
     | {
         input: 'brickId'
-        value?: string | DataLink | (() => Brick)
+        value?: string | DataLink | (() => Brick) | EventProperty
         mapping?: string
       }
     | {
         input: 'animationId'
-        value?: string | DataLink | (() => Animation)
+        value?: string | DataLink | (() => Animation) | EventProperty
         mapping?: string
       }
     | {
         input: 'runType'
-        value?: 'once' | 'loop' | DataLink
+        value?: 'once' | 'loop' | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'resetInitialValue'
-        value?: boolean | DataLink
+        value?: boolean | DataLink | EventProperty
         mapping?: string
       }
   >
@@ -114,7 +121,7 @@ export type SystemActionDynamicAnimationReset = ActionWithParams & {
   __actionName: 'DYNAMIC_ANIMATION_RESET'
   params?: Array<{
     input: 'dynamicAnimationBrickId'
-    value?: string | DataLink | (() => Brick)
+    value?: string | DataLink | (() => Brick) | EventProperty
     mapping?: string
   }>
 }
@@ -124,7 +131,7 @@ export type SystemActionDynamicAnimationStop = ActionWithParams & {
   __actionName: 'DYNAMIC_ANIMATION_STOP'
   params?: Array<{
     input: 'dynamicAnimationBrickId'
-    value?: string | DataLink | (() => Brick)
+    value?: string | DataLink | (() => Brick) | EventProperty
     mapping?: string
   }>
 }
@@ -135,22 +142,22 @@ export type SystemActionChangeCanvas = ActionWithParams & {
   params?: Array<
     | {
         input: 'canvasId'
-        value?: string | DataLink | (() => Canvas)
+        value?: string | DataLink | (() => Canvas) | EventProperty
         mapping?: string
       }
     | {
         input: 'canvasTitleLike'
-        value?: string | DataLink
+        value?: string | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'canvasKeyMapList'
-        value?: {} | DataLink
+        value?: {} | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'canvasKey'
-        value?: string | DataLink
+        value?: string | DataLink | EventProperty
         mapping?: string
       }
   >
@@ -168,16 +175,17 @@ export type SystemActionMessage = ActionWithParams & {
           | 'SYSTEM_MESSAGE_TYPE_WARNING'
           | 'SYSTEM_MESSAGE_TYPE_ERROR'
           | DataLink
+          | EventProperty
         mapping?: string
       }
     | {
         input: 'title'
-        value?: string | DataLink
+        value?: string | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'message'
-        value?: string | DataLink
+        value?: string | DataLink | EventProperty
         mapping?: string
       }
   >
@@ -189,42 +197,42 @@ export type SystemActionAlert = ActionWithParams & {
   params?: Array<
     | {
         input: 'id'
-        value?: string | DataLink
+        value?: string | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'type'
-        value?: 'info' | 'success' | 'warning' | 'error' | DataLink
+        value?: 'info' | 'success' | 'warning' | 'error' | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'title'
-        value?: string | DataLink
+        value?: string | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'message'
-        value?: string | DataLink
+        value?: string | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'selections'
-        value?: {} | DataLink
+        value?: {} | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'selectionResult'
-        value?: string | DataLink | (() => Data)
+        value?: string | DataLink | (() => Data) | EventProperty
         mapping?: string
       }
     | {
         input: 'timeout'
-        value?: number | DataLink
+        value?: number | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'hideSelections'
-        value?: boolean | DataLink
+        value?: boolean | DataLink | EventProperty
         mapping?: string
       }
   >
@@ -236,12 +244,12 @@ export type SystemActionPopupReset = ActionWithParams & {
   params?: Array<
     | {
         input: 'popupClearType'
-        value?: 'all' | 'alert' | 'generator' | DataLink
+        value?: 'all' | 'alert' | 'generator' | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'popupId'
-        value?: string | DataLink
+        value?: string | DataLink | EventProperty
         mapping?: string
       }
   >
@@ -253,37 +261,128 @@ export type SystemActionTakeScreenshot = ActionWithParams & {
   params?: Array<
     | {
         input: 'currentSubspace'
-        value?: boolean | DataLink
+        value?: boolean | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'brickId'
-        value?: string | DataLink | (() => Brick)
+        value?: string | DataLink | (() => Brick) | EventProperty
         mapping?: string
       }
     | {
         input: 'format'
-        value?: 'jpg' | 'png' | DataLink
+        value?: 'jpg' | 'png' | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'quality'
-        value?: number | DataLink
+        value?: number | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'width'
-        value?: number | DataLink
+        value?: number | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'height'
-        value?: number | DataLink
+        value?: number | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'saveProperty'
-        value?: string | DataLink | (() => Data)
+        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
       }
   >
@@ -295,42 +394,42 @@ export type SystemActionChannelSubscribe = ActionWithParams & {
   params?: Array<
     | {
         input: 'key'
-        value?: string | DataLink
+        value?: string | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'type'
-        value?: 'on' | 'once' | DataLink
+        value?: 'on' | 'once' | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'livetime'
-        value?: number | DataLink
+        value?: number | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'dataResult'
-        value?: string | DataLink | (() => Data)
+        value?: string | DataLink | (() => Data) | EventProperty
         mapping?: string
       }
     | {
         input: 'dataAssignList'
-        value?: {} | DataLink
+        value?: {} | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'progressResult'
-        value?: string | DataLink | (() => Data)
+        value?: string | DataLink | (() => Data) | EventProperty
         mapping?: string
       }
     | {
         input: 'progressAssignList'
-        value?: {} | DataLink
+        value?: {} | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'errorResult'
-        value?: string | DataLink | (() => Data)
+        value?: string | DataLink | (() => Data) | EventProperty
         mapping?: string
       }
   >
@@ -341,7 +440,7 @@ export type SystemActionChannelUnsubscribe = ActionWithParams & {
   __actionName: 'CHANNEL_UNSUBSCRIBE'
   params?: Array<{
     input: 'keyMatch'
-    value?: string | DataLink
+    value?: string | DataLink | EventProperty
     mapping?: string
   }>
 }
@@ -352,17 +451,17 @@ export type SystemActionChannelPublish = ActionWithParams & {
   params?: Array<
     | {
         input: 'keyMatch'
-        value?: string | DataLink
+        value?: string | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'payloadType'
-        value?: 'result' | 'progress' | 'error' | DataLink
+        value?: 'result' | 'progress' | 'error' | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'payload'
-        value?: string | DataLink
+        value?: string | DataLink | EventProperty
         mapping?: string
       }
   >
@@ -374,32 +473,32 @@ export type SystemActionUseShareApplication = ActionWithParams & {
   params?: Array<
     | {
         input: 'applicationId'
-        value?: string | DataLink
+        value?: string | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'releaseVersion'
-        value?: string | DataLink
+        value?: string | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'useType'
-        value?: 'run' | 'use-after-bind' | 'cancel-use' | DataLink
+        value?: 'run' | 'use-after-bind' | 'cancel-use' | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'viewportPresetNameLike'
-        value?: string | DataLink
+        value?: string | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'viewportPresetDeviceTarget'
-        value?: string | DataLink
+        value?: string | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'enableLocalSync'
-        value?: boolean | DataLink
+        value?: boolean | DataLink | EventProperty
         mapping?: string
       }
   >
@@ -421,17 +520,17 @@ export type SystemActionOpenUrl = ActionWithParams & {
   params?: Array<
     | {
         input: 'url'
-        value?: string | DataLink
+        value?: string | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'behavior'
-        value?: 'in-app' | 'new-window' | DataLink
+        value?: 'in-app' | 'new-window' | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'inAppTintColor'
-        value?: string | DataLink
+        value?: string | DataLink | EventProperty
         mapping?: string
       }
   >
@@ -443,37 +542,37 @@ export type SystemActionOpenFile = ActionWithParams & {
   params?: Array<
     | {
         input: 'pickType'
-        value?: 'file' | 'multiple' | 'directory' | DataLink
+        value?: 'file' | 'multiple' | 'directory' | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'fileType'
-        value?: any
+        value?: any | EventProperty
         mapping?: string
       }
     | {
         input: 'copyTo'
-        value?: 'cache' | 'document' | DataLink
+        value?: 'cache' | 'document' | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'mode'
-        value?: 'import' | 'open' | DataLink
+        value?: 'import' | 'open' | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'saveProperty'
-        value?: string | DataLink | (() => Data)
+        value?: string | DataLink | (() => Data) | EventProperty
         mapping?: string
       }
     | {
         input: 'saveDetailProperty'
-        value?: string | DataLink | (() => Data)
+        value?: string | DataLink | (() => Data) | EventProperty
         mapping?: string
       }
     | {
         input: 'errorSaveProperty'
-        value?: string | DataLink | (() => Data)
+        value?: string | DataLink | (() => Data) | EventProperty
         mapping?: string
       }
   >
@@ -485,12 +584,12 @@ export type SystemActionThrowException = ActionWithParams & {
   params?: Array<
     | {
         input: 'behavior'
-        value?: 'application' | 'application-render' | 'native' | DataLink
+        value?: 'application' | 'application-render' | 'native' | DataLink | EventProperty
         mapping?: string
       }
     | {
         input: 'exceptionMessage'
-        value?: string | DataLink
+        value?: string | DataLink | EventProperty
         mapping?: string
       }
   >