@appsemble/types 0.20.19 → 0.20.21

package/README.md

@@ -1,10 +1,10 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.20.19/config/assets/logo.svg) Appsemble Types
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.20.21/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.19/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.20.19)
-[![Code coverage](https://codecov.io/gl/appsemble/appsemble/branch/0.20.19/graph/badge.svg)](https://codecov.io/gl/appsemble/appsemble)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.20.21/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.20.21)
+[![Code coverage](https://codecov.io/gl/appsemble/appsemble/branch/0.20.21/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.19/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.20.21/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/action.d.ts

@@ -32,15 +32,15 @@ interface RequestLikeAction<T extends Action['type']> extends BaseAction<T> {
      */
     url: Remapper;
 }
-export declare type RequestAction = RequestLikeAction<'request'>;
-export declare type ResourceCreateAction = RequestLikeAction<'resource.create'>;
-export declare type ResourceDeleteAction = RequestLikeAction<'resource.delete'>;
-export declare type ResourceGetAction = RequestLikeAction<'resource.get'>;
-export declare type ResourceQueryAction = RequestLikeAction<'resource.query'>;
-export declare type ResourceCountAction = RequestLikeAction<'resource.count'>;
-export declare type ResourceUpdateAction = RequestLikeAction<'resource.update'>;
+export type RequestAction = RequestLikeAction<'request'>;
+export type ResourceCreateAction = RequestLikeAction<'resource.create'>;
+export type ResourceDeleteAction = RequestLikeAction<'resource.delete'>;
+export type ResourceGetAction = RequestLikeAction<'resource.get'>;
+export type ResourceQueryAction = RequestLikeAction<'resource.query'>;
+export type ResourceCountAction = RequestLikeAction<'resource.count'>;
+export 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<'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 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/app.d.ts

@@ -8,7 +8,7 @@
  * Appsemble app store.
  * - **private**: The app is only visible to people who are part of the organization.
  */
-export declare type AppVisibility = 'private' | 'public' | 'unlisted';
+export type AppVisibility = 'private' | 'public' | 'unlisted';
 /**
  * This defines how teams are handled by an app.
  */

package/bulma.d.ts

@@ -1,5 +1,5 @@
 /**
  * A color known to Bulma.
  */
-export declare type BulmaColor = 'danger' | 'dark' | 'info' | 'link' | 'primary' | 'success' | 'warning' | 'white';
-export declare type BulmaSize = 'large' | 'medium' | 'normal' | 'small';
+export type BulmaColor = 'danger' | 'dark' | 'info' | 'link' | 'primary' | 'success' | 'warning' | 'white';
+export type BulmaSize = 'large' | 'medium' | 'normal' | 'small';

package/http.d.ts

@@ -1,4 +1,4 @@
 /**
  * Common HTTP methods, but either all upper case or all lower case.
  */
-export declare type HTTPMethods = 'DELETE' | 'delete' | 'GET' | 'get' | 'PATCH' | 'patch' | 'POST' | 'post' | 'PUT' | 'put';
+export type HTTPMethods = 'DELETE' | 'delete' | 'GET' | 'get' | 'PATCH' | 'patch' | 'POST' | 'post' | 'PUT' | 'put';

package/index.d.ts

@@ -322,11 +322,13 @@ export interface Remappers {
      */
     'array.append': Remapper[];
     /**
-     * Remove item(s) from an array given a predefined array of indices.
+     * Remove item(s) from an array given a predefined array of remappable indices.
+     *
+     * Only the remapped values that are turned into numbers are applied.
      *
      * If the input is not an array an empty array is returned.
      */
-    'array.omit': number[];
+    'array.omit': Remapper[];
     /**
      * Create a new object given some predefined mapper keys.
      */
@@ -402,6 +404,21 @@ export interface Remappers {
      * 0 is the index of the first item in the history stack.
      */
     history: number;
+    /**
+     * Create a new object with properties from the history stack at a certain index.
+     */
+    'from.history': {
+        /**
+         * The index of the history stack item to apply.
+         *
+         * 0 is the index of the first item in the history stack.
+         */
+        index: number;
+        /**
+         * Predefined mapper keys to choose what properties to apply.
+         */
+        props: Record<string, Remapper>;
+    };
     /**
      * Assign properties from the history stack at a certain index to an existing object.
      */
@@ -477,7 +494,7 @@ export interface Remappers {
     translate: string;
     user: keyof UserInfo;
 }
-export declare type Remapper = RequireExactlyOne<Remappers> | RequireExactlyOne<Remappers>[] | boolean | number | string;
+export type Remapper = RequireExactlyOne<Remappers> | RequireExactlyOne<Remappers>[] | boolean | number | string;
 export interface SubscriptionResponseResource {
     create: boolean;
     update: boolean;
@@ -488,7 +505,7 @@ export interface SubscriptionResponseResource {
         delete: boolean;
     }>;
 }
-export declare type SubscriptionResponse = Record<string, SubscriptionResponseResource>;
+export type SubscriptionResponse = Record<string, SubscriptionResponseResource>;
 export interface RoleDefinition {
     description?: string;
     inherits?: string[];
@@ -505,8 +522,8 @@ export interface Security {
      */
     teams?: TeamsDefinition;
 }
-export declare type Navigation = 'bottom' | 'hidden' | 'left-menu';
-export declare type LayoutPosition = 'hidden' | 'navbar' | 'navigation';
+export type Navigation = 'bottom' | 'hidden' | 'left-menu';
+export type LayoutPosition = 'hidden' | 'navbar' | 'navigation';
 export interface NotificationDefinition {
     to?: string[];
     subscribe?: 'all' | 'both' | 'single';
@@ -804,7 +821,7 @@ export interface ShareActionDefinition extends BaseActionDefinition<'share'> {
      */
     title?: Remapper;
 }
-declare type StorageType = 'indexedDB' | 'localStorage' | 'sessionStorage';
+type StorageType = 'indexedDB' | 'localStorage' | 'sessionStorage';
 export interface StorageReadActionDefinition extends BaseActionDefinition<'storage.read'> {
     /**
      * The key of the entry to read from the app’s storage.
@@ -947,13 +964,13 @@ interface ViewResourceDefinition {
      */
     view?: string;
 }
-export declare type RequestActionDefinition = RequestLikeActionDefinition<'request'>;
-export declare type ResourceCreateActionDefinition = ResourceActionDefinition<'resource.create'>;
-export declare type ResourceDeleteActionDefinition = ResourceActionDefinition<'resource.delete'>;
-export declare type ResourceGetActionDefinition = ResourceActionDefinition<'resource.get'> & ViewResourceDefinition;
-export declare type ResourceQueryActionDefinition = ResourceActionDefinition<'resource.query'> & ViewResourceDefinition;
-export declare type ResourceCountActionDefinition = ResourceActionDefinition<'resource.count'>;
-export declare type ResourceUpdateActionDefinition = ResourceActionDefinition<'resource.update'>;
+export type RequestActionDefinition = RequestLikeActionDefinition<'request'>;
+export type ResourceCreateActionDefinition = ResourceActionDefinition<'resource.create'>;
+export type ResourceDeleteActionDefinition = ResourceActionDefinition<'resource.delete'>;
+export type ResourceGetActionDefinition = ResourceActionDefinition<'resource.get'> & ViewResourceDefinition;
+export type ResourceQueryActionDefinition = ResourceActionDefinition<'resource.query'> & ViewResourceDefinition;
+export type ResourceCountActionDefinition = ResourceActionDefinition<'resource.count'>;
+export type ResourceUpdateActionDefinition = ResourceActionDefinition<'resource.update'>;
 export interface BaseResourceSubscribeActionDefinition<T extends Action['type']> extends BaseActionDefinition<T> {
     /**
      * The name of the resource.
@@ -964,10 +981,10 @@ export interface BaseResourceSubscribeActionDefinition<T extends Action['type']>
      */
     action?: 'create' | 'delete' | 'update';
 }
-export declare type ResourceSubscriptionSubscribeActionDefinition = BaseResourceSubscribeActionDefinition<'resource.subscription.subscribe'>;
-export declare type ResourceSubscriptionUnsubscribeActionDefinition = BaseResourceSubscribeActionDefinition<'resource.subscription.unsubscribe'>;
-export declare type ResourceSubscriptionToggleActionDefinition = BaseResourceSubscribeActionDefinition<'resource.subscription.toggle'>;
-export declare type ResourceSubscriptionStatusActionDefinition = Omit<BaseResourceSubscribeActionDefinition<'resource.subscription.status'>, 'action'>;
+export type ResourceSubscriptionSubscribeActionDefinition = BaseResourceSubscribeActionDefinition<'resource.subscription.subscribe'>;
+export type ResourceSubscriptionUnsubscribeActionDefinition = BaseResourceSubscribeActionDefinition<'resource.subscription.unsubscribe'>;
+export type ResourceSubscriptionToggleActionDefinition = BaseResourceSubscribeActionDefinition<'resource.subscription.toggle'>;
+export type ResourceSubscriptionStatusActionDefinition = Omit<BaseResourceSubscribeActionDefinition<'resource.subscription.status'>, 'action'>;
 export interface EventActionDefinition extends BaseActionDefinition<'event'> {
     /**
      * The name of the event to emit to.
@@ -1006,13 +1023,13 @@ export interface BaseMessage {
      */
     dismissable?: boolean;
 }
-export declare type MessageActionDefinition = BaseActionDefinition<'message'> & BaseMessage & {
+export type MessageActionDefinition = BaseActionDefinition<'message'> & BaseMessage & {
     /**
      * The content of the message to display.
      */
     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 | 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 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.
@@ -1118,6 +1135,10 @@ export interface BasePageDefinition {
      * The name of the page is used to determine the URL path of the page.
      */
     name: string;
+    /**
+     * Whether or not the page name should be displayed in the *app bar*.
+     */
+    hideName?: boolean;
     /**
      * The name of the page when displayed in the navigation menu.
      *
@@ -1179,12 +1200,20 @@ export interface FlowPageDefinition extends BasePageDefinition {
      * @default 'corner-dots'
      */
     progress?: 'corner-dots' | 'hidden';
+    /**
+     * Whether to retain the flow data when navigating away to another page outside the flow.
+     *
+     * By default the flow page retains it's data after navigating once. Set to false to clear it.
+     *
+     * @default true
+     */
+    retainFlowData?: boolean;
 }
 export interface TabsPageDefinition extends BasePageDefinition {
     type: 'tabs';
     tabs: SubPage[];
 }
-export declare type PageDefinition = BasicPageDefinition | FlowPageDefinition | TabsPageDefinition;
+export type PageDefinition = BasicPageDefinition | FlowPageDefinition | TabsPageDefinition;
 export interface AppDefinition {
     /**
      * The name of the app.
@@ -1654,7 +1683,7 @@ export interface AppSamlSecret extends WritableAppSamlSecret {
      */
     spCertificate?: string;
 }
-export declare type SAMLStatus = 'badsignature' | 'emailconflict' | 'invalidrelaystate' | 'invalidsecret' | 'invalidstatuscode' | 'invalidsubjectconfirmation' | 'missingnameid' | 'missingsubject';
+export type SAMLStatus = 'badsignature' | 'emailconflict' | 'invalidrelaystate' | 'invalidsecret' | 'invalidstatuscode' | 'invalidsubjectconfirmation' | 'missingnameid' | 'missingsubject';
 /**
  * The block configuration that’s used by the CLI when building a block.
  *

package/index.ts

@@ -378,11 +378,13 @@ export interface Remappers {
   'array.append': Remapper[];
 
   /**
-   * Remove item(s) from an array given a predefined array of indices.
+   * Remove item(s) from an array given a predefined array of remappable indices.
+   *
+   * Only the remapped values that are turned into numbers are applied.
    *
    * If the input is not an array an empty array is returned.
    */
-  'array.omit': number[];
+  'array.omit': Remapper[];
 
   /**
    * Create a new object given some predefined mapper keys.
@@ -467,6 +469,23 @@ export interface Remappers {
    */
   history: number;
 
+  /**
+   * Create a new object with properties from the history stack at a certain index.
+   */
+  'from.history': {
+    /**
+     * The index of the history stack item to apply.
+     *
+     * 0 is the index of the first item in the history stack.
+     */
+    index: number;
+
+    /**
+     * Predefined mapper keys to choose what properties to apply.
+     */
+    props: Record<string, Remapper>;
+  };
+
   /**
    * Assign properties from the history stack at a certain index to an existing object.
    */
@@ -1383,6 +1402,11 @@ export interface BasePageDefinition {
    */
   name: string;
 
+  /**
+   * Whether or not the page name should be displayed in the *app bar*.
+   */
+  hideName?: boolean;
+
   /**
    * The name of the page when displayed in the navigation menu.
    *
@@ -1455,6 +1479,15 @@ export interface FlowPageDefinition extends BasePageDefinition {
    * @default 'corner-dots'
    */
   progress?: 'corner-dots' | 'hidden';
+
+  /**
+   * Whether to retain the flow data when navigating away to another page outside the flow.
+   *
+   * By default the flow page retains it's data after navigating once. Set to false to clear it.
+   *
+   * @default true
+   */
+  retainFlowData?: boolean;
 }
 
 export interface TabsPageDefinition extends BasePageDefinition {

package/package.json

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

package/ssl.d.ts

@@ -7,8 +7,8 @@
  * - `ready` means the SSL certificate is ready to serve.
  * - `unknown` means the status is unknown, probably due to an unexpected state.
  */
-export declare type SSLStatus = 'error' | 'missing' | 'pending' | 'ready' | 'unknown';
+export type SSLStatus = 'error' | 'missing' | 'pending' | 'ready' | 'unknown';
 /**
  * A mapping of domain names to an SSL certificate status.
  */
-export declare type SSLStatusMap = Record<string, SSLStatus>;
+export type SSLStatusMap = Record<string, SSLStatus>;