@appsemble/utils 0.22.10 → 0.23.1

package/README.md

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

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

@@ -17,3 +17,5 @@ export * from './resourceType.js';
 export * from './screenshotId.js';
 export * from './appServiceId.js';
 export * from './view.js';
+export * from './trainingId.js';
+export * from './trainingBlockId.js';

package/api/components/parameters/index.js

@@ -17,4 +17,6 @@ export * from './resourceType.js';
 export * from './screenshotId.js';
 export * from './appServiceId.js';
 export * from './view.js';
+export * from './trainingId.js';
+export * from './trainingBlockId.js';
 //# sourceMappingURL=index.js.map

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

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

package/api/components/parameters/trainingBlockId.js

@@ -0,0 +1,8 @@
+export const trainingBlockId = {
+    name: 'trainingBlockId',
+    in: 'path',
+    description: 'Id of the trainingBlock on which the operation will be performed.',
+    required: true,
+    schema: { $ref: '#/components/schemas/TrainingBlock/properties/id' },
+};
+//# sourceMappingURL=trainingBlockId.js.map

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

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

package/api/components/parameters/trainingId.js

@@ -0,0 +1,8 @@
+export const trainingId = {
+    name: 'trainingId',
+    in: 'path',
+    description: 'Id of the training on which the operation will be performed.',
+    required: true,
+    schema: { $ref: '#/components/schemas/Training/properties/id' },
+};
+//# sourceMappingURL=trainingId.js.map

package/api/components/schemas/App.js

@@ -66,6 +66,10 @@ This must be set to \`false\` before any other changes can be made to an app.
             type: 'boolean',
             description: 'Determines whether this app should be included when fetching for templates.',
         },
+        demoMode: {
+            type: 'boolean',
+            description: 'Determines whether this app should be used in demo mode.',
+        },
         longDescription: {
             type: 'string',
             description: `

package/api/components/schemas/AppServiceSecret.js

@@ -9,7 +9,7 @@ export const AppServiceSecret = {
             description: 'An autogenerated ID.',
             readOnly: true,
         },
