@appsemble/types 0.20.21 → 0.20.23

package/README.md

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

package/action.d.ts

@@ -42,5 +42,5 @@ export type ResourceUpdateAction = RequestLikeAction<'resource.update'>;
 /**
  * An action that can be called from within a block.
  */
-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 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.append'> | BaseAction<'storage.delete'> | BaseAction<'storage.read'> | BaseAction<'storage.subtract'> | BaseAction<'storage.update'> | 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

@@ -74,7 +74,11 @@ export type Action =
   | BaseAction<'resource.subscription.unsubscribe'>
   | BaseAction<'share'>
   | BaseAction<'static'>
+  | BaseAction<'storage.append'>
+  | BaseAction<'storage.delete'>
   | BaseAction<'storage.read'>
+  | BaseAction<'storage.subtract'>
+  | BaseAction<'storage.update'>
   | BaseAction<'storage.write'>
   | BaseAction<'team.invite'>
   | BaseAction<'team.join'>

package/index.d.ts

@@ -74,7 +74,7 @@ export interface BlockDefinition {
      */
     theme?: Partial<Theme>;
     /**
-     * A free form mapping of named paramters.
+     * A free form mapping of named parameters.
      *
      * The exact meaning of the parameters depends on the block type.
      */
@@ -822,6 +822,66 @@ export interface ShareActionDefinition extends BaseActionDefinition<'share'> {
     title?: Remapper;
 }
 type StorageType = 'indexedDB' | 'localStorage' | 'sessionStorage';
+export interface StorageAppendActionDefinition extends BaseActionDefinition<'storage.append'> {
+    /**
+     * The key of the entry to write to the app’s storage.
+     */
+    key: Remapper;
+    /**
+     * 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 StorageDeleteActionDefinition extends BaseActionDefinition<'storage.delete'> {
+    /**
+     * The key of the entry to delete from the app’s storage.
+     */
+    key: Remapper;
+    /**
+     * The mechanism used to delete the data from.
+     *
+     * @default 'indexedDB'
+     */
+    storage?: StorageType;
+}
+export interface StorageSubtractActionDefinition extends BaseActionDefinition<'storage.subtract'> {
+    /**
+     * The key of the entry to subtract the last entry from
+     */
+    key: Remapper;
+    /**
+     * The mechanism used to read the data from.
+     *
+     * @default 'indexedDB'
+     */
+    storage?: StorageType;
+}
+export interface StorageUpdateActionDefinition extends BaseActionDefinition<'storage.update'> {
+    /**
+     * The key of the entry to write to the app’s storage.
+     */
+    key: Remapper;
+    /**
+     * The key of the item to update.
+     */
+    item: Remapper;
+    /**
+     * The data to update the specified item with.
+     */
+    value: Remapper;
+    /**
+     * The mechanism used to read the data from.
+     *
+     * @default 'indexedDB'
+     */
+    storage?: StorageType;
+}
 export interface StorageReadActionDefinition extends BaseActionDefinition<'storage.read'> {
     /**
      * The key of the entry to read from the app’s storage.
@@ -1029,7 +1089,7 @@ export type MessageActionDefinition = BaseActionDefinition<'message'> & BaseMess
      */
     body: Remapper;
 };
-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 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 | StorageAppendActionDefinition | StorageDeleteActionDefinition | StorageReadActionDefinition | StorageSubtractActionDefinition | StorageUpdateActionDefinition | StorageWriteActionDefinition | TeamInviteActionDefinition | UserLoginAction | UserRegisterAction | UserUpdateAction;
 export interface ActionType {
     /**
      * Whether or not app creators are required to define this action.
@@ -1495,7 +1555,7 @@ export interface Organization {
     iconUrl: string;
 }
 /**
- * An invite for an organizaton.
+ * An invite for an organization.
  */
 export interface OrganizationInvite {
     /**

package/index.ts

@@ -92,7 +92,7 @@ export interface BlockDefinition {
   theme?: Partial<Theme>;
 
   /**
-   * A free form mapping of named paramters.
+   * A free form mapping of named parameters.
    *
    * The exact meaning of the parameters depends on the block type.
    */
@@ -974,6 +974,77 @@ export interface ShareActionDefinition extends BaseActionDefinition<'share'> {
 
 type StorageType = 'indexedDB' | 'localStorage' | 'sessionStorage';
 
+export interface StorageAppendActionDefinition extends BaseActionDefinition<'storage.append'> {
+  /**
+   * The key of the entry to write to the app’s storage.
+   */
+  key: Remapper;
+
+  /**
+   * 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 StorageDeleteActionDefinition extends BaseActionDefinition<'storage.delete'> {
+  /**
+   * The key of the entry to delete from the app’s storage.
+   */
+  key: Remapper;
+
+  /**
+   * The mechanism used to delete the data from.
+   *
+   * @default 'indexedDB'
+   */
+  storage?: StorageType;
+}
+
+export interface StorageSubtractActionDefinition extends BaseActionDefinition<'storage.subtract'> {
+  /**
+   * The key of the entry to subtract the last entry from
+   */
+  key: Remapper;
+
+  /**
+   * The mechanism used to read the data from.
+   *
+   * @default 'indexedDB'
+   */
+  storage?: StorageType;
+}
+
+export interface StorageUpdateActionDefinition extends BaseActionDefinition<'storage.update'> {
+  /**
+   * The key of the entry to write to the app’s storage.
+   */
+  key: Remapper;
+
+  /**
+   * The key of the item to update.
+   */
+  item: Remapper;
+
+  /**
+   * The data to update the specified item with.
+   */
+  value: Remapper;
+
+  /**
+   * The mechanism used to read the data from.
+   *
+   * @default 'indexedDB'
+   */
+  storage?: StorageType;
+}
+
 export interface StorageReadActionDefinition extends BaseActionDefinition<'storage.read'> {
   /**
    * The key of the entry to read from the app’s storage.
@@ -1271,7 +1342,11 @@ export type ActionDefinition =
   | ResourceUpdateActionDefinition
   | ShareActionDefinition
   | StaticActionDefinition
+  | StorageAppendActionDefinition
+  | StorageDeleteActionDefinition
   | StorageReadActionDefinition
+  | StorageSubtractActionDefinition
+  | StorageUpdateActionDefinition
   | StorageWriteActionDefinition
   | TeamInviteActionDefinition
   | UserLoginAction
@@ -1838,7 +1913,7 @@ export interface Organization {
 }
 
 /**
- * An invite for an organizaton.
+ * An invite for an organization.
  */
 export interface OrganizationInvite {
   /**

package/package.json

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

package/theme.d.ts

@@ -20,7 +20,7 @@ export interface Theme {
      */
     linkColor: string;
     /**
-     * The color used to feature succesful or positive actions.
+     * The color used to feature successful or positive actions.
      */
     successColor: string;
     /**

package/theme.ts

@@ -24,7 +24,7 @@ export interface Theme {
   linkColor: string;
 
   /**
-   * The color used to feature succesful or positive actions.
+   * The color used to feature successful or positive actions.
    */
   successColor: string;