@appsemble/types 0.29.11 → 0.30.2

package/index.d.ts

@@ -3,13 +3,14 @@ import { type Schema } from 'jsonschema';
 import { type OpenAPIV3 } from 'openapi-types';
 import { type JsonObject, type RequireExactlyOne } from 'type-fest';
 import { type Action, type LogAction } from './action.js';
-import { type AppVisibility, type TeamsDefinition } from './app.js';
+import { type AppVisibility } from './app.js';
 import { type BulmaColor } from './bulma.js';
 import { type HTTPMethods } from './http.js';
+import { type AppPermission } from './permissions.js';
+import { type AppRole, type PredefinedAppRole, type PredefinedOrganizationRole } from './roles.js';
 import { type Theme } from './theme.js';
 export * from './action.js';
 export * from './app.js';
-export * from './appMember.js';
 export * from './asset.js';
 export * from './authentication.js';
 export * from './author.js';
@@ -21,11 +22,12 @@ export * from './snapshot.js';
 export * from './resource.js';
 export * from './saml.js';
 export * from './ssl.js';
-export * from './team.js';
 export * from './template.js';
 export * from './theme.js';
-export * from './user.js';
+export * from './oauth2.js';
 export * from './quota.js';
+export * from './permissions.js';
+export * from './roles.js';
 /**
  * A representation of a generated OAuth2 authorization code response.
  */
