@appsemble/types 0.20.16 → 0.20.17

package/README.md

@@ -1,10 +1,10 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.20.16/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.16/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.20.16)
-[![Code coverage](https://codecov.io/gl/appsemble/appsemble/branch/0.20.16/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.16/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.20.17/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

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.
      */

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.
    */

package/package.json

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