@appsemble/types 0.20.15 → 0.20.17

package/README.md

@@ -1,10 +1,10 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.20.15/config/assets/logo.svg) Appsemble Types
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.20.17/config/assets/logo.svg) Appsemble Types
 
 > Reusable TypeScript types
 
 [![npm](https://img.shields.io/npm/v/@appsemble/types)](https://www.npmjs.com/package/@appsemble/types)
-[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.20.15/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.20.15)
-[![Code coverage](https://codecov.io/gl/appsemble/appsemble/branch/0.20.15/graph/badge.svg)](https://codecov.io/gl/appsemble/appsemble)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.20.17/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.20.17)
+[![Code coverage](https://codecov.io/gl/appsemble/appsemble/branch/0.20.17/graph/badge.svg)](https://codecov.io/gl/appsemble/appsemble)
 [![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io)
 
 ## Installation
@@ -21,5 +21,5 @@ not guaranteed.
 
 ## License
 
-[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.20.15/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.20.17/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/action.d.ts

@@ -42,5 +42,5 @@ export declare type ResourceUpdateAction = RequestLikeAction<'resource.update'>;
 /**
  * An action that can be called from within a block.
  */
-export declare type Action = BaseAction<'analytics'> | BaseAction<'condition'> | BaseAction<'dialog.error'> | BaseAction<'dialog.ok'> | BaseAction<'dialog'> | BaseAction<'download'> | BaseAction<'email'> | BaseAction<'event'> | BaseAction<'flow.back'> | BaseAction<'flow.cancel'> | BaseAction<'flow.finish'> | BaseAction<'flow.next'> | BaseAction<'flow.to'> | BaseAction<'link.back'> | BaseAction<'link.next'> | BaseAction<'message'> | BaseAction<'noop'> | BaseAction<'resource.subscription.status'> | BaseAction<'resource.subscription.subscribe'> | BaseAction<'resource.subscription.toggle'> | BaseAction<'resource.subscription.unsubscribe'> | BaseAction<'share'> | BaseAction<'static'> | BaseAction<'storage.read'> | BaseAction<'storage.write'> | BaseAction<'team.invite'> | BaseAction<'team.join'> | BaseAction<'team.list'> | BaseAction<'throw'> | BaseAction<'user.login'> | BaseAction<'user.register'> | BaseAction<'user.update'> | LinkAction | LogAction | RequestAction | ResourceCountAction | ResourceCreateAction | ResourceDeleteAction | ResourceGetAction | ResourceQueryAction | ResourceUpdateAction;
+export declare type Action = BaseAction<'analytics'> | BaseAction<'condition'> | BaseAction<'dialog.error'> | BaseAction<'dialog.ok'> | BaseAction<'dialog'> | BaseAction<'download'> | BaseAction<'each'> | BaseAction<'email'> | BaseAction<'event'> | BaseAction<'flow.back'> | BaseAction<'flow.cancel'> | BaseAction<'flow.finish'> | BaseAction<'flow.next'> | BaseAction<'flow.to'> | BaseAction<'link.back'> | BaseAction<'link.next'> | BaseAction<'message'> | BaseAction<'noop'> | BaseAction<'resource.subscription.status'> | BaseAction<'resource.subscription.subscribe'> | BaseAction<'resource.subscription.toggle'> | BaseAction<'resource.subscription.unsubscribe'> | BaseAction<'share'> | BaseAction<'static'> | BaseAction<'storage.read'> | BaseAction<'storage.write'> | BaseAction<'team.invite'> | BaseAction<'team.join'> | BaseAction<'team.list'> | BaseAction<'throw'> | BaseAction<'user.login'> | BaseAction<'user.register'> | BaseAction<'user.update'> | LinkAction | LogAction | RequestAction | ResourceCountAction | ResourceCreateAction | ResourceDeleteAction | ResourceGetAction | ResourceQueryAction | ResourceUpdateAction;
 export {};

package/action.ts

@@ -56,6 +56,7 @@ export type Action =
   | BaseAction<'dialog.ok'>
   | BaseAction<'dialog'>
   | BaseAction<'download'>
+  | BaseAction<'each'>
   | BaseAction<'email'>
   | BaseAction<'event'>
   | BaseAction<'flow.back'>

package/index.d.ts

@@ -380,6 +380,54 @@ export interface Remappers {
      * Get the input data as it was initially passed to the remap function.
      */
     root: null;
+    /**
+     * Get the data at a certain index from the history stack prior to an action.
+     *
+     * 0 is the index of the first item in the history stack.
+     */
+    history: number;
+    /**
+     * Assign properties from the history stack at a certain index to an existing object.
+     */
+    'assign.history': {
+        /**
+         * The index of the history stack item to assign.
+         *
+         * 0 is the index of the first item in the history stack.
+         */
+        index: number;
+        /**
+         * Predefined mapper keys to choose what properties to assign.
+         */
+        props: Record<string, Remapper>;
+    };
+    /**
+     * Assign properties from the history stack at a certain index and exclude the unwanted.
+     */
+    'omit.history': {
+        /**
+         * The index of the history stack item to assign.
+         *
+         * 0 is the index of the first item in the history stack.
+         */
+        index: number;
+        /**
+         * Exclude properties from the history stack item, based on the given object keys.
+         *
+         * Nested properties can be excluded using arrays of keys.
+         *
+         * @example
+         * ```yaml
+         * omit.history:
+         *   index: 0
+         *   keys:
+         *     - foo   # Excludes the property foo
+         *     - - bar # Excludes the property baz inside of bar
+         *       - baz
+         * ```
+         */
+        keys: (string[] | string)[];
+    };
     /**
      * Convert an input to lower or upper case.
      */
@@ -419,6 +467,7 @@ export interface SubscriptionResponseResource {
     update: boolean;
     delete: boolean;
     subscriptions?: Record<string, {
+        create?: boolean;
         update: boolean;
         delete: boolean;
     }>;
@@ -649,6 +698,16 @@ export interface DownloadActionDefinition extends BaseActionDefinition<'download
      */
     filename: string;
 }
+export interface EachActionDefinition extends BaseActionDefinition<'each'> {
+    /**
+     * Run an action for each entry in an array.
+     *
+     * The actions are run in parallel.
+     *
+     * If the input is not an array, the action will be applied to the input instead.
+     */
+    do: ActionDefinition;
+}
 export interface EmailActionDefinition extends BaseActionDefinition<'email'> {
     /**
      * The recipient of the email.
@@ -937,7 +996,7 @@ export declare type MessageActionDefinition = BaseActionDefinition<'message'> &
      */
     body: Remapper;
 };
-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 | DownloadActionDefinition | EmailActionDefinition | EventActionDefinition | FlowToActionDefinition | LinkActionDefinition | LogActionDefinition | MessageActionDefinition | RequestActionDefinition | ResourceCountActionDefinition | ResourceCreateActionDefinition | ResourceDeleteActionDefinition | ResourceGetActionDefinition | ResourceQueryActionDefinition | ResourceSubscriptionStatusActionDefinition | ResourceSubscriptionSubscribeActionDefinition | ResourceSubscriptionToggleActionDefinition | ResourceSubscriptionUnsubscribeActionDefinition | ResourceUpdateActionDefinition | ShareActionDefinition | StaticActionDefinition | StorageReadActionDefinition | StorageWriteActionDefinition | TeamInviteActionDefinition | 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 | DownloadActionDefinition | EachActionDefinition | EmailActionDefinition | EventActionDefinition | FlowToActionDefinition | LinkActionDefinition | LogActionDefinition | MessageActionDefinition | RequestActionDefinition | ResourceCountActionDefinition | ResourceCreateActionDefinition | ResourceDeleteActionDefinition | ResourceGetActionDefinition | ResourceQueryActionDefinition | ResourceSubscriptionStatusActionDefinition | ResourceSubscriptionSubscribeActionDefinition | ResourceSubscriptionToggleActionDefinition | ResourceSubscriptionUnsubscribeActionDefinition | ResourceUpdateActionDefinition | ShareActionDefinition | StaticActionDefinition | StorageReadActionDefinition | StorageWriteActionDefinition | TeamInviteActionDefinition | UserLoginAction | UserRegisterAction | UserUpdateAction;
 export interface ActionType {
     /**
      * Whether or not app creators are required to define this action.

package/index.ts

@@ -441,6 +441,59 @@ export interface Remappers {
    */
   root: null;
 
+  /**
+   * Get the data at a certain index from the history stack prior to an action.
+   *
+   * 0 is the index of the first item in the history stack.
+   */
+  history: number;
+
+  /**
+   * Assign properties from the history stack at a certain index to an existing object.
+   */
+  'assign.history': {
+    /**
+     * The index of the history stack item to assign.
+     *
+     * 0 is the index of the first item in the history stack.
+     */
+    index: number;
+
+    /**
+     * Predefined mapper keys to choose what properties to assign.
+     */
+    props: Record<string, Remapper>;
+  };
+
+  /**
+   * Assign properties from the history stack at a certain index and exclude the unwanted.
+   */
+  'omit.history': {
+    /**
+     * The index of the history stack item to assign.
+     *
+     * 0 is the index of the first item in the history stack.
+     */
+    index: number;
+
+    /**
+     * Exclude properties from the history stack item, based on the given object keys.
+     *
+     * Nested properties can be excluded using arrays of keys.
+     *
+     * @example
+     * ```yaml
+     * omit.history:
+     *   index: 0
+     *   keys:
+     *     - foo   # Excludes the property foo
+     *     - - bar # Excludes the property baz inside of bar
+     *       - baz
+     * ```
+     */
+    keys: (string[] | string)[];
+  };
+
   /**
    * Convert an input to lower or upper case.
    */
@@ -495,6 +548,7 @@ export interface SubscriptionResponseResource {
   subscriptions?: Record<
     string,
     {
+      create?: boolean;
       update: boolean;
       delete: boolean;
     }
@@ -776,6 +830,17 @@ export interface DownloadActionDefinition extends BaseActionDefinition<'download
   filename: string;
 }
 
+export interface EachActionDefinition extends BaseActionDefinition<'each'> {
+  /**
+   * Run an action for each entry in an array.
+   *
+   * The actions are run in parallel.
+   *
+   * If the input is not an array, the action will be applied to the input instead.
+   */
+  do: ActionDefinition;
+}
+
 export interface EmailActionDefinition extends BaseActionDefinition<'email'> {
   /**
    * The recipient of the email.
@@ -1148,6 +1213,7 @@ export type ActionDefinition =
   | ConditionActionDefinition
   | DialogActionDefinition
   | DownloadActionDefinition
+  | EachActionDefinition
   | EmailActionDefinition
   | EventActionDefinition
   | FlowToActionDefinition

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/types",
-  "version": "0.20.15",
+  "version": "0.20.17",
   "description": "TypeScript definitions reused within Appsemble internally",
   "keywords": [
     "app",