-        serviceName: {
+        name: {
             type: 'string',
             description: 'An optional name to give extra clarity what the secret is used for.',
         },

package/api/components/schemas/ResourceDefinition.js

@@ -13,15 +13,35 @@ const query = {
     description: 'The query parameters to use in the request.',
     additionalProperties: { type: 'string' },
 };
+const referenceActionTrigger = {
+    type: 'object',
+    additionalProperties: false,
+    description: 'Defines the type of trigger and the cascading strategy for it',
+    properties: {
+        type: {
+            enum: ['create', 'update', 'delete'],
+        },
+        cascade: {
+            description: `Defines the cascading strategy.
+
+If 'update' is specified, the referencing property of the referencing resource is set to null.
+
+If 'delete' is specified, the referencing resource is deleted.
+
+If not specified, the referenced resource cannot be deleted
+without deleting the referencing resource first.`,
+            enum: ['update', 'delete'],
+        },
+    },
+};
 const referenceAction = {
     type: 'object',
     additionalProperties: false,
-    // XXX
-    description: 'To be documented.',
+    description: 'Defines what happens when the specified action is executed on the referenced resource.',
     properties: {
-        trigger: {
+        triggers: {
             type: 'array',
-            items: { enum: ['create', 'update', 'delete'] },
+            items: referenceActionTrigger,
             minItems: 1,
             uniqueItems: true,
         },

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

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

package/api/components/schemas/Training.js

@@ -0,0 +1,32 @@
+export const Training = {
+    type: 'object',
+    description: 'Object representation of a training',
+    additionalProperties: false,
+    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: 'Tag for the training',
+        },
+        difficultyLevel: {
+            type: 'number',
+            description: 'Difficulty level between 1 and 5',
+            minimum: 1,
+            maximum: 5,
+        },
+    },
+};
+//# sourceMappingURL=Training.js.map

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

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

package/api/components/schemas/TrainingBlock.js

@@ -0,0 +1,38 @@
+export const TrainingBlock = {
+    type: 'object',
+    description: '',
+    additionalProperties: false,
+    properties: {
+        id: {
+            type: 'string',
+            description: 'The id of the Training Block, will be generated automatically by the system.',
+            readOnly: true,
+        },
+        trainingId: {
+            type: 'number',
+            minimum: 0,
+            description: 'Id of the parent training.',
+        },
+        title: {
+            type: 'string',
+            description: 'Title of the training block.',
+        },
+        documentationLink: {
+            type: 'string',
+            description: 'A URL pointing to a page in the documentation.',
+        },
+        videoLink: {
+            type: 'string',
+            description: 'Link of the video associated with the training block.',
+        },
+        exampleCode: {
+            type: 'string',
+            description: 'Example code for the user to be copied.',
+        },
+        externalResource: {
+            type: 'string',
+            description: 'Link to any external resource.',
+        },
+    },
+};
+//# sourceMappingURL=TrainingBlock.js.map

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

@@ -113,6 +113,8 @@ export * from './TeamsDefinition.js';
 export * from './Theme.js';
 export * from './ThrowActionDefinition.js';
 export * from './User.js';
+export * from './Training.js';
+export * from './TrainingBlock.js';
 export * from './UserEmail.js';
 export * from './UserLogoutActionDefinition.js';
 export * from './UserLoginActionDefinition.js';

package/api/components/schemas/index.js

@@ -113,6 +113,8 @@ export * from './TeamsDefinition.js';
 export * from './Theme.js';
 export * from './ThrowActionDefinition.js';
 export * from './User.js';
+export * from './Training.js';
+export * from './TrainingBlock.js';
 export * from './UserEmail.js';
 export * from './UserLogoutActionDefinition.js';
 export * from './UserLoginActionDefinition.js';

package/api/components/securitySchemes/cli.js

@@ -10,6 +10,7 @@ export const cli = {
             tokenUrl: '/oauth2/token',
             scopes: {
                 'apps:write': 'Create and update apps',
+                'apps:delete': 'Delete apps',
                 'blocks:write': 'Register and update blocks, and publish new block versions.',
                 'blocks:delete': 'Delete specific block versions.',
                 'organizations:write': 'Create and manage organizations.',

package/api/components/securitySchemes/cli.test.js

@@ -1,3 +1,4 @@
+import { expect, it } from 'vitest';
 import { cli } from './cli.js';
 import { scopes } from '../../../constants/index.js';
 it('should match the known scopes defined in utils', () => {

package/api/index.test.js

@@ -1,6 +1,7 @@
 import { readdirSync } from 'node:fs';
 import { readFile } from 'node:fs/promises';
 import { createValidator } from 'koas-core/lib/validation.js';
+import { describe, expect, it } from 'vitest';
 import { parse } from 'yaml';
 import { api, schemas } from './index.js';
 describe('schemas', () => {

package/api/paths/apps.js

@@ -32,6 +32,9 @@ export const paths = {
                                 template: {
                                     $ref: '#/components/schemas/App/properties/template',
                                 },
+                                demoMode: {
+                                    $ref: '#/components/schemas/App/properties/demoMode',
+                                },
                                 longDescription: {
                                     $ref: '#/components/schemas/App/properties/longDescription',
                                 },
@@ -170,6 +173,9 @@ export const paths = {
                                 template: {
                                     $ref: '#/components/schemas/App/properties/template',
                                 },
+                                demoMode: {
+                                    $ref: '#/components/schemas/App/properties/demoMode',
+                                },
                                 longDescription: {
                                     $ref: '#/components/schemas/App/properties/longDescription',
                                 },
@@ -272,6 +278,53 @@ export const paths = {
                     description: 'The app was successfully deleted.',
                 },
             },
+            security: [{ studio: [] }, { cli: ['apps:delete'] }],
+        },
+    },
+    '/api/apps/import/organization/{organizationId}': {
+        parameters: [{ $ref: '#/components/parameters/organizationId' }],
+        post: {
+            tags: ['app', 'import', 'zip'],
+            description: 'Import an app from a zip file',
+            operationId: 'importApp',
+            requestBody: {
+                content: {
+                    'application/zip': {
+                        schema: {
+                            type: 'string',
+                            format: 'binary',
+                        },
+                    },
+                },
+            },
+            responses: {
+                200: {
+                    description: 'App imported successfully',
+                    $ref: '#/components/responses/app',
+                },
+            },
+            security: [{ studio: [] }],
+        },
+    },
+    '/api/apps/{appId}/export': {
+        parameters: [{ $ref: '#/components/parameters/appId' }],
+        get: {
+            tags: ['app', 'export', 'zip'],
+            description: 'Export the app',
+            operationId: 'exportApp',
+            parameters: [
+                {
+                    name: 'resources',
+                    schema: { type: 'boolean' },
+                    description: 'Whether to include resources for an app.',
+                    in: 'query',
+                },
+            ],
+            responses: {
+                200: {
+                    description: 'App exported successfully.',
+                },
+            },
             security: [{ studio: [] }],
         },
     },
@@ -301,6 +354,9 @@ export const paths = {
             responses: {
                 204: {
                     description: 'Lock status successfully changed',
+                    content: {
+                        'application/zip': {},
+                    },
                 },
             },
             security: [{ studio: [] }, { cli: ['apps:write'] }],
@@ -1272,7 +1328,7 @@ This will return a 404 if the user has not uploaded one.`,
                     },
                 },
             },
-            security: [{ studio: [] }, { cli: ['teams:write'] }],
+            security: [{ studio: [] }, { app: [] }, { cli: ['teams:write'] }],
         },
         delete: {
             tags: ['app'],
@@ -1283,7 +1339,7 @@ This will return a 404 if the user has not uploaded one.`,
                     description: 'The team member has been removed successfully.',
                 },
             },
-            security: [{ studio: [] }, { cli: ['teams:write'] }],
+            security: [{ studio: [] }, { app: [] }, { cli: ['teams:write'] }],
         },
     },
     '/api/apps/{appId}/teams/{teamId}/invite': {

package/api/paths/index.js

@@ -23,6 +23,7 @@ import { paths as resourceHistory } from './resourceHistory.js';
 import { paths as resources } from './resources.js';
 import { paths as saml } from './saml.js';
 import { paths as templates } from './templates.js';
+import { paths as trainings } from './trainings.js';
 import { paths as user } from './user.js';
 export const paths = {
     ...appOAuth2Secrets,
@@ -51,5 +52,6 @@ export const paths = {
     ...translations,
     ...appServiceSecrets,
     ...user,
+    ...trainings,
 };
 //# sourceMappingURL=index.js.map

package/api/paths/trainings.d.ts

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

package/api/paths/trainings.js

@@ -0,0 +1,279 @@
+export const paths = {
+    '/api/trainings': {
+        get: {
+            tags: ['training', 'learning', 'docs'],
+            description: 'Fetch all trainings available',
+            operationId: 'getTrainings',
+            responses: {
+                200: {
+                    description: 'An array of all the available trainings.',
+                    content: {
+                        'application/json': {
+                            schema: {
+                                type: 'array',
+                                items: { $ref: '#/components/schemas/Training' },
+                            },
+                        },
+                    },
+                },
+            },
+            security: [{ studio: [] }],
+        },
+        post: {
+            tags: ['training', 'learning', 'docs'],
+            description: '',
+            operationId: 'createTraining',
+            requestBody: {
+                required: true,
+                content: {
+                    'application/json': {
+                        schema: {
+                            $ref: '#/components/schemas/Training',
+                        },
+                    },
+                },
+            },
+            responses: {
+                201: {
+                    description: 'Created new training successfully',
+                    $ref: '#/components/schemas/Training',
+                },
+            },
+            security: [{ studio: [] }],
+        },
+    },
+    '/api/trainings/{trainingId}': {
+        parameters: [{ $ref: '#/components/parameters/trainingId' }],
+        get: {
+            tags: ['training', 'learning', 'docs'],
+            description: 'Fetch a single training by id.',
+            operationId: 'getTrainingById',
+            responses: {
+                200: {
+                    description: 'Object representation of a training',
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: '#/components/schemas/Training',
+                            },
+                        },
+                    },
+                },
+            },
+            security: [{ studio: [] }],
+        },
+        patch: {
+            tags: ['training', 'learning', 'docs'],
+            description: 'Fetch a single training by id.',
+            operationId: 'patchTraining',
+            requestBody: {
+                required: true,
+                content: {
+                    'application/json': {
+                        schema: {
+                            $ref: '#/components/schemas/Training',
+                        },
+                    },
+                },
+            },
+            responses: {
+                200: {
+                    description: 'Object representation of a training',
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: '#/components/schemas/Training',
+                            },
+                        },
+                    },
+                },
+            },
+            security: [{ studio: [] }],
+        },
+        delete: {
+            tags: ['delete', 'training'],
+            description: 'Delete a training by Id.',
+            operationId: 'deleteTraining',
+            responses: {
+                204: { description: 'Deleted the specified training.' },
+            },
+            security: [{ studio: [] }],
+        },
+    },
+    '/api/trainings/{trainingId}/blocks': {
+        parameters: [{ $ref: '#/components/parameters/trainingId' }],
+        get: {
+            tags: ['training', 'trainingBlocks', 'learning', 'docs'],
+            description: 'Fetch all training blocks by training id',
+            operationId: 'getTrainingBlocksByTrainingId',
+            responses: {
+                200: {
+                    description: 'An array of all the training Blocks associated with a training.',
+                    content: {
+                        'application/json': {
+                            schema: {
+                                type: 'array',
+                                items: { $ref: '#/components/schemas/TrainingBlock' },
+                            },
+                        },
+                    },
+                },
+            },
+            security: [{ studio: [] }],
+        },
+        post: {
+            tags: ['training', 'trainingBlocks', 'learning', 'docs'],
+            description: 'Create a new training block as a child of a training.',
+            operationId: 'createTrainingBlock',
+            requestBody: {
+                required: true,
+                content: {
+                    'multipart/form-data': {
+                        schema: {
+                            type: 'object',
+                            properties: {
+                                documentationLink: {
+                                    $ref: '#/components/schemas/TrainingBlock/properties/documentationLink',
+                                },
+                                videoLink: { $ref: '#/components/schemas/TrainingBlock/properties/videoLink' },
+                                exampleCode: { $ref: '#/components/schemas/TrainingBlock/properties/exampleCode' },
+                                title: { $ref: '#/components/schemas/TrainingBlock/properties/title' },
+                                externalResource: {
+                                    $ref: '#/components/schemas/TrainingBlock/properties/externalResource',
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+            responses: { 201: { description: 'Created new training block successfully' } },
+            security: [{ studio: [] }],
+        },
+    },
+    '/api/trainings/{trainingId}/enroll/users': {
+        parameters: [{ $ref: '#/components/parameters/trainingId' }],
+        get: {
+            tags: ['training', 'users', 'enrolled'],
+            description: 'Get a list of all users who have completed a training.',
+            operationId: 'getTrainedUsers',
+            responses: {
+                200: {
+                    description: 'A list of all the users who have completed a training.',
+                    content: {
+                        'application/json': {
+                            schema: {
+                                type: 'array',
+                                items: {
+                                    $ref: '#/components/schemas/User',
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+            security: [{ studio: [] }],
+        },
+    },
+    '/api/trainings/{trainingId}/enroll': {
+        parameters: [{ $ref: '#/components/parameters/trainingId' }],
+        get: {
+            tags: ['training', 'learning', 'user'],
+            description: 'Check if a user is enrolled in a training.',
+            operationId: 'isUserEnrolled',
+            responses: {
+                200: {
+                    description: 'A boolean returning whether a user is enrolled in a training',
+                    content: {
+                        'application/json': {
+                            schema: {
+                                type: 'object',
+                                properties: {
+                                    enrolled: {
+                                        type: 'boolean',
+                                        description: 'If a user is enrolled in a training',
+                                    },
+                                    completed: {
+                                        type: 'boolean',
+                                        description: 'If the training has been completed by the user.',
+                                    },
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+            security: [{ studio: [] }],
+        },
+        post: {
+            tags: ['training', 'learning', 'user'],
+            description: 'Enroll a user in a training.',
+            operationId: 'enrollUserInTraining',
+            responses: { 201: { description: 'Enrolled in the training successfully' } },
+            security: [{ studio: [] }],
+        },
+        patch: {
+            tags: ['training', 'learning', 'user'],
+            description: 'Edit an enrollment of a user in a training',
+            operationId: 'updateTrainingCompletionStatus',
+            requestBody: {
+                required: true,
+                content: {
+                    'multipart/form-data': {
+                        schema: {
+                            type: 'object',
+                            properties: {
+                                completed: {
+                                    type: 'boolean',
+                                    description: 'If the training has been completed by the user.',
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+            responses: { 200: { description: 'Updated user training successfully.' } },
+            security: [{ studio: [] }],
+        },
+    },
+    '/api/training/blocks/{trainingBlockId}': {
+        parameters: [{ $ref: '#/components/parameters/trainingBlockId' }],
+        patch: {
+            tags: ['training', 'trainingBlocks', 'learning', 'docs'],
+            description: 'Update a training block with new content',
+            operationId: 'patchTrainingBlock',
+            requestBody: {
+                required: true,
+                content: {
+                    'multipart/form-data': {
+                        schema: {
+                            type: 'object',
+                            properties: {
+                                documentationLink: {
+                                    $ref: '#/components/schemas/TrainingBlock/properties/documentationLink',
+                                },
+                                videoLink: { $ref: '#/components/schemas/TrainingBlock/properties/videoLink' },
+                                exampleCode: { $ref: '#/components/schemas/TrainingBlock/properties/exampleCode' },
+                                title: { $ref: '#/components/schemas/TrainingBlock/properties/title' },
+                                externalResource: {
+                                    $ref: '#/components/schemas/TrainingBlock/properties/externalResource',
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+            responses: { 200: { $ref: '#/components/schemas/TrainingBlock' } },
+            security: [{ studio: [] }],
+        },
+        delete: {
+            tags: ['delete', 'training'],
+            description: 'Delete a training block by Id.',
+            operationId: 'deleteTrainingBlock',
+            responses: {
+                204: { description: 'Deleted the specified training block.' },
+            },
+            security: [{ studio: [] }],
+        },
+    },
+};
+//# sourceMappingURL=trainings.js.map

package/appMessages.test.js

@@ -1,3 +1,4 @@
+import { describe, expect, it, vi } from 'vitest';
 import { extractAppMessages, findMessageIds } from './appMessages.js';
 describe('findMessageIds', () => {
     it('should ignore null', () => {

package/appSecurity.test.js

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest';
 import { resolveRoleInheritance } from './appSecurity.js';
 describe('resolveRoleInheritance', () => {
     it('should return an empty array if no security definition is defined', () => {

package/blockUtils.test.js

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest';
 import { getAppBlocks, normalizeBlockName, parseBlockName, prefixBlockURL, stripBlockName, } from './blockUtils.js';
 describe('normalizeBlockName', () => {
     it('should prepend @appsemble if no organization is prepended', () => {

package/constants/patterns.test.js

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest';
 import { domainPattern, googleAnalyticsIDPattern, normalized, partialNormalized, } from './patterns.js';
 describe('partialNormalized', () => {
     it.each([

package/constants/roles.js

@@ -22,6 +22,9 @@ const Maintainer = [
     Permission.ManageTeams,
     Permission.PublishBlocks,
     Permission.DeleteBlocks,
+    Permission.CreateCollections,
+    Permission.DeleteCollections,
+    Permission.EditCollections,
 ];
 const Owner = [
     ...Maintainer,
@@ -29,9 +32,6 @@ const Owner = [
     Permission.DeleteOrganization,
     Permission.ManageMembers,
     Permission.ManageRoles,
-    Permission.CreateCollections,
-    Permission.DeleteCollections,
-    Permission.EditCollections,
 ];
 export const roles = {
     Member: member,

package/constants/scopes.d.ts

@@ -1,4 +1,4 @@
 /**
  * All known OAuth2 scopes for client credentials.
  */
-export declare const scopes: readonly ["apps:write", "blocks:write", "blocks:delete", "organizations:write", "resources:read", "resources:write", "assets:write", "teams:read", "teams:write"];
+export declare const scopes: readonly ["apps:write", "apps:delete", "blocks:write", "blocks:delete", "organizations:write", "resources:read", "resources:write", "assets:write", "teams:read", "teams:write"];

package/constants/scopes.js

@@ -3,6 +3,7 @@
  */
 export const scopes = [
     'apps:write',
+    'apps:delete',
     'blocks:write',
     'blocks:delete',
     'organizations:write',

package/convertToCsv.test.js

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest';
 import { convertToCsv } from './convertToCsv.js';
 describe('convertToCsv', () => {
     it('should throw an error if input is null', () => {

package/has.test.js

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest';
 import { has } from './has.js';
 describe('has', () => {
     it('should return false for null targets', () => {

package/i18n.test.js

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest';
 import { detectLocale, sortLocales } from './i18n.js';
 describe('sortLocales', () => {
     const tests = [

package/iterApp.test.js

@@ -1,3 +1,4 @@
+import { describe, expect, it, vi } from 'vitest';
 import { iterAction, iterApp, iterBlock, iterBlockList, iterPage } from './iterApp.js';
 describe('iterAction', () => {
     it('should call the appropriate callbacks', () => {

package/jsonschema.test.js

@@ -1,3 +1,4 @@
+import { describe, expect, it, vi } from 'vitest';
 import { combineSchemas, generateDataFromSchema, iterJSONSchema } from './jsonschema.js';
 describe('generateDataFromSchema', () => {
     it('should not crash if no schema is defined', () => {

package/mapValues.test.js

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest';
 import { mapValues } from './mapValues.js';
 describe('mapValues', () => {
     it('should call the iteratee over each own property', () => {

package/miscellaneous.test.js

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest';
 import { identity, rethrow, stripNullValues } from './miscellaneous.js';
 /**
  * Return the input data.

package/normalize.test.js

@@ -1,3 +1,4 @@
+import { expect, it } from 'vitest';
 import { normalize } from './normalize.js';
 const fixtures = [
     ['Foo', 'foo'],

package/objectCache.test.js

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest';
 import { objectCache } from './objectCache.js';
 describe('objectCache', () => {
     it('should cache results', () => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/utils",
-  "version": "0.22.10",
+  "version": "0.23.1",
   "description": "Utility functions used in Appsemble internally",
   "keywords": [
     "app",
@@ -37,7 +37,7 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@appsemble/types": "0.22.10",
+    "@appsemble/types": "0.23.1",
     "axios": "^1.0.0",
     "cron-parser": "^4.0.0",
     "date-fns": "^2.0.0",
@@ -59,6 +59,7 @@
     "@types/lcm": "^0.0.0",
     "bulma": "0.9.3",
     "koas-core": "^0.7.0",
+    "vitest": "^0.34.0",
     "yaml": "^2.0.0"
   },
   "engines": {

package/prefix.test.js

@@ -1,3 +1,4 @@
+import { expect, it } from 'vitest';
 import { prefix } from './prefix.js';
 it('should prefix a string if the prefix is truthy', () => {
     const result = prefix('bar', 'foo');

package/reference-schemas/remappers/arrays.js

@@ -257,6 +257,35 @@ Result:
   }
 ]
 \`\`\`
+
+Extra example:
+
+array remapper can also be used in combination with different remappers as in the current example comes object remapper:
+
+Example object:
+\`\`\`json
+{
+  "names": ["Bart", "Bas", "Sam"]
+}
+\`\`\`
+
+Combination of object and array remapper:
+
+\`\`\`yaml
+object.assign:
+  names:
+  - { prop: Applicants }
+  - array.append:
+    - Kevin
+\`\`\`
+
+Result:
+\`\`\`json
+{
+  "names": ["Bart", "Bas", "Sam", "Kevin"]
+}
+\`\`\`
+\
     `,
     },
     'array.omit': {

package/remap.test.js

@@ -1,4 +1,5 @@
 import { IntlMessageFormat } from 'intl-messageformat';
+import { beforeEach, describe, expect, it, vi } from 'vitest';
 import { remap } from './remap.js';
 function runTests(tests) {
     it.each(Object.entries(tests))('should %s', (name, { context, expected, history, input, mappers, messages, userInfo }) => {

package/string.test.js

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest';
 import { camelToHyphen, decodeJSONRef, toUpperCase } from './string.js';
 describe('camelToHyphen', () => {
     it('should convert camel case to hyphenated', () => {

package/theme.test.js

@@ -1,4 +1,5 @@
 import bulmaPkg from 'bulma/package.json';
+import { describe, expect, it } from 'vitest';
 import { createThemeURL, mergeThemes } from './theme.js';
 describe('mergeThemes', () => {
     it('should use the base theme as default', () => {

package/validateStyle.test.js

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest';
 import { StyleValidationError, validateStyle } from './validateStyle.js';
 describe('validateStyle', () => {
     it('should validate correct CSS', () => {

package/validation.test.js

@@ -1,4 +1,5 @@
 import { ValidationError } from 'jsonschema';
+import { describe, expect, it } from 'vitest';
 import { validateAppDefinition } from './validation.js';
 function createTestApp() {
     return {