@@ -103,7 +105,7 @@ export interface BlockDefinition extends ControllerDefinition {
     /**
      * A list of roles that are allowed to view this block.
      */
-    roles?: string[];
+    roles?: ViewRole[];
     /**
      * A free form mapping of named parameters.
      *
@@ -118,7 +120,7 @@ export interface BlockDefinition extends ControllerDefinition {
  * The Connect2id server can be set up to provide additional custom claims, such as roles and
  * permissions.
  */
-export interface UserInfo {
+export interface BaseUserInfo {
     /**
      * The subject (end-user) identifier. This member is always present in a claims set.
      */
@@ -139,10 +141,6 @@ export interface UserInfo {
      * The URL of the profile picture for the end-user.
      */
     picture?: string;
-    /**
-     * A URL that links to the user profile.
-     */
-    profile?: string;
     /**
      * The end-user’s locale, represented as a BCP47 language tag.
      */
@@ -151,22 +149,41 @@ export interface UserInfo {
      * The end-user’s time zone.
      */
     zoneinfo?: string;
-    /**
-     * The end-user's additional properties
-     */
-    properties?: Record<string, any>;
+}
+export interface UserInfo extends BaseUserInfo {
     /**
      * If the user is subscribed to the newsletter
      */
     subscribed?: boolean;
+}
+export interface AppMemberInfo extends BaseUserInfo {
     /**
-     * The properties of the currently logged in member of the app
+     * The role of the app member.
      */
-    appMember?: AppMember;
+    role: AppRole;
     /**
-     * Returns `true` if the user has no Oauth connections and no password.
+     * The end-user's additional properties
      */
-    hasNoLoginMethods?: boolean;
+    properties?: Record<string, any>;
+    /**
+     * Whether this app member is used for demonstration purposes
+     */
+    demo: boolean;
+}
+export interface SSOConfiguration {
+    type: 'oauth2' | 'saml';
+    url: string;
+    icon: IconName;
+    name: string;
+}
+export interface AppAccount {
+    app: App;
+    appMemberInfo: AppMemberInfo;
+    sso: SSOConfiguration[];
+}
+export interface EmailAuthorization {
+    email: string;
+    verified: boolean;
 }
 /**
  * The payload stored in our JSON web tokens
@@ -266,13 +283,17 @@ export interface Remappers {
      *
      * Supported properties:
      *
-     * - `memberId`: Get the id of the AppMember.
-     * - `userId`: Get the id of the user associated with AppMember object.
-     * - `role`: Get the role of the app member
-     * - `primaryEmail`: Get the primary email of the user associated with AppMember object.
-     * - `name`:  Get the name of the user associated with AppMember object.
+     * - `sub`: Get the id of the app member.
+     * - `name`: Get the name of the app member.
+     * - `email`: Get the email of the app member.
+     * - `email_verified`: Whether the email of the app member is verified.
+     * - `picture`: Get the picture of the app member.
+     * - `locale`: Get the locale of the app member.
+     * - `zoneinfo`: Get the zoneinfo of the app member.
+     * - `role`: Get the role of the app member.
+     * - `properties`: Get the custom properties of the app member.
      */
-    appMember: keyof AppMember;
+    'app.member': keyof AppMemberInfo;
     /**
      * Get a predefined app variable by name.
      */
@@ -354,6 +375,10 @@ export interface Remappers {
      * The value to set is the log level.
      */
     log: 'error' | 'info' | 'warn';
+    /**
+     * Get input object type.
+     */
+    type: null;
     /**
      * Builds an array based on the given data and remappers.
      *
@@ -413,6 +438,11 @@ export interface Remappers {
      * Returns nothing if array.map’s context isn’t set.
      */
     array: 'index' | 'item' | 'length';
+    /**
+     *
+     * Returns an array containing the items matching the specified conditions.
+     */
+    'array.filter': Remapper;
     /**
      * Returns an object based on the specified condition
      */
@@ -598,7 +628,6 @@ export interface Remappers {
      * This does not support parameters, for more nuanced translations use `string.format`.
      */
     translate: string;
-    user: keyof UserInfo;
     container: string;
 }
 export type ObjectRemapper = RequireExactlyOne<Remappers>;
@@ -615,22 +644,42 @@ export interface SubscriptionResponseResource {
     }>;
 }
 export type SubscriptionResponse = Record<string, SubscriptionResponseResource>;
+export type ResourceViewAction = 'get' | 'query';
+export type OwnResourceAction = ResourceViewAction | 'delete' | 'patch' | 'update';
+export type ResourceAction = ResourceViewAction | 'create' | 'delete' | 'patch' | 'update';
+export type CustomAppResourcePermission = `$resource:${string}:${ResourceAction}`;
+export type CustomAppOwnResourcePermission = `$resource:${string}:own:${OwnResourceAction}`;
+export type CustomAppResourceViewPermission = `$resource:${string}:${ResourceViewAction}:${string}`;
+export type CustomAppGuestPermission = AppPermission | CustomAppResourcePermission | CustomAppResourceViewPermission;
+export type CustomAppPermission = CustomAppGuestPermission | CustomAppOwnResourcePermission;
+export interface GuestDefinition {
+    permissions?: CustomAppPermission[];
+    inherits?: AppRole[];
+}
 export interface RoleDefinition {
     description?: string;
-    inherits?: string[];
     defaultPage?: string;
+    inherits?: AppRole[];
+    permissions?: CustomAppPermission[];
+}
+export type SecurityPolicy = 'everyone' | 'invite' | 'organization';
+export interface MinimalSecurity {
+    guest: GuestDefinition;
+    default?: {
+        role: AppRole;
+        policy?: SecurityPolicy;
+    };
+    roles?: Record<Exclude<string, PredefinedAppRole>, RoleDefinition>;
 }
-export interface Security {
+export interface StrictSecurity {
+    guest?: GuestDefinition;
     default: {
-        role: string;
-        policy?: 'everyone' | 'invite' | 'organization';
+        role: AppRole;
+        policy?: SecurityPolicy;
     };
     roles: Record<string, RoleDefinition>;
-    /**
-     * Define how teams are handled by the app.
-     */
-    teams?: TeamsDefinition;
 }
+export type Security = MinimalSecurity | StrictSecurity;
 export type Navigation = 'bottom' | 'hidden' | 'left-menu';
 export type LayoutPosition = 'hidden' | 'navbar' | 'navigation';
 export interface NotificationDefinition {
@@ -665,10 +714,6 @@ export interface ResourceCall {
      * Query parameters to pass along with the request.
      */
     query?: Remapper;
-    /**
-     * The roles that are allowed to perform this action.
-     */
-    roles?: string[];
 }
 export interface ResourceReferenceActionTrigger {
     type: 'create' | 'delete' | 'update';
@@ -693,16 +738,12 @@ export interface ResourceHistoryDefinition {
     data: boolean;
 }
 export interface ResourceView {
-    /**
-     * The roles required to use this view.
-     */
-    roles: string[];
     /**
      * The remappers used to transform the output.
      */
     remap: Remapper;
 }
-export interface UserPropertyDefinition {
+export interface AppMemberPropertyDefinition {
     /**
      * The JSON schema to validate user properties against before sending it to the backend.
      */
@@ -715,10 +756,6 @@ export interface UserPropertyDefinition {
     };
 }
 export interface ResourceDefinition {
-    /**
-     * The default list of roles used for permission checks for each action.
-     */
-    roles?: string[];
     /**
      * A definition of how versioning should happen for instances of this resource.
      */
@@ -1083,35 +1120,55 @@ export interface StorageWriteActionDefinition extends BaseActionDefinition<'stor
      */
     storage?: StorageType;
 }
-export interface TeamInviteActionDefinition extends BaseActionDefinition<'team.invite'> {
+export interface GroupMemberInviteActionDefinition extends BaseActionDefinition<'group.member.invite'> {
     /**
-     * The ID of the team to invite the user to.
+     * The ID of the group to invite the user to.
      */
-    id?: Remapper;
+    id: Remapper;
     /**
      * The email address of the user to invite.
      */
-    email?: Remapper;
+    email: Remapper;
+    /**
+     * The role of the invited group member.
+     */
+    role: Remapper;
+}
+export interface GroupMemberQueryActionDefinition extends BaseActionDefinition<'group.member.query'> {
+    /**
+     * The ID of the group to query the members of.
+     */
+    id: Remapper;
 }
-export interface TeamMembersActionDefinition extends BaseActionDefinition<'team.members'> {
+export interface GroupMemberDeleteActionDefinition extends BaseActionDefinition<'group.member.delete'> {
     /**
-     * The ID of the team to get the members from.
+     * The ID of the group member to delete.
      */
     id: Remapper;
 }
-export interface UserLoginAction extends BaseActionDefinition<'user.login'> {
+export interface GroupMemberRoleUpdateActionDefinition extends BaseActionDefinition<'group.member.role.update'> {
     /**
-     * The email address to login with.
+     * The ID of the group member to update the role of.
+     */
+    id: Remapper;
+    /**
+     * The role to invite the app member with.
+     */
+    role: Remapper;
+}
+export interface AppMemberLoginAction extends BaseActionDefinition<'app.member.login'> {
+    /**
+     * The email address to log in with.
      */
     email: Remapper;
     /**
-     * The password to login with.
+     * The password to log in with.
      */
     password: Remapper;
 }
-export interface UserRegisterAction extends BaseActionDefinition<'user.register'> {
+export interface AppMemberRegisterAction extends BaseActionDefinition<'app.member.register'> {
     /**
-     * The email address to login with.
+     * The email address to register with.
      */
     email: Remapper;
     /**
@@ -1119,15 +1176,9 @@ export interface UserRegisterAction extends BaseActionDefinition<'user.register'
      */
     password: Remapper;
     /**
-     * The display name of the user.
+     * The full name of the app member.
      */
-    displayName: Remapper;
-    /**
-     * Whether to login after registering.
-     *
-     * @default true
-     */
-    login?: boolean;
+    name: Remapper;
     /**
      * The profile picture to use.
      *
@@ -1140,54 +1191,56 @@ export interface UserRegisterAction extends BaseActionDefinition<'user.register'
      * Every value will be converted to a string.
      */
     properties?: Remapper;
-}
-export interface UserCreateAction extends BaseActionDefinition<'user.create'> {
     /**
-     * The display name of the user.
+     * Whether to login after registering.
+     *
+     * @default true
      */
-    name: Remapper;
+    login?: boolean;
+}
+export interface AppMemberInviteAction extends BaseActionDefinition<'app.member.invite'> {
     /**
-     * The email address to login with.
+     * The email address to invite the app member with.
      */
     email: Remapper;
     /**
-     * The password to login with.
-     */
-    password: Remapper;
-    /**
-     * Custom properties that can be assigned freely.
-     *
-     * Every value will be converted to a string.
+     * The role to invite the app member with.
      */
-    properties?: Remapper;
-    /**
-     * The role of the created user
-     */
-    role?: Remapper;
+    role: Remapper;
 }
-export interface UserQueryAction extends BaseActionDefinition<'user.query'> {
+export interface AppMemberQueryAction extends BaseActionDefinition<'app.member.query'> {
     /**
      * The roles of the users to fetch.
      */
     roles?: Remapper;
 }
-export interface UserUpdateAction extends BaseActionDefinition<'user.update'> {
+export interface AppMemberRoleUpdateAction extends BaseActionDefinition<'app.member.role.update'> {
     /**
-     * The display name to update.
+     * The id of the app member to update.
      */
-    name?: Remapper;
+    sub: Remapper;
     /**
-     * The email address of the user to update.
+     * The role of the updated app member
      */
-    currentEmail: Remapper;
+    role: Remapper;
+}
+export interface AppMemberPropertiesPatchAction extends BaseActionDefinition<'app.member.properties.patch'> {
     /**
-     * The new email address of the user.
+     * The id of the app member to update.
+     */
+    sub: Remapper;
+    /**
+     * Custom properties that can be assigned freely.
+     *
+     * Every value will be converted to a string.
      */
-    newEmail?: Remapper;
+    properties: Remapper;
+}
+export interface AppMemberCurrentPatchAction extends BaseActionDefinition<'app.member.current.patch'> {
     /**
-     * The password to update.
+     * The display name to update.
      */
-    password?: Remapper;
+    name?: Remapper;
     /**
      * Custom properties that can be assigned freely.
      *
@@ -1195,15 +1248,17 @@ export interface UserUpdateAction extends BaseActionDefinition<'user.update'> {
      */
     properties?: Remapper;
     /**
-     * The role of the created user
+     * The profile picture to use.
+     *
+     * This must be a file, otherwise it’s discarded.
      */
-    role?: Remapper;
+    picture?: Remapper;
 }
-export interface UserRemoveAction extends BaseActionDefinition<'user.remove'> {
+export interface AppMemberDeleteAction extends BaseActionDefinition<'app.member.delete'> {
     /**
-     * The email address of the account to delete.
+     * The id of the app member to remove.
      */
-    email: Remapper;
+    sub: Remapper;
 }
 export interface RequestLikeActionDefinition<T extends Action['type'] = Action['type']> extends BaseActionDefinition<T> {
     /**
@@ -1247,6 +1302,12 @@ interface ViewResourceDefinition {
      */
     view?: string;
 }
+interface OwnResourceDefinition {
+    /**
+     * If only the resources created by the authenticated app member should be included
+     */
+    own?: boolean;
+}
 export interface ControllerActionDefinition extends BaseActionDefinition<'controller'> {
     handler: string;
 }
@@ -1254,11 +1315,11 @@ 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 ResourceQueryActionDefinition = OwnResourceDefinition & ResourceActionDefinition<'resource.query'> & ViewResourceDefinition;
+export type ResourceCountActionDefinition = OwnResourceDefinition & ResourceActionDefinition<'resource.count'>;
 export type ResourceUpdateActionDefinition = ResourceActionDefinition<'resource.update'>;
 export type ResourcePatchActionDefinition = ResourceActionDefinition<'resource.patch'>;
-export type UserLogoutAction = BaseActionDefinition<'user.logout'>;
+export type AppMemberLogoutAction = BaseActionDefinition<'app.member.logout'>;
 export interface BaseResourceSubscribeActionDefinition<T extends Action['type']> extends BaseActionDefinition<T> {
     /**
      * The name of the resource.
@@ -1323,7 +1384,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 | UserQueryAction | UserRegisterAction | UserRemoveAction | UserUpdateAction;
+export type ActionDefinition = AnalyticsAction | AppMemberCurrentPatchAction | AppMemberDeleteAction | AppMemberInviteAction | AppMemberLoginAction | AppMemberLogoutAction | AppMemberPropertiesPatchAction | AppMemberQueryAction | AppMemberRegisterAction | AppMemberRoleUpdateAction | BaseActionDefinition<'dialog.error'> | BaseActionDefinition<'dialog.ok'> | BaseActionDefinition<'flow.back'> | BaseActionDefinition<'flow.cancel'> | BaseActionDefinition<'flow.finish'> | BaseActionDefinition<'flow.next'> | BaseActionDefinition<'group.query'> | BaseActionDefinition<'link.back'> | BaseActionDefinition<'link.next'> | BaseActionDefinition<'noop'> | BaseActionDefinition<'throw'> | ConditionActionDefinition | ControllerActionDefinition | DialogActionDefinition | DownloadActionDefinition | EachActionDefinition | EmailActionDefinition | EventActionDefinition | FlowToActionDefinition | GroupMemberDeleteActionDefinition | GroupMemberInviteActionDefinition | GroupMemberQueryActionDefinition | GroupMemberRoleUpdateActionDefinition | 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;
 export interface ActionType {
     /**
      * Whether or not app creators are required to define this action.
@@ -1340,6 +1401,7 @@ export interface EventType {
      */
     description?: string;
 }
+export type ViewRole = AppRole | '$guest';
 /**
  * This describes what a page will look like in the app.
  */
@@ -1375,7 +1437,7 @@ export interface BasePageDefinition {
     /**
      * A list of roles that may view the page.
      */
-    roles?: string[];
+    roles?: ViewRole[];
     /**
      * An optional icon from the fontawesome icon set
      *
@@ -1390,13 +1452,23 @@ export interface BasePageDefinition {
      * The global theme for the page.
      */
     theme?: Partial<Theme>;
+    /**
+     * A Remapper that resolves to a number to be visible in the side-menu.
+     */
+    badgeCount?: Remapper;
+    /**
+     * A mapping of actions that can be fired by the page to action handlers.
+     */
+    actions?: {
+        onLoad?: ActionDefinition;
+    };
 }
 /**
  * A subset of page for use within flow pages and tab pages.
  */
-export interface SubPage {
+export interface SubPageDefinition {
     name: Remapper;
-    roles?: string[];
+    roles?: ViewRole[];
     blocks: BlockDefinition[];
 }
 export interface BasicPageDefinition extends BasePageDefinition {
@@ -1407,9 +1479,9 @@ export interface ContainerPageDefinition extends BasePageDefinition {
     type: 'container';
     pages: PageDefinition[];
 }
-export interface FlowPageDefinition extends BasePageDefinition {
+export interface FlowPageDefinition extends Omit<BasePageDefinition, 'actions'> {
     type: 'flow';
-    steps: SubPage[];
+    steps: SubPageDefinition[];
     /**
      * A mapping of actions that can be fired by the page to action handlers.
      */
@@ -1437,7 +1509,7 @@ export interface LoopPageDefinition extends BasePageDefinition {
     /**
      * Template step that the loop will pass data onto
      */
-    foreach?: SubPage;
+    foreach?: SubPageDefinition;
     /**
      * A mapping of actions that can be fired by the page to action handlers.
      */
@@ -1462,7 +1534,7 @@ export interface LoopPageDefinition extends BasePageDefinition {
     retainFlowData?: boolean;
 }
 export interface AlternateTabsDefinition {
-    foreach: SubPage;
+    foreach: SubPageDefinition;
     events: {
         listen?: Record<string, string>;
         emit?: Record<string, string>;
@@ -1470,7 +1542,7 @@ export interface AlternateTabsDefinition {
 }
 export interface TabsPageDefinition extends BasePageDefinition {
     type: 'tabs';
-    tabs?: SubPage[];
+    tabs?: SubPageDefinition[];
     definition?: AlternateTabsDefinition;
     /**
      * A mapping of actions that can be fired by the page to action handlers.
@@ -1503,10 +1575,6 @@ export interface AppDefinition {
      * This determines user roles and login behavior.
      */
     security?: Security;
-    /**
-     * A list of roles that are required to view pages. Specific page roles override this property.
-     */
-    roles?: string[];
     /**
      * The default page of the app.
      */
@@ -1557,8 +1625,8 @@ export interface AppDefinition {
      */
     pages: PageDefinition[];
     controller?: ControllerDefinition;
-    users?: {
-        properties: Record<string, UserPropertyDefinition>;
+    members?: {
+        properties: Record<string, AppMemberPropertyDefinition>;
     };
     /**
      * Resource definitions that may be used by the app.
@@ -1602,6 +1670,9 @@ export interface App {
      * This value will be generated automatically by the API.
      */
     id?: number;
+    /**
+     * A domain name on which this app should be served.
+     */
     domain?: string;
     /**
      * The name used for emails
@@ -1820,19 +1891,81 @@ export interface OrganizationInvite {
     /**
      * The role the user should get when accepting the invite.
      */
+    role: PredefinedOrganizationRole;
+}
+/**
+ * An invite for an app.
+ */
+export interface AppInvite {
+    /**
+     * The email address of the app member to invite.
+     */
+    email: string;
+    /**
+     * The role the app member should get when accepting the invite.
+     */
     role: string;
 }
 /**
- * App member in an app.
+ * An invite for a group.
+ */
+export interface GroupInvite {
+    /**
+     * The name of the group.
+     */
+    groupId?: number;
+    /**
+     * The name of the group.
+     */
+    groupName?: string;
+    /**
+     * The email address of the group member to invite.
+     */
+    email: string;
+    /**
+     * The role the group member should get when accepting the invite.
+     */
+    role: AppRole;
+}
+/**
+ * Represents a group within an organization.
  */
-export interface AppMember {
-    userId: string;
-    memberId: string;
+export interface Group {
+    /**
+     * The ID of the group.
+     */
+    id: number;
+    /**
+     * The display name of the group.
+     */
     name: string;
-    primaryEmail: string;
+    /**
+     * Custom annotations for the group.
+     */
+    annotations?: Record<string, string>;
+}
+/**
+ * Group member in a group.
+ */
+export interface GroupMember {
+    id: string;
     role: string;
-    demo: boolean;
-    properties: Record<string, any>;
+    name: string;
+    email: string;
+}
+export interface AppMemberGroup {
+    /**
+     * The ID of the group.
+     */
+    id: number;
+    /**
+     * The display name of the group.
+     */
+    name: string;
+    /**
+     * The role of the app member inside the group.
+     */
+    role: AppRole;
 }
 /**
  * The layout used to store Appsemble messages.