@appsemble/utils 0.24.10 → 0.24.13

package/README.md

@@ -1,9 +1,9 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.24.10/config/assets/logo.svg) Appsemble Utilities
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.24.13/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.24.10/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.24.10)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.24.13/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.24.13)
 [![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.24.10/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.24.13/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/api/components/schemas/App.js

@@ -56,10 +56,12 @@ This doesn’t affect whether or not the app can be accessed on its own domain.
             description: 'Whether or not people who have access to the app may see the app definition.',
         },
         locked: {
-            type: 'boolean',
+            enum: ['fullLock', 'studioLock', 'unlocked'],
+            default: 'unlocked',
             description: `Determines whether this app should be locked from being updated.
-
-This must be set to \`false\` before any other changes can be made to an app.
+      If this is set to \`fullLock\`, no changes can be made to the app,
+      if this is set to \`studioLock\`, no changes can be made from the studio but updating from the CLI is possible,
+      and to make any changes from the studio, this should be set to \`unlocked\`.
 `,
         },
         template: {

package/api/components/schemas/TeamInviteActionDefinition.js

@@ -7,7 +7,7 @@ export const TeamInviteActionDefinition = extendJSONSchema(BaseActionDefinition,
     properties: {
         type: {
             enum: ['team.invite'],
-            description: 'Get a list of all of the user’s teams.',
+            description: 'Invite a user to join a team.',
         },
         id: {
             description: 'The ID of the team to invite the user to.',

package/api/components/schemas/TeamJoinActionDefinition.js

@@ -7,7 +7,7 @@ export const TeamJoinActionDefinition = extendJSONSchema(BaseActionDefinition, {
     properties: {
         type: {
             enum: ['team.join'],
-            description: 'Get a list of all of the user’s teams.',
+            description: 'Allow a user to join a team.',
         },
     },
 });

package/api/components/schemas/UserPropertyDefinition.js

@@ -33,6 +33,8 @@ export const UserPropertyDefinition = {
             properties: {
                 schema: {
                     anyOf: [
+                        { $ref: '#/components/schemas/JSONSchemaInteger' },
+                        { $ref: '#/components/schemas/JSONSchemaArray' },
                         { $ref: '#/components/schemas/JSONSchemaString' },
                         { $ref: '#/components/schemas/JSONSchemaNumber' },
                         { $ref: '#/components/schemas/JSONSchemaEnum' },

package/api/paths/apps.js

@@ -563,6 +563,29 @@ export const paths = {
             security: [{ app: ['openid'] }, {}],
         },
     },
+    '/api/apps/{appId}/demoMembers': {
+        parameters: [{ $ref: '#/components/parameters/appId' }],
+        get: {
+            tags: ['app'],
+            description: 'Fetch all demo members of an app.',
+            operationId: 'getDemoAppMembers',
+            responses: {
+                200: {
+                    description: 'The list of demo app members.',
+                    content: {
+                        'application/json': {
+                            schema: {
+                                type: 'array',
+                                items: {
+                                    $ref: '#/components/schemas/OrganizationMember',
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    },
     '/api/apps/{appId}/members': {
         parameters: [{ $ref: '#/components/parameters/appId' }],
         get: {

package/api/paths/user.js

@@ -430,7 +430,7 @@ export const paths = {
                     'multipart/form-data': {
                         schema: {
                             type: 'object',
-                            required: ['password'],
+                            required: [],
                             properties: {
                                 name: {
                                     type: 'string',

package/package.json

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

package/validation.js

@@ -76,6 +76,19 @@ function validateResourceSchemas(definition, report) {
         }
         const { schema } = resource;
         const prefix = ['resources', resourceName, 'schema'];
+        const reservedKeywords = new Set([
+            'created',
+            'updated',
+            'author',
+            'editor',
+            'seed',
+            'ephemeral',
+            'clonable',
+            'expires',
+        ]);
+        if (reservedKeywords.has(resourceName)) {
+            report(schema, 'is a reserved keyword', ['resources', resourceName]);
+        }
         validateJSONSchema(schema, prefix, report);
         if (!('type' in schema)) {
             report(schema, 'must define type object', prefix);

package/validation.test.js

@@ -866,6 +866,96 @@ describe('validateAppDefinition', () => {
             new ValidationError('does not exist in this app’s roles', 'Unknown', undefined, ['roles', 0]),
         ]);
     });
+    it('should validate resource types against reserved keywords', async () => {
+        const app = {
+            name: 'Test app',
+            defaultPage: 'Test Page',
+            pages: [
+                {
+                    name: 'Test Page',
+                    blocks: [],
+                },
+            ],
+            resources: {
+                created: {
+                    schema: {
+                        type: 'object',
+                        properties: {
+                            name: { type: 'string' },
+                        },
+                    },
+                },
+                updated: {
+                    schema: {
+                        type: 'object',
+                        properties: {
+                            name: { type: 'string' },
+                        },
+                    },
+                },
+                author: {
+                    schema: {
+                        type: 'object',
+                        properties: {
+                            name: { type: 'string' },
+                        },
+                    },
+                },
+                editor: {
+                    schema: {
+                        type: 'object',
+                        properties: {
+                            name: { type: 'string' },
+                        },
+                    },
+                },
+                seed: {
+                    schema: {
+                        type: 'object',
+                        properties: {
+                            name: { type: 'string' },
+                        },
+                    },
+                },
+                ephemeral: {
+                    schema: {
+                        type: 'object',
+                        properties: {
+                            name: { type: 'string' },
+                        },
+                    },
+                },
+                clonable: {
+                    schema: {
+                        type: 'object',
+                        properties: {
+                            name: { type: 'string' },
+                        },
+                    },
+                },
+                expires: {
+                    schema: {
+                        type: 'object',
+                        properties: {
+                            name: { type: 'string' },
+                        },
+                    },
+                },
+            },
+        };
+        const result = await validateAppDefinition(app, () => []);
+        expect(result.valid).toBe(false);
+        expect(result.errors).toStrictEqual([
+            new ValidationError('is a reserved keyword', { type: 'object', properties: { name: { type: 'string' } } }, undefined, ['resources', 'created']),
+            new ValidationError('is a reserved keyword', { type: 'object', properties: { name: { type: 'string' } } }, undefined, ['resources', 'updated']),
+            new ValidationError('is a reserved keyword', { type: 'object', properties: { name: { type: 'string' } } }, undefined, ['resources', 'author']),
+            new ValidationError('is a reserved keyword', { type: 'object', properties: { name: { type: 'string' } } }, undefined, ['resources', 'editor']),
+            new ValidationError('is a reserved keyword', { type: 'object', properties: { name: { type: 'string' } } }, undefined, ['resources', 'seed']),
+            new ValidationError('is a reserved keyword', { type: 'object', properties: { name: { type: 'string' } } }, undefined, ['resources', 'ephemeral']),
+            new ValidationError('is a reserved keyword', { type: 'object', properties: { name: { type: 'string' } } }, undefined, ['resources', 'clonable']),
+            new ValidationError('is a reserved keyword', { type: 'object', properties: { name: { type: 'string' } } }, undefined, ['resources', 'expires']),
+        ]);
+    });
     it('should validate the resource roles exist', async () => {
         const app = createTestApp();
         app.resources.person.roles = ['Unknown'];