@appsemble/utils 0.23.8 → 0.24.0

package/README.md

@@ -1,9 +1,9 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.23.8/config/assets/logo.svg) Appsemble Utilities
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.24.0/config/assets/logo.svg) Appsemble Utilities
 
 > Internal utility functions used across multiple Appsemble projects.
 
 [![npm](https://img.shields.io/npm/v/@appsemble/utils)](https://www.npmjs.com/package/@appsemble/utils)
-[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.23.8/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.23.8)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.24.0/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.24.0)
 [![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.8/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.24.0/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/api/components/parameters/index.d.ts

@@ -19,3 +19,5 @@ export * from './appServiceId.js';
 export * from './view.js';
 export * from './trainingId.js';
 export * from './trainingBlockId.js';
+export * from './memberEmail.js';
+export * from './roles.js';

package/api/components/parameters/index.js

@@ -19,4 +19,6 @@ export * from './appServiceId.js';
 export * from './view.js';
 export * from './trainingId.js';
 export * from './trainingBlockId.js';
+export * from './memberEmail.js';
+export * from './roles.js';
 //# sourceMappingURL=index.js.map

package/api/components/parameters/memberEmail.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const memberEmail: OpenAPIV3.ParameterObject;

package/api/components/parameters/memberEmail.js

@@ -0,0 +1,8 @@
+export const memberEmail = {
+    name: 'memberEmail',
+    in: 'path',
+    description: 'The email of the member on which to perform an operation',
+    required: true,
+    schema: { $ref: '#/components/schemas/OrganizationMember/properties/primaryEmail' },
+};
+//# sourceMappingURL=memberEmail.js.map

package/api/components/parameters/roles.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const roles: OpenAPIV3.ParameterObject;

package/api/components/parameters/roles.js

@@ -0,0 +1,13 @@
+export const roles = {
+    name: 'roles',
+    in: 'query',
+    description: 'The roles of users on which to perform an operation',
+    required: true,
+    schema: {
+        type: 'array',
+        items: {
+            $ref: '#/components/schemas/AppAccount/properties/role',
+        },
+    },
+};
+//# sourceMappingURL=roles.js.map

package/api/components/schemas/ActionDefinition.js

@@ -77,6 +77,8 @@ export const ActionDefinition = {
                 { $ref: '#/components/schemas/UserRegisterActionDefinition' },
                 { $ref: '#/components/schemas/UserCreateActionDefinition' },
                 { $ref: '#/components/schemas/UserUpdateActionDefinition' },
+                { $ref: '#/components/schemas/UserQueryActionDefinition' },
+                { $ref: '#/components/schemas/UserRemoveActionDefinition' },
             ],
         },
     ],

package/api/components/schemas/LinkActionDefinition.js

@@ -10,7 +10,6 @@ export const LinkActionDefinition = extendJSONSchema(BaseActionDefinition, {
             description: 'The link action can be used to redirect the user to other pages or absolute URLs.',
         },
         to: {
-            description: 'The name of the page to link to. Subpages can be referred to using arrays. If this matches with an absolute URL, link will open this instead of matching it with a page or subpage.',
             anyOf: [
                 {
                     type: 'string',
@@ -19,7 +18,11 @@ export const LinkActionDefinition = extendJSONSchema(BaseActionDefinition, {
                     type: 'array',
                     items: { type: 'string' },
                 },
+                {
+                    $ref: '#/components/schemas/RemapperDefinition',
+                },
             ],
+            description: 'The name of the page to link to. Subpages can be referred to using arrays. If this matches with an absolute URL, link will open this instead of matching it with a page or subpage.',
         },
     },
 });

package/api/components/schemas/OrganizationMember.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const OrganizationMember: OpenAPIV3.NonArraySchemaObject;

package/api/components/schemas/{Member.js → OrganizationMember.js}

@@ -1,5 +1,5 @@
 import { roles } from '../../../constants/index.js';
-export const Member = {
+export const OrganizationMember = {
     type: 'object',
     description: 'A member of an organization.',
     required: ['id'],
@@ -26,4 +26,4 @@ export const Member = {
         },
     },
 };
-//# sourceMappingURL=Member.js.map
+//# sourceMappingURL=OrganizationMember.js.map

package/api/components/schemas/Training.js

@@ -17,9 +17,12 @@ export const Training = {
             type: 'string',
             description: 'A brief overview of the training.',
         },
-        competence: {
-            type: 'string',
-            description: 'Tag for the training',
+        competences: {
+            type: 'array',
+            description: 'Competence tags for the training',
+            items: {
+                type: 'string',
+            },
         },
         difficultyLevel: {
             type: 'number',

package/api/components/schemas/UserCreateActionDefinition.js

@@ -11,14 +11,14 @@ export const UserCreateActionDefinition = extendJSONSchema(BaseActionDefinition,
 
 Does nothing if the user is already logged in.`,
         },
-        password: {
-            description: 'The password to login with.',
+        name: {
+            description: 'The display name of the user.',
         },
         email: {
             description: 'The email to login with.',
         },
-        displayName: {
-            description: 'The display name of the user.',
+        password: {
+            description: 'The password to login with.',
         },
         properties: {
             description: `The custom properties for the user.

package/api/components/schemas/UserQueryActionDefinition.d.ts

@@ -0,0 +1 @@
+export declare const UserQueryActionDefinition: import("openapi-types").OpenAPIV3.SchemaObject;

package/api/components/schemas/UserQueryActionDefinition.js

@@ -0,0 +1,20 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from './utils.js';
+export const UserQueryActionDefinition = extendJSONSchema(BaseActionDefinition, {
+    type: 'object',
+    additionalProperties: false,
+    required: [],
+    properties: {
+        type: {
+            enum: ['user.query'],
+            description: `Allows the user to fetch a list of accounts by their roles.
+
+Does nothing if the user isn’t logged in.`,
+        },
+        roles: {
+            $ref: '#/components/schemas/RemapperDefinition',
+            description: 'The roles of the accounts that would be fetched.',
+        },
+    },
+});
+//# sourceMappingURL=UserQueryActionDefinition.js.map

package/api/components/schemas/UserRemoveActionDefinition.d.ts

@@ -0,0 +1 @@
+export declare const UserRemoveActionDefinition: import("openapi-types").OpenAPIV3.SchemaObject;

package/api/components/schemas/UserRemoveActionDefinition.js

@@ -0,0 +1,20 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from './utils.js';
+export const UserRemoveActionDefinition = extendJSONSchema(BaseActionDefinition, {
+    type: 'object',
+    additionalProperties: false,
+    required: ['email'],
+    properties: {
+        type: {
+            enum: ['user.remove'],
+            description: `Allows the user to delete an existing account.
+
+Does nothing if the user isn’t logged in.`,
+        },
+        email: {
+            $ref: '#/components/schemas/RemapperDefinition',
+            description: 'The email of the account to be deleted.',
+        },
+    },
+});
+//# sourceMappingURL=UserRemoveActionDefinition.js.map

package/api/components/schemas/UserUpdateActionDefinition.js

@@ -11,23 +11,26 @@ export const UserUpdateActionDefinition = extendJSONSchema(BaseActionDefinition,
 
 Does nothing if the user isn’t logged in.`,
         },
-        password: {
-            description: 'The new password.',
+        name: {
+            description: 'The new display name of the user.',
         },
-        email: {
-            description: 'The new email address.',
+        currentEmail: {
+            description: 'The current email address of the user.',
         },
-        displayName: {
-            description: 'The new display name of the user.',
+        newEmail: {
+            description: 'The new email address.',
         },
-        picture: {
-            description: 'The new profile picture of the user.',
+        password: {
+            description: 'The new password.',
         },
         properties: {
             description: `The custom properties for the user.
 
 Every value will be converted to a string.`,
         },
+        role: {
+            description: "The role for the updated account. Defaults to the default role in the app's security definition.",
+        },
     },
 });
 //# sourceMappingURL=UserUpdateActionDefinition.js.map

package/api/components/schemas/index.d.ts

@@ -57,7 +57,7 @@ export * from './LinkActionDefinition.js';
 export * from './LinkBackActionDefinition.js';
 export * from './LinkNextActionDefinition.js';
 export * from './LogActionDefinition.js';
-export * from './Member.js';
+export * from './OrganizationMember.js';
 export * from './MatchActionDefinition.js';
 export * from './MessageActionDefinition.js';
 export * from './NoopActionDefinition.js';
@@ -123,5 +123,7 @@ export * from './UserLoginActionDefinition.js';
 export * from './UserRegisterActionDefinition.js';
 export * from './UserCreateActionDefinition.js';
 export * from './UserUpdateActionDefinition.js';
+export * from './UserQueryActionDefinition.js';
+export * from './UserRemoveActionDefinition.js';
 export * from './LoopPageDefinition.js';
 export * from './LoopPageActionsDefinition.js';

package/api/components/schemas/index.js

@@ -57,7 +57,7 @@ export * from './LinkActionDefinition.js';
 export * from './LinkBackActionDefinition.js';
 export * from './LinkNextActionDefinition.js';
 export * from './LogActionDefinition.js';
-export * from './Member.js';
+export * from './OrganizationMember.js';
 export * from './MatchActionDefinition.js';
 export * from './MessageActionDefinition.js';
 export * from './NoopActionDefinition.js';
@@ -123,6 +123,8 @@ export * from './UserLoginActionDefinition.js';
 export * from './UserRegisterActionDefinition.js';
 export * from './UserCreateActionDefinition.js';
 export * from './UserUpdateActionDefinition.js';
+export * from './UserQueryActionDefinition.js';
+export * from './UserRemoveActionDefinition.js';
 export * from './LoopPageDefinition.js';
 export * from './LoopPageActionsDefinition.js';
 //# sourceMappingURL=index.js.map

package/api/paths/apps.js

@@ -577,7 +577,7 @@ export const paths = {
                             schema: {
                                 type: 'array',
                                 items: {
-                                    $ref: '#/components/schemas/Member',
+                                    $ref: '#/components/schemas/OrganizationMember',
                                 },
                             },
                         },
@@ -608,7 +608,7 @@ export const paths = {
                     content: {
                         'application/json': {
                             schema: {
-                                $ref: '#/components/schemas/Member',
+                                $ref: '#/components/schemas/OrganizationMember',
                             },
                         },
                     },
@@ -647,7 +647,7 @@ export const paths = {
                     content: {
                         'application/json': {
                             schema: {
-                                $ref: '#/components/schemas/Member',
+                                $ref: '#/components/schemas/OrganizationMember',
                             },
                         },
                     },
@@ -1236,7 +1236,7 @@ This will return a 404 if the user has not uploaded one.`,
                             schema: {
                                 type: 'array',
                                 items: {
-                                    $ref: '#/components/schemas/Member',
+                                    $ref: '#/components/schemas/OrganizationMember',
                                 },
                             },
                         },
@@ -1270,7 +1270,7 @@ This will return a 404 if the user has not uploaded one.`,
                     content: {
                         'application/json': {
                             schema: {
-                                $ref: '#/components/schemas/Member',
+                                $ref: '#/components/schemas/OrganizationMember',
                             },
                         },
                     },
@@ -1307,7 +1307,7 @@ This will return a 404 if the user has not uploaded one.`,
                     content: {
                         'application/json': {
                             schema: {
-                                $ref: '#/components/schemas/Member',
+                                $ref: '#/components/schemas/OrganizationMember',
                             },
                         },
                     },
@@ -1342,7 +1342,7 @@ This will return a 404 if the user has not uploaded one.`,
                     content: {
                         'application/json': {
                             schema: {
-                                $ref: '#/components/schemas/Member',
+                                $ref: '#/components/schemas/OrganizationMember',
                             },
                         },
                     },
@@ -1408,7 +1408,7 @@ This will return a 404 if the user has not uploaded one.`,
                     content: {
                         'application/json': {
                             schema: {
-                                $ref: '#/components/schemas/Member',
+                                $ref: '#/components/schemas/OrganizationMember',
                             },
                         },
                     },
@@ -1438,7 +1438,7 @@ This will return a 404 if the user has not uploaded one.`,
                     content: {
                         'application/json': {
                             schema: {
-                                $ref: '#/components/schemas/Member',
+                                $ref: '#/components/schemas/OrganizationMember',
                             },
                         },
                     },
@@ -1468,7 +1468,7 @@ This will return a 404 if the user has not uploaded one.`,
                     content: {
                         'application/json': {
                             schema: {
-                                $ref: '#/components/schemas/Member',
+                                $ref: '#/components/schemas/OrganizationMember',
                             },
                         },
                     },

package/api/paths/organizations.js

@@ -164,7 +164,7 @@ export const paths = {
                             schema: {
                                 type: 'array',
                                 items: {
-                                    $ref: '#/components/schemas/Member',
+                                    $ref: '#/components/schemas/OrganizationMember',
                                 },
                             },
                         },
@@ -409,7 +409,7 @@ export const paths = {
                     content: {
                         'application/json': {
                             schema: {
-                                $ref: '#/components/schemas/Member',
+                                $ref: '#/components/schemas/OrganizationMember',
                             },
                         },
                     },

package/api/paths/trainings.js

@@ -17,7 +17,7 @@ export const paths = {
                     },
                 },
             },
-            security: [{ studio: [] }],
+            security: [{ studio: [] }, {}],
         },
         post: {
             tags: ['training', 'learning', 'docs'],
@@ -60,7 +60,7 @@ export const paths = {
                     },
                 },
             },
-            security: [{ studio: [] }],
+            security: [{ studio: [] }, {}],
         },
         patch: {
             tags: ['training', 'learning', 'docs'],
@@ -69,9 +69,35 @@ export const paths = {
             requestBody: {
                 required: true,
                 content: {
-                    'application/json': {
+                    'multipart/form-data': {
                         schema: {
-                            $ref: '#/components/schemas/Training',
+                            description: 'Schema to be used for editing trainings.',
+                            properties: {
+                                id: {
+                                    type: 'number',
+                                    readOnly: true,
+                                    minimum: 0,
+                                    description: 'The id of the training, will be generated automatically by the system.',
+                                },
+                                title: {
+                                    type: 'string',
+                                    description: 'Title of the training.',
+                                },
+                                description: {
+                                    type: 'string',
+                                    description: 'A brief overview of the training.',
+                                },
+                                competence: {
+                                    type: 'string',
+                                    description: 'Competence tags for the training',
+                                },
+                                difficultyLevel: {
+                                    type: 'number',
+                                    description: 'Difficulty level between 1 and 5',
+                                    minimum: 1,
+                                    maximum: 5,
+                                },
+                            },
                         },
                     },
                 },
@@ -119,7 +145,7 @@ export const paths = {
                     },
                 },
             },
-            security: [{ studio: [] }],
+            security: [{ studio: [] }, {}],
         },
         post: {
             tags: ['training', 'trainingBlocks', 'learning', 'docs'],

package/api/paths/user.js

@@ -123,7 +123,7 @@ export const paths = {
                                     properties: {
                                         id: { $ref: '#/components/schemas/Organization/properties/id' },
                                         name: { $ref: '#/components/schemas/Organization/properties/name' },
-                                        role: { $ref: '#/components/schemas/Member/properties/role' },
+                                        role: { $ref: '#/components/schemas/OrganizationMember/properties/role' },
                                     },
                                 },
                             },
@@ -354,6 +354,18 @@ export const paths = {
     },
     '/api/user/apps/{appId}/accounts': {
         parameters: [{ $ref: '#/components/parameters/appId' }],
+        get: {
+            tags: ['appMember'],
+            description: 'Fetch app accounts by roles.',
+            operationId: 'getAppMembersByRoles',
+            parameters: [{ $ref: '#/components/parameters/roles' }],
+            security: [{ app: [] }],
+            responses: {
+                200: {
+                    description: 'The accounts that were fetched.',
+                },
+            },
+        },
         post: {
             tags: ['appMember'],
             description: 'Create a new app account using an email address and a password.',
@@ -401,6 +413,75 @@ export const paths = {
             },
         },
     },
+    '/api/user/apps/{appId}/accounts/{memberEmail}': {
+        parameters: [
+            { $ref: '#/components/parameters/appId' },
+            { $ref: '#/components/parameters/memberEmail' },
+        ],
+        patch: {
+            tags: ['appMember'],
+            description: 'Patch an app account by email.',
+            operationId: 'updateAppMemberByEmail',
+            security: [{ app: [] }],
+            requestBody: {
+                description: 'The user account to update.',
+                required: true,
+                content: {
+                    'multipart/form-data': {
+                        schema: {
+                            type: 'object',
+                            required: ['password'],
+                            properties: {
+                                name: {
+                                    type: 'string',
+                                },
+                                email: {
+                                    type: 'string',
+                                    format: 'email',
+                                },
+                                password: {
+                                    type: 'string',
+                                    minLength: 8,
+                                },
+                                properties: {
+                                    type: 'object',
+                                    additionalProperties: { type: 'string' },
+                                    description: 'The member’s custom properties.',
+                                },
+                                role: {
+                                    type: 'string',
+                                    description: "The role for the updated account. Defaults to the default role in the app's security definition.",
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+            responses: {
+                200: {
+                    description: 'A linked app account',
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: '#/components/schemas/AppAccount',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        delete: {
+            tags: ['appMember'],
+            description: 'Delete a user account by email.',
+            operationId: 'deleteAppMemberByEmail',
+            security: [{ app: [] }],
+            responses: {
+                204: {
+                    description: 'The account was deleted successfully.',
+                },
+            },
+        },
+    },
     '/api/user/apps/{appId}/account/verify': {
         parameters: [{ $ref: '#/components/parameters/appId' }],
         post: {

package/constants/Permission.d.ts

@@ -94,5 +94,21 @@ export declare enum Permission {
     /**
      * The permission to edit collections.
      */
-    EditCollections = 22
+    EditCollections = 22,
+    /**
+     * The permission to create app accounts.
+     */
+    CreateAppAccounts = 23,
+    /**
+     * The permission to read app accounts.
+     */
+    ReadAppAccounts = 24,
+    /**
+     * The permission to delete app accounts.
+     */
+    DeleteAppAccounts = 25,
+    /**
+     * The permission to edit app accounts.
+     */
+    EditAppAccounts = 26
 }

package/constants/Permission.js

@@ -96,5 +96,21 @@ export var Permission;
      * The permission to edit collections.
      */
     Permission[Permission["EditCollections"] = 22] = "EditCollections";
+    /**
+     * The permission to create app accounts.
+     */
+    Permission[Permission["CreateAppAccounts"] = 23] = "CreateAppAccounts";
+    /**
+     * The permission to read app accounts.
+     */
+    Permission[Permission["ReadAppAccounts"] = 24] = "ReadAppAccounts";
+    /**
+     * The permission to delete app accounts.
+     */
+    Permission[Permission["DeleteAppAccounts"] = 25] = "DeleteAppAccounts";
+    /**
+     * The permission to edit app accounts.
+     */
+    Permission[Permission["EditAppAccounts"] = 26] = "EditAppAccounts";
 })(Permission || (Permission = {}));
 //# sourceMappingURL=Permission.js.map

package/constants/roles.d.ts

@@ -7,6 +7,7 @@ export declare const roles: {
     readonly AppEditor: Permission[];
     readonly Maintainer: Permission[];
     readonly Owner: Permission[];
+    readonly AccountManager: Permission[];
 };
 export type Role = keyof typeof roles;
 export declare enum TeamRole {

package/constants/roles.js

@@ -3,6 +3,12 @@ const member = [Permission.ViewApps, Permission.ViewMembers];
 const Translator = [...member, Permission.EditAppMessages];
 const APIReader = [...member, Permission.ReadAssets, Permission.ReadResources];
 const APIUser = [...APIReader, Permission.ManageAssets, Permission.ManageResources];
+const AccountManager = [
+    Permission.CreateAppAccounts,
+    Permission.ReadAppAccounts,
+    Permission.DeleteAppAccounts,
+    Permission.EditAppAccounts,
+];
 const AppEditor = [
     ...member,
     Permission.EditApps,
@@ -15,6 +21,7 @@ const AppEditor = [
 ];
 const Maintainer = [
     ...AppEditor,
+    ...AccountManager,
     Permission.CreateApps,
     Permission.DeleteApps,
     Permission.EditAppSettings,
@@ -41,6 +48,7 @@ export const roles = {
     AppEditor,
     Maintainer,
     Owner,
+    AccountManager,
 };
 export var TeamRole;
 (function (TeamRole) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/utils",
-  "version": "0.23.8",
+  "version": "0.24.0",
   "description": "Utility functions used in Appsemble internally",
   "keywords": [
     "app",
@@ -37,7 +37,7 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@appsemble/types": "0.23.8",
+    "@appsemble/types": "0.24.0",
     "axios": "^1.0.0",
     "cron-parser": "^4.0.0",
     "date-fns": "^2.0.0",

package/validation.d.ts

@@ -1,4 +1,4 @@
-import { type AppDefinition, type BlockManifest, type ProjectImplementations } from '@appsemble/types';
+import { type AppDefinition, type BlockManifest, type ProjectImplementations, type Remapper } from '@appsemble/types';
 import { type ValidatorResult } from 'jsonschema';
 import { type Promisable } from 'type-fest';
 import { type IdentifiableBlock } from './blockUtils.js';
@@ -8,7 +8,7 @@ import { type IdentifiableBlock } from './blockUtils.js';
  * @param link The link to check
  * @returns Whether or not the given link represents a link related to the Appsemble core.
  */
-export declare function isAppLink(link: string[] | string): boolean;
+export declare function isAppLink(link: Remapper | string[] | string): boolean;
 export type BlockVersionsGetter = (blockMap: IdentifiableBlock[]) => Promisable<BlockManifest[]>;
 /**
  * Validate an app definition.

package/validation.js

@@ -538,6 +538,11 @@ function validateActions(definition, report) {
             }
             if (action.type === 'link') {
                 const { to } = action;
+                if (typeof to === 'object' &&
+                    (!Array.isArray(to) ||
+                        (Array.isArray(to) && to.every((entry) => typeof entry === 'object')))) {
+                    return;
+                }
                 if (typeof to === 'string' && urlRegex.test(to)) {
                     return;
                 }

package/validation.test.js

@@ -1483,7 +1483,7 @@ describe('validateAppDefinition', () => {
             actions: {
                 onWhatever: {
                     type: 'user.update',
-                    email: 'example@example.com',
+                    currentEmail: 'example@example.com',
                     password: 'password',
                 },
             },

package/api/components/schemas/Member.d.ts

@@ -1,2 +0,0 @@
-import { type OpenAPIV3 } from 'openapi-types';
-export declare const Member: OpenAPIV3.NonArraySchemaObject;