@appsemble/types 0.23.9 → 0.24.1

package/README.md

@@ -1,9 +1,9 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.23.9/config/assets/logo.svg) Appsemble Types
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.24.1/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.23.9/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.23.9)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.24.1/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.24.1)
 [![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io)
 
 ## Table of Contents
@@ -26,5 +26,5 @@ not guaranteed.
 
 ## License
 
-[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.23.9/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.24.1/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/action.d.ts

@@ -43,5 +43,5 @@ export type ResourcePatchAction = RequestLikeAction<'resource.patch'>;
 /**
  * An action that can be called from within a block.
  */
-export type Action = BaseAction<'analytics'> | BaseAction<'condition'> | BaseAction<'controller'> | 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<'match'> | BaseAction<'message'> | BaseAction<'noop'> | BaseAction<'notify'> | 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<'team.members'> | BaseAction<'throw'> | BaseAction<'user.create'> | BaseAction<'user.login'> | BaseAction<'user.logout'> | BaseAction<'user.register'> | BaseAction<'user.update'> | LinkAction | LogAction | RequestAction | ResourceCountAction | ResourceCreateAction | ResourceDeleteAction | ResourceGetAction | ResourcePatchAction | ResourceQueryAction | ResourceUpdateAction;
+export type Action = BaseAction<'analytics'> | BaseAction<'condition'> | BaseAction<'controller'> | 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<'match'> | BaseAction<'message'> | BaseAction<'noop'> | BaseAction<'notify'> | 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<'team.members'> | BaseAction<'throw'> | BaseAction<'user.create'> | BaseAction<'user.login'> | BaseAction<'user.logout'> | BaseAction<'user.query'> | BaseAction<'user.register'> | BaseAction<'user.remove'> | BaseAction<'user.update'> | LinkAction | LogAction | RequestAction | ResourceCountAction | ResourceCreateAction | ResourceDeleteAction | ResourceGetAction | ResourcePatchAction | ResourceQueryAction | ResourceUpdateAction;
 export {};

package/index.d.ts

@@ -650,6 +650,18 @@ export interface ResourceView {
      */
     remap: Remapper;
 }
+export interface UserPropertyDefinition {
+    /**
+     * The JSON schema to validate user properties against before sending it to the backend.
+     */
+    schema: OpenAPIV3.SchemaObject;
+    /**
+     * The resource that is referenced by this user property.
+     */
+    reference?: {
+        resource: string;
+    };
+}
 export interface ResourceDefinition {
     /**
      * The default list of roles used for permission checks for each action.
@@ -717,6 +729,14 @@ export interface ResourceDefinition {
      * @example '1d 8h 30m'
      */
     expires?: string;
+    /**
+     * Whether the resource should be able to be transferred when cloning the app it belongs to.
+     */
+    clonable?: boolean;
+    /**
+     * Whether the resource should be cleaned up regularly.
+     */
+    ephemeral?: boolean;
 }
 export interface BaseActionDefinition<T extends Action['type']> {
     /**
@@ -883,7 +903,7 @@ export interface LinkActionDefinition extends BaseActionDefinition<'link'> {
      *
      * This should be a page name.
      */
-    to: string[] | string;
+    to: Remapper | string[] | string;
 }
 export interface NotifyActionDefinition extends BaseActionDefinition<'notify'> {
     /**
@@ -1074,6 +1094,10 @@ export interface UserRegisterAction extends BaseActionDefinition<'user.register'
     properties?: Remapper;
 }
 export interface UserCreateAction extends BaseActionDefinition<'user.create'> {
+    /**
+     * The display name of the user.
+     */
+    name: Remapper;
     /**
      * The email address to login with.
      */
@@ -1083,49 +1107,55 @@ export interface UserCreateAction extends BaseActionDefinition<'user.create'> {
      */
     password: Remapper;
     /**
-     * The display name of the user.
+     * Custom properties that can be assigned freely.
+     *
+     * Every value will be converted to a string.
      */
-    displayName: Remapper;
+    properties?: Remapper;
     /**
      * The role of the created user
      */
     role?: Remapper;
+}
+export interface UserQueryAction extends BaseActionDefinition<'user.query'> {
     /**
-     * Custom properties that can be assigned freely.
-     *
-     * Every value will be converted to a string.
+     * The roles of the users to fetch.
      */
-    properties?: Remapper;
+    roles?: Remapper;
 }
 export interface UserUpdateAction extends BaseActionDefinition<'user.update'> {
     /**
-     * The email address to update.
-     */
-    email?: Remapper;
-    /**
-     * The password to update.
+     * The display name to update.
      */
-    password?: Remapper;
+    name?: Remapper;
     /**
-     * The display name to update.
+     * The email address of the user to update.
      */
-    displayName?: Remapper;
+    currentEmail: Remapper;
     /**
-     * The role of the created user
+     * The new email address of the user.
      */
-    role?: Remapper;
+    newEmail?: Remapper;
     /**
-     * The profile picture to update.
-     *
-     * This must be a file, otherwise it’s ignored.
+     * The password to update.
      */
-    picture?: Remapper;
+    password?: Remapper;
     /**
      * Custom properties that can be assigned freely.
      *
      * Every value will be converted to a string.
      */
     properties?: Remapper;
+    /**
+     * The role of the created user
+     */
+    role?: Remapper;
+}
+export interface UserRemoveAction extends BaseActionDefinition<'user.remove'> {
+    /**
+     * The email address of the account to delete.
+     */
+    email: Remapper;
 }
 export interface RequestLikeActionDefinition<T extends Action['type'] = Action['type']> extends BaseActionDefinition<T> {
     /**
@@ -1245,7 +1275,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 | ControllerActionDefinition | DialogActionDefinition | DownloadActionDefinition | EachActionDefinition | EmailActionDefinition | EventActionDefinition | FlowToActionDefinition | LinkActionDefinition | LogActionDefinition | MatchActionDefinition | MessageActionDefinition | NotifyActionDefinition | RequestActionDefinition | ResourceCountActionDefinition | ResourceCreateActionDefinition | ResourceDeleteActionDefinition | ResourceGetActionDefinition | ResourcePatchActionDefinition | ResourceQueryActionDefinition | ResourceSubscriptionStatusActionDefinition | ResourceSubscriptionSubscribeActionDefinition | ResourceSubscriptionToggleActionDefinition | ResourceSubscriptionUnsubscribeActionDefinition | ResourceUpdateActionDefinition | ShareActionDefinition | StaticActionDefinition | StorageAppendActionDefinition | StorageDeleteActionDefinition | StorageReadActionDefinition | StorageSubtractActionDefinition | StorageUpdateActionDefinition | StorageWriteActionDefinition | TeamInviteActionDefinition | TeamMembersActionDefinition | UserCreateAction | UserLoginAction | UserLogoutAction | 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 | ControllerActionDefinition | DialogActionDefinition | DownloadActionDefinition | EachActionDefinition | EmailActionDefinition | EventActionDefinition | FlowToActionDefinition | LinkActionDefinition | LogActionDefinition | MatchActionDefinition | MessageActionDefinition | NotifyActionDefinition | RequestActionDefinition | ResourceCountActionDefinition | ResourceCreateActionDefinition | ResourceDeleteActionDefinition | ResourceGetActionDefinition | ResourcePatchActionDefinition | ResourceQueryActionDefinition | ResourceSubscriptionStatusActionDefinition | ResourceSubscriptionSubscribeActionDefinition | ResourceSubscriptionToggleActionDefinition | ResourceSubscriptionUnsubscribeActionDefinition | ResourceUpdateActionDefinition | ShareActionDefinition | StaticActionDefinition | StorageAppendActionDefinition | StorageDeleteActionDefinition | StorageReadActionDefinition | StorageSubtractActionDefinition | StorageUpdateActionDefinition | StorageWriteActionDefinition | TeamInviteActionDefinition | TeamMembersActionDefinition | UserCreateAction | UserLoginAction | UserLogoutAction | UserQueryAction | UserRegisterAction | UserRemoveAction | UserUpdateAction;
 export interface ActionType {
     /**
      * Whether or not app creators are required to define this action.
@@ -1460,6 +1490,9 @@ export interface AppDefinition {
      */
     pages: PageDefinition[];
     controller?: ControllerDefinition;
+    users?: {
+        properties: Record<string, UserPropertyDefinition>;
+    };
     /**
      * Resource definitions that may be used by the app.
      */
@@ -1574,7 +1607,11 @@ export interface App {
     /**
      * Whether the app has clonable resources.
      */
-    resources?: boolean;
+    hasClonableResources?: boolean;
+    /**
+     * Whether the app has clonable assets.
+     */
+    hasClonableAssets?: boolean;
     /**
      * A list of URLs to app screenshots
      */
@@ -1702,13 +1739,15 @@ export interface OrganizationInvite {
     role: string;
 }
 /**
- * The controller of an app.
+ * App member in an app.
  */
 export interface AppMember {
     id: string;
     name: string;
     primaryEmail: string;
     role: string;
+    demo: boolean;
+    properties: Record<string, any>;
 }
 /**
  * The layout used to store Appsemble messages.
@@ -1924,7 +1963,7 @@ export interface Training {
     /**
      * Tags related to competence of the training.
      */
-    competence: string;
+    competences: string[];
     /**
      * Difficulty level of the training.
      */

package/package.json

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

package/resource.d.ts

@@ -9,6 +9,15 @@ export interface Resource {
      * This only applies to template apps.
      */
     $clonable: boolean;
+    /**
+     * A boolean indicating whether the resource will be used for creating ephemeral
+     * resources in demo apps
+     */
+    $seed: boolean;
+    /**
+     * A boolean indicating whether the resource will be cleaned up regularly
+     */
+    $ephemeral: boolean;
     /**
      * When the resource was first created as an ISO 8601 formatted string.
      */