@appsemble/types 0.19.8 → 0.19.12

package/dist/index.d.ts

@@ -255,8 +255,10 @@ export interface Remappers {
     static: any;
     /**
      * Get a property from an object.
+     *
+     * If the prop is an array, nested properties will be retrieved in sequence.
      */
-    prop: number | string;
+    prop: number[] | string[] | number | string;
     /**
      * Recursively strip all nullish values from an object or array.
      */
@@ -455,6 +457,16 @@ export interface BaseActionDefinition<T extends Action['type']> {
      */
     onError?: ActionDefinition;
 }
+export interface AnalyticsAction extends BaseActionDefinition<'analytics'> {
+    /**
+     * The analytics event target name.
+     */
+    target: string;
+    /**
+     * Additional config to pass to analytics.
+     */
+    config?: Remapper;
+}
 export interface ConditionActionDefinition extends BaseActionDefinition<'condition'> {
     /**
      * The condition to check for.
@@ -492,6 +504,12 @@ export interface EmailActionDefinition extends BaseActionDefinition<'email'> {
      * The recipient of the email.
      */
     to?: Remapper;
+    /**
+     * The name of the sender.
+     *
+     * The default value depends on the email server.
+     */
+    from?: Remapper;
     /**
      * The recipients to CC the email to.
      */
@@ -551,11 +569,18 @@ export interface ShareActionDefinition extends BaseActionDefinition<'share'> {
      */
     title?: Remapper;
 }
+declare type StorageType = 'indexedDB' | 'localStorage' | 'sessionStorage';
 export interface StorageReadActionDefinition extends BaseActionDefinition<'storage.read'> {
     /**
      * The key of the entry to read from the app’s storage.
      */
     key: Remapper;
+    /**
+     * The mechanism used to read the data from.
+     *
+     * @default 'indexedDB'
+     */
+    storage?: StorageType;
 }
 export interface StorageWriteActionDefinition extends BaseActionDefinition<'storage.write'> {
     /**
@@ -566,6 +591,12 @@ export interface StorageWriteActionDefinition extends BaseActionDefinition<'stor
      * The data to write to the app’s storage.
      */
     value: Remapper;
+    /**
+     * The mechanism used to read the data from.
+     *
+     * @default 'indexedDB'
+     */
+    storage?: StorageType;
 }
 export interface UserLoginAction extends BaseActionDefinition<'user.login'> {
     /**
@@ -710,7 +741,7 @@ export declare type MessageActionDefinition = BaseActionDefinition<'message'> &
      */
     body: Remapper;
 };
-export declare type ActionDefinition = BaseActionDefinition<'dialog.error'> | BaseActionDefinition<'dialog.ok'> | BaseActionDefinition<'flow.back'> | BaseActionDefinition<'flow.cancel'> | BaseActionDefinition<'flow.finish'> | BaseActionDefinition<'flow.next'> | BaseActionDefinition<'link.back'> | BaseActionDefinition<'link.next'> | BaseActionDefinition<'noop'> | BaseActionDefinition<'team.join'> | BaseActionDefinition<'team.list'> | BaseActionDefinition<'throw'> | ConditionActionDefinition | DialogActionDefinition | EmailActionDefinition | EventActionDefinition | FlowToActionDefinition | LinkActionDefinition | LogActionDefinition | MessageActionDefinition | RequestActionDefinition | ResourceCountActionDefinition | ResourceCreateActionDefinition | ResourceDeleteActionDefinition | ResourceGetActionDefinition | ResourceQueryActionDefinition | ResourceSubscriptionStatusActionDefinition | ResourceSubscriptionSubscribeActionDefinition | ResourceSubscriptionToggleActionDefinition | ResourceSubscriptionUnsubscribeActionDefinition | ResourceUpdateActionDefinition | ShareActionDefinition | StaticActionDefinition | StorageReadActionDefinition | StorageWriteActionDefinition | UserLoginAction | UserRegisterAction | UserUpdateAction;
+export declare type ActionDefinition = AnalyticsAction | BaseActionDefinition<'dialog.error'> | BaseActionDefinition<'dialog.ok'> | BaseActionDefinition<'flow.back'> | BaseActionDefinition<'flow.cancel'> | BaseActionDefinition<'flow.finish'> | BaseActionDefinition<'flow.next'> | BaseActionDefinition<'link.back'> | BaseActionDefinition<'link.next'> | BaseActionDefinition<'noop'> | BaseActionDefinition<'team.join'> | BaseActionDefinition<'team.list'> | BaseActionDefinition<'throw'> | ConditionActionDefinition | DialogActionDefinition | EmailActionDefinition | EventActionDefinition | FlowToActionDefinition | LinkActionDefinition | LogActionDefinition | MessageActionDefinition | RequestActionDefinition | ResourceCountActionDefinition | ResourceCreateActionDefinition | ResourceDeleteActionDefinition | ResourceGetActionDefinition | ResourceQueryActionDefinition | ResourceSubscriptionStatusActionDefinition | ResourceSubscriptionSubscribeActionDefinition | ResourceSubscriptionToggleActionDefinition | ResourceSubscriptionUnsubscribeActionDefinition | ResourceUpdateActionDefinition | ShareActionDefinition | StaticActionDefinition | StorageReadActionDefinition | StorageWriteActionDefinition | UserLoginAction | UserRegisterAction | UserUpdateAction;
 export interface ActionType {
     /**
      * Whether or not app creators are required to define this action.
@@ -983,6 +1014,10 @@ export interface App {
      */
     id?: number;
     domain?: string;
+    /**
+     * The name used for emails
+     */
+    emailName?: string;
     /**
      * The id of the organization this app belongs to.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/types",
-  "version": "0.19.8",
+  "version": "0.19.12",
   "description": "TypeScript definitions reused within Appsemble internally",
   "keywords": [
     "app",
@@ -30,10 +30,10 @@
     "test": "jest"
   },
   "dependencies": {
-    "@appsemble/sdk": "0.19.8",
+    "@appsemble/sdk": "0.19.12",
     "@fortawesome/fontawesome-common-types": "^0.2.0",
     "jsonschema": "^1.0.0",
-    "openapi-types": "^9.0.0",
+    "openapi-types": "^10.0.0",
     "type-fest": "^2.0.0"
   }
